Update README with detailed usage and setup instructions
paydii committed
Apr 24, 2026 at 14:21 UTC
5620d51901a24991a9be14f5a55a81f5fed7c90d
1 file changed
+28
-11
README.md
+28
-11
@@ -1,6 +1,15 @@
1
# siGit Code — Homebrew Tap
2
3
-[siGit Code](https://github.com/getsigit/sigit) is an AI coding agent that runs a local LLM on your machine.
3
+[siGit Code](https://github.com/getsigit/sigit) is a coding agent for [smbCloud](https://smbcloud.xyz/) that runs entirely on your machine. No API keys. No cloud round-trips. The model lives in your local HuggingFace cache.
4
+
5
+siGit has two modes:
6
+
7
+- ACP mode, where Zed or another ACP-compatible editor starts it over stdio
8
+- an interactive terminal chat when you run `sigit` yourself
9
+
10
+Current platform support through this tap:
11
+
12
+- macOS: ACP mode and interactive terminal mode
13
14
## Install
15
@@ -8,27 +17,35 @@
17
brew install getsigit/sigit/sigit
18
```
19
11
-Pre-built binaries are downloaded — no Rust toolchain needed.
20
+Homebrew downloads a pre-built macOS binary, so you do not need a Rust toolchain.
21
13
-## Usage
22
+## First run
23
15
-```bash
16
-sigit # opens the interactive chat TUI
17
-```
24
+The first time siGit starts, it downloads a GGUF model (~1–2 GB) from HuggingFace. After that, startup is much faster because the model is already on disk.
25
19
-For Zed, add to `~/.config/zed/settings.json`:
26
+On macOS, siGit shares its model cache with the siGit desktop app through an App Group container. If the desktop app already downloaded the model, the CLI will reuse it.
27
+
28
+## Zed setup
29
+
30
+Add to `~/.config/zed/settings.json`:
31
32
```json
33
{
34
"agent_servers": {
35
"siGit Code": {
36
"type": "custom",
26
- "command": "sigit"
37
+ "command": "/opt/homebrew/bin/sigit"
38
}
39
}
40
}
41
```
42
43
+Use the full absolute path. If you are on Intel macOS, that path may be `/usr/local/bin/sigit` instead.
44
+
45
+## Terminal mode
46
+
47
+If you run `sigit` directly in a terminal, it opens an interactive chat UI. It uses the same model and system prompt as the editor integration, so it is useful for quick questions when you do not want to open Zed first.
48
+
49
## Upgrade
50
51
```bash
@@ -46,14 +63,14 @@ brew untap getsigit/sigit
63
64
| Method | Command |
65
|--------|---------|
49
-| pip | `pip install sigit` |
66
| npm | `npm install -g @smbcloud/sigit` |
67
| Cargo | `cargo install sigit` |
68
69
## Requirements
70
55
-- macOS 14 or later (Apple Silicon or Intel)
56
-- ~2 GB free disk for the default model (downloaded on first run)
71
+- macOS 14 or later
72
+- Apple Silicon or Intel
73
+- ~2 GB free disk for the default model download
74
75
## License
76