feature/crates-release
md 91 lines 2.48 KB
Rendered Raw
1 <h1 align="center">siGit Code</h1>
2
3 <p align="center">
4 AI coding agent powered by local LLM via <a href="https://ondeinference.com">Onde Inference</a>.<br>
5 Runs on your machine. No API keys, no cloud.
6 </p>
7
8 <p align="center">
9 <a href="https://pypi.org/project/sigit-code/"><img src="https://img.shields.io/pypi/v/sigit-code?style=flat-square&labelColor=17211D&color=235843" alt="PyPI"></a>
10 <a href="https://crates.io/crates/sigit"><img src="https://img.shields.io/crates/v/sigit?style=flat-square&labelColor=17211D&color=235843" alt="Crates.io"></a>
11 <a href="https://www.npmjs.com/package/@smbcloud/sigit"><img src="https://img.shields.io/npm/v/@smbcloud/sigit?style=flat-square&labelColor=17211D&color=235843" alt="npm"></a>
12 <a href="https://smbcloud.xyz"><img src="https://img.shields.io/badge/smbcloud.xyz-235843?style=flat-square&labelColor=17211D" alt="Website"></a>
13 <a href="https://github.com/getsigit/sigit/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache--2.0-235843?style=flat-square&labelColor=17211D" alt="License"></a>
14 </p>
15
16 <br>
17
18 ---
19
20 ## Install
21
22 ```sh
23 pip install sigit-code
24 uvx --from sigit-code sigit
25 ```
26
27 Installs a native `sigit` binary for your platform. No compiler, no runtime dependencies.
28
29 ## Quick start
30
31 ### Terminal
32
33 ```sh
34 sigit
35 ```
36
37 Opens a chat UI where you talk to a local LLM coding agent directly.
38
39 ### Zed (ACP agent)
40
41 siGit works as an [ACP-compatible](https://github.com/nicobailon/agent-client-protocol) agent in [Zed](https://zed.dev). Add this to your Zed settings:
42
43 ```json
44 {
45 "agent_servers": {
46 "siGit Code": {
47 "type": "custom",
48 "command": "/absolute/path/to/sigit"
49 }
50 }
51 }
52 ```
53
54 Then pick **sigit** as your agent in the Zed assistant panel.
55
56 ## Other install methods
57
58 | Method | Command |
59 |--------|---------|
60 | npm | `npm install -g @smbcloud/sigit` |
61 | Homebrew | `brew tap getsigit/tap && brew install sigit` |
62 | Cargo | `cargo install sigit` |
63
64 ### From source
65
66 ```sh
67 git clone https://github.com/getsigit/sigit
68 cd sigit
69 cargo build --release
70 ./target/release/sigit
71 ```
72
73 ## Platform support
74
75 | Platform | Architecture |
76 |----------|--------------|
77 | macOS | arm64, x64 |
78 | Linux (glibc) | arm64, x64 |
79 | Windows | arm64, x64 |
80
81 ## Source and issues
82
83 This package ships a pre-built binary. Source code is at [github.com/getsigit/sigit](https://github.com/getsigit/sigit). File bugs there.
84
85 ## License
86
87 [Apache 2.0](https://github.com/getsigit/sigit/blob/main/LICENSE)
88
89 ## Copyright
90
91 © 2026 [smbCloud](https://smbcloud.xyz/) (Splitfire AB).