Update description and README for clarity and accuracy
Seto Elkahfi committed
Apr 30, 2026 at 14:05 UTC
889eeff13de16e90eff4104935cf59dd66fc42bd
2 files changed
+18
-20
Formula/sigit.rb
+1
-1
@@ -2,7 +2,7 @@
2
3
# Homebrew formula for siGit Code (`sigit` binary).
4
class Sigit < Formula
5
- desc 'AI coding agent powered by local LLM via Onde Inference'
5
+ desc 'Local coding agent powered by Onde Inference'
6
homepage 'https://github.com/getsigit/sigit'
7
version '1.0.2'
8
license 'Apache-2.0'
README.md
+17
-19
@@ -1,34 +1,32 @@
1
-# siGit Code — Homebrew Tap
1
+# siGit Code Homebrew tap
2
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.
3
+[siGit Code](https://github.com/getsigit/sigit) is a local coding agent from [smbCloud](https://smbcloud.xyz/). It runs on your machine. No API keys, no cloud round-trips.
4
5
-siGit has two modes:
5
+siGit Code 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
7
+- **ACP mode:** Zed or another ACP-compatible editor starts it over stdio
8
+- **Terminal mode:** run `sigit` yourself for the interactive chat UI
9
10
-Current platform support through this tap:
11
-
12
-- macOS: ACP mode and interactive terminal mode
10
+This tap currently ships the macOS build.
11
12
## Install
13
16
-```bash
14
+```sh
15
brew tap getsigit/tap
16
brew install sigit
17
```
18
21
-Homebrew downloads a pre-built macOS binary, so you do not need a Rust toolchain.
19
+Homebrew downloads a prebuilt macOS binary, so you do not need a Rust toolchain.
20
21
## First run
22
25
-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.
23
+The first time you start siGit Code, it downloads a GGUF model from Hugging Face. Expect roughly 1 to 2 GB. After that, startup is much faster because the model is already on disk.
24
27
-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.
25
+On macOS, siGit Code shares its model cache with the desktop app through an App Group container. If the desktop app already downloaded the model, the CLI reuses it.
26
27
## Zed setup
28
31
-Add to `~/.config/zed/settings.json`:
29
+Add this to `~/.config/zed/settings.json`:
30
31
```json
32
{
@@ -41,23 +39,23 @@ Add to `~/.config/zed/settings.json`:
39
}
40
```
41
44
-Use the full absolute path. If you are on Intel macOS, that path may be `/usr/local/bin/sigit` instead.
42
+Use the full absolute path. On Intel Macs, that path may be `/usr/local/bin/sigit` instead.
43
44
## Terminal mode
45
48
-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.
46
+Run `sigit` in a terminal and it opens the interactive chat UI. It uses the same model and system prompt as the editor integration, so it is handy when you want a quick answer without opening Zed first.
47
48
## Upgrade
49
52
-```bash
50
+```sh
51
brew upgrade sigit
52
```
53
54
## Uninstall
55
58
-```bash
56
+```sh
57
brew uninstall sigit
60
-brew untap getsigit/sigit
58
+brew untap getsigit/tap
59
```
60
61
## Other install methods
@@ -72,7 +70,7 @@ brew untap getsigit/sigit
70
71
- macOS 14 or later
72
- Apple Silicon or Intel
75
-- ~2 GB free disk for the default model download
73
+- around 2 GB of free disk space for the default model download
74
75
## License
76