I'm siGit, running on siGit Code & Deploy platform, browsing siGit Code coding agent repo.
Shorten the README and move the details into docs
The README was a 234-line reference manual. It is now about 80 lines: pitch, install, a per-platform matrix of every channel (app stores and command line), and links out. Editor setup, ACP support, terminal mode, telemetry, install details and distribution notes moved into docs/ unchanged apart from two corrections. winget ID is getSigit.siGitCode, as in the manifest and winget-pkgs, not smbCloud.siGitCode. The AUR entry is removed since new AUR accounts are closed and there is no way to publish there. The README also says the snap is the desktop app, not the CLI. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
keypair34 committed
Oct 26, 2026 at 19:43 UTC
af218c9cec80310ab36e7c9341b82d001f9455bf
9 files changed
+286
-197
README.md
+43
-197
@@ -1,229 +1,75 @@
1
-# siGit Code
1
+<p align="center">
2
+ <img src="docs/assets/logo.png" alt="siGit Code" width="96">
3
+</p>
4
+
5
+<h1 align="center">siGit Code</h1>
6
+
7
+<p align="center"><strong>The coding agent that runs where your code lives.</strong></p>
8
+<p align="center">A modular on-device inference LLM coding agent. Core component of siGit Factory.</p>
9
10
<p align="center">
11
<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>
12
<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>
13
<a href="https://www.npmjs.com/package/@getsigit/sigit"><img src="https://img.shields.io/npm/v/@getsigit/sigit?style=flat-square&labelColor=17211D&color=235843" alt="npm"></a>
14
+ <a href="https://snapcraft.io/sigit"><img src="https://snapcraft.io/sigit/badge.svg" alt="sigit"></a>
15
<a href="https://sigit.si/code"><img src="https://img.shields.io/badge/sigit.si%2Fcode-235843?style=flat-square&labelColor=17211D" alt="Website"></a>
16
<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>
17
</p>
18
11
-siGit Code is a local-first AI coding agent. It runs on your machine by default, with optional
12
-cloud inference and remote automation when you choose them. No API key is required to start; the
13
-on-device path needs none at all.
14
-
15
-It is the agent runtime for [siGit Factory](https://factory.sigit.si/), the hosted version of the
16
-same product. Run it yourself, as below, or use siGit Code Cloud there if you would rather not
17
-host a model locally. [sigit.si](https://sigit.si) is Git hosting built for AI workflows.
18
-
19
-It works in any codebase. In smbCloud repos it is more useful out of the box because it already understands the Rust workspace layout, deploy flows, auth boundaries, and GresIQ.
20
-
21
-You can use it in two ways:
22
-
23
-- **ACP mode:** Zed or another ACP-compatible editor starts it over stdio with the `--acp` argument
24
-- **Terminal mode:** run `sigit` for the interactive chat UI
25
-
26
-Every ACP client must pass `--acp`. It takes no other arguments, and it is what
27
-tells the binary to speak the Agent Client Protocol instead of opening the
28
-terminal UI.
29
-
30
-| Platform | ACP mode | Terminal mode |
31
-|----------|----------|---------------|
32
-| macOS | ✓ | ✓ |
33
-| Linux | ✓ | ✓ |
34
-| Windows | ✓ | not yet |
19
+siGit Code runs on your machine and works in any codebase. Inference runs on-device by default through [Onde Inference](https://ondeinference.com), or on siGit Code Cloud when you choose it. You need no API key to start, and it works with any editor that speaks the [Agent Client Protocol](https://agentclientprotocol.com). The agent is Apache-2.0. siGit Code Cloud and [siGit Factory](https://factory.sigit.si/) are the hosted, paid side.
20
21
## Install
22
23
```sh
24
cargo install sigit
25
+brew tap getsigit/tap && brew trust --tap getsigit/tap && brew install sigit
26
+npm install -g @getsigit/sigit
27
```
28
42
-| Method | Command |
43
-|--------|---------|
44
-| Homebrew | `brew tap getsigit/tap && brew trust --tap getsigit/tap && brew install sigit` |
45
-| pip | `pip install sigit-code` |
46
-| uv | `uvx --from sigit-code sigit` |
47
-| npm | `npm install -g @getsigit/sigit` |
48
-| NuGet | `dotnet tool install --global SiGit.Code` |
49
-| winget | `winget install smbCloud.siGitCode` |
50
-| Scoop | `scoop bucket add getsigit https://github.com/getsigit/scoop-bucket && scoop install sigit` |
51
-| AUR | `yay -S sigit-bin` |
52
-| Debian/Ubuntu | download the `.deb` from [releases](https://github.com/getsigit/sigit/releases), then `sudo dpkg -i sigit_*.deb` |
53
-| Fedora/RHEL | download the `.rpm` from [releases](https://github.com/getsigit/sigit/releases), then `sudo rpm -i sigit-*.rpm` |
54
-
55
-## First run
56
-
57
-The first launch downloads a GGUF model from Hugging Face. Expect roughly 1 to 2 GB, depending on the model. After that, loads come from disk and are much faster.
58
-
59
-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.
60
-
61
-## Zed setup
62
-
63
-Add this to `~/.config/zed/settings.json`:
64
-
65
-```json
66
-{
67
- "agent_servers": {
68
- "siGit Code": {
69
- "type": "custom",
70
- "command": "/absolute/path/to/sigit",
71
- "args": ["--acp"]
72
- }
73
- }
74
-}
75
-```
76
-
77
-Use the full absolute path. `~` does not expand here.
29
+More ways, including pip, NuGet, winget, Scoop and Linux packages, are in [docs/install.md](docs/install.md).
30
79
-## Xcode custom agent
31
+## Get siGit anywhere
32
81
-In Xcode, open **Settings > Intelligence > Agents**, add a custom agent, and set:
33
+The command-line agent and the desktop and mobile app are separate products. Each cell links to where it ships.
34
83
-- **Executable:** the absolute path to `sigit`
84
-- **Arguments:** `--acp`
35
+| Desktop and mobile apps | macOS | Windows | Linux | iOS | Android |
36
+|---|:-:|:-:|:-:|:-:|:-:|
37
+| [App Store](https://apps.apple.com/app/id6753018849) | [✓](https://apps.apple.com/app/id6753018849) | | | [✓](https://apps.apple.com/app/id6753018849) | |
38
+| [Google Play](https://play.google.com/store/apps/details?id=xyz.smbcloud.SiGit) | | | | | [✓](https://play.google.com/store/apps/details?id=xyz.smbcloud.SiGit) |
39
+| [Microsoft Store](https://apps.microsoft.com/detail/9p69ph1k7nxx) | | [✓](https://apps.microsoft.com/detail/9p69ph1k7nxx) | | | |
40
+| [Snap Store](https://snapcraft.io/sigit) | | | [✓](https://snapcraft.io/sigit) | | |
41
+| [Direct download](https://github.com/getsigit/sigit-app/releases) | [✓](https://github.com/getsigit/sigit-app/releases) | [✓](https://github.com/getsigit/sigit-app/releases) | [✓](https://github.com/getsigit/sigit-app/releases) | | |
42
86
-In Xcode the `--acp` mode also loads the selected on-device model on the first
87
-prompt, so you do not need to send `/load` from the Xcode chat.
88
-
89
-To let siGit use Xcode's build, test, and project tools, enable **Allow external
90
-agents to use Xcode tools** in Xcode's Intelligence settings, keep the project
91
-open, and add this to `~/.config/sigit/mcp.toml`:
92
-
93
-```toml
94
-[[server]]
95
-name = "xcode"
96
-command = "xcrun"
97
-args = ["mcpbridge"]
98
-```
99
-
100
-## VS Code
101
-
102
-### With siGit Code Extension
103
-
104
-Install from the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=getsigit.sigit-code).
105
-
106
-```jsonc
107
-{
108
- "sigit.agents": {
109
- "sigit": {
110
- "name": "siGit (on-device)",
111
- "command": "sigit",
112
- "args": ["--acp"],
113
- "env": {}
114
- },
115
- },
116
- "sigit.agent.default": "sigit"
117
-}
118
-```
119
-
120
-### With ACP Client
121
-
122
-Install [ACP Client](https://marketplace.visualstudio.com/items?itemName=formulahendry.acp-client), then add:
123
-
124
-```json
125
-{
126
- "acp.agents": {
127
- "siGit Code": {
128
- "command": "sigit",
129
- "args": ["--acp"],
130
- "env": {}
131
- }
132
- }
133
-}
134
-```
43
+| Command line | macOS | Windows | Linux |
44
+|---|:-:|:-:|:-:|
45
+| [crates.io](https://crates.io/crates/sigit) | ✓ | ✓ | ✓ |
46
+| [Homebrew](docs/install.md) | ✓ | | |
47
+| [npm](https://www.npmjs.com/package/@getsigit/sigit) | ✓ | ✓ | ✓ |
48
+| [PyPI and uv](https://pypi.org/project/sigit-code/) | ✓ | ✓ | ✓ |
49
+| [NuGet](https://www.nuget.org/packages/SiGit.Code) | ✓ | ✓ | ✓ |
50
+| [winget](docs/install.md) | | ✓ | |
51
+| [Scoop](https://github.com/getsigit/scoop-bucket) | | ✓ | |
52
+| [deb and rpm](https://github.com/getsigit/sigit/releases) | | | ✓ |
53
136
-## ACP support
54
+`sudo snap install sigit` installs the desktop app, not the terminal agent. The app currently uses siGit Code Cloud for inference, while the command line runs models on-device. Details are in [docs/distribution.md](docs/distribution.md).
55
138
-siGit Code speaks [Agent Client Protocol](https://agentclientprotocol.com) v1 over stdio.
139
-As of 1.7.0 it implements the whole stable v1 surface an agent can offer:
56
+Every channel, kept current: https://getsigit.5mb.app/
57
141
-| Area | What is supported |
142
-|------|-------------------|
143
-| Sessions | `session/new`, `load`, `resume`, `fork`, `list` (paged, with a `cwd` filter), `close`, `delete`, and multi-root projects through `additionalDirectories` |
144
-| Prompts | Text, images, audio, embedded resources and resource links. Stop reasons `end_turn`, `max_tokens`, `max_turn_requests`, `refusal` and `cancelled` |
145
-| Updates | Message and thought chunks with a `messageId`, tool calls with diffs, locations and embedded terminals, plans, `usage_update`, `session_info_update`, slash commands |
146
-| Cancellation | `session/cancel`, and `$/cancel_request` for a prompt or a sign-in |
147
-| Permissions | `session/request_permission` with allow or deny, once or for the session. Manual, Auto and Plan as config options and as session modes |
148
-| Client features | `fs/read_text_file` and `fs/write_text_file`, `terminal/*`, URL-mode elicitation and boolean config options, each used only when the client advertises it |
149
-| MCP | stdio and Streamable HTTP servers passed in `mcpServers` |
150
-| Auth | `authenticate` (browser sign-in) and `logout` |
58
+## Use it your way
59
152
-`session/fork` is still marked unstable in the protocol. Draft v2 is not enabled.
60
+- **In your editor.** Any ACP client starts `sigit --acp`. See [ACP support](docs/acp.md).
61
+- **In the terminal.** Run `sigit` for a full-screen chat UI. See [terminal mode](docs/terminal.md).
62
+- **In scripts and CI.** `sigit run "<prompt>"` gives you JSONL events and exit codes. See [headless mode](docs/headless.md).
63
154
-## Terminal mode
64
+Setup guides for Zed, Xcode and VS Code are in [docs/editors.md](docs/editors.md).
65
156
-Run `sigit` in a terminal and you get the same model and system prompt as the editor integration, just in a full-screen chat UI.
66
+## Docs
67
158
-Terminal mode currently needs Unix terminal behavior, so it works on macOS and Linux only.
159
-
160
-The interactive UI emits [OSC 7501 program status](https://www.superlogical.com/rex/docs/build/program-status) reports so supporting terminals can show working, waiting for permission or input, browser sign-in, completion, and errors across tabs. User-driven quit reports idle; terminals expire active work on process exit and retain completion or error reports. Status sequences are never written to headless/JSON or ACP output.
161
-
162
-## Headless and CI mode
163
-
164
-Use `sigit run` to execute the same agent from scripts, CI, or another siGit Factory client:
165
-
166
-```sh
167
-sigit run "Review this repository and run the focused tests" --cwd .
168
-```
169
-
170
-Every run receives a durable session ID. The ID is printed to stderr in text mode and included
171
-in every event in JSONL mode. Resume the same conversation from a later command—or import it in
172
-an ACP client—by passing that ID:
173
-
174
-```sh
175
-sigit run "Continue with the next issue" --resume <session-id>
176
-```
177
-
178
-For automation, JSONL output provides session, assistant-delta, tool-call, tool-result, result,
179
-and error events on stdout. Logs remain on stderr.
180
-
181
-```sh
182
-sigit run "Run the checks" --output jsonl --allow-tool run_command
183
-```
184
-
185
-Mutating tools still follow siGit's permission policy. Because a headless run cannot answer an
186
-interactive permission prompt, approve only the tools the run needs with repeatable
187
-`--allow-tool` flags. The legacy `sigit -p "<prompt>"` form remains supported. See the
188
-[headless execution reference](docs/headless.md) for the event contract and exit codes.
189
-
190
-## Telemetry
191
-
192
-siGit Code itself collects no usage analytics. On-device models run on
193
-[Onde Inference](https://ondeinference.com), and Onde can report model timing to its own
194
-dashboard. That reporting only switches on in builds where Onde's credentials were embedded at
195
-compile time. When it is on, siGit Code sends:
196
-
197
-- one event when an on-device model finishes loading: the model's Hugging Face repo ID, its
198
- display name, and how long the load took;
199
-- one event per on-device response: the model ID, a per-process request ID, the response time,
200
- the time to first token when it was measured, and whether it succeeded, errored, or was
201
- cancelled.
202
-
203
-Nothing from your conversation goes with them: no prompts, responses, file paths, or code.
204
-siGit Code doesn't set a machine identifier, so every install reports as the same
205
-`onde-unknown` edge, and it sends no location. Models you run through siGit Code Cloud or your
206
-own endpoint send no Onde events.
207
-
208
-To see whether your build reports, load an on-device model and check the log for
209
-`ChatEngine: pulse telemetry enabled` or `ChatEngine: pulse telemetry disabled`. siGit Code logs
210
-to stderr, which an editor shows in its agent log. Terminal mode writes it to
211
-`$TMPDIR/sigit.log`.
212
-
213
-To turn it off, set `ONDE_DISABLE_PULSE=1` in the environment siGit Code runs in. For an
214
-editor, put it in the agent's `env` block:
215
-
216
-```json
217
-"env": { "ONDE_DISABLE_PULSE": "1" }
218
-```
68
+[Install](docs/install.md), [editors](docs/editors.md), [ACP](docs/acp.md), [terminal](docs/terminal.md), [headless](docs/headless.md), [hooks](docs/hooks.md), [MCP](docs/mcp.md), [telemetry](docs/telemetry.md), [distribution](docs/distribution.md). The index is [docs/README.md](docs/README.md).
69
220
-## Platform support
70
+## Contributing
71
222
-| Platform | Architecture |
223
-|----------|-------------|
224
-| macOS | arm64, x64 |
225
-| Linux (glibc) | arm64, x64 |
226
-| Windows | arm64, x64 |
72
+Issues and pull requests are welcome. Open one against `development`.
73
74
## License
75
docs/README.md
new
+13
@@ -0,0 +1,13 @@
1
+# siGit Code docs
2
+
3
+| Page | What it covers |
4
+|------|----------------|
5
+| [Install](install.md) | Every install command, first run, supported platforms |
6
+| [Editor setup](editors.md) | Zed, Xcode and VS Code |
7
+| [ACP support](acp.md) | The Agent Client Protocol surface siGit Code implements |
8
+| [Terminal mode](terminal.md) | The full-screen chat UI and OSC 7501 status reports |
9
+| [Headless and CI](headless.md) | `sigit run`, JSONL events, exit codes |
10
+| [Hooks](hooks.md) | Running your own commands around agent actions |
11
+| [MCP](mcp.md) | The hosted siGit MCP server |
12
+| [Telemetry](telemetry.md) | What Onde reports, and how to turn it off |
13
+| [Distribution](distribution.md) | Every channel, the app stores, and what the snap is |
docs/acp.md
new
+28
@@ -0,0 +1,28 @@
1
+# ACP support
2
+
3
+Zed or another ACP-compatible editor starts siGit Code over stdio with the `--acp` argument.
4
+Every ACP client must pass `--acp`. It takes no other arguments, and it is what
5
+tells the binary to speak the Agent Client Protocol instead of opening the
6
+terminal UI. See [editor setup](editors.md) for client configuration.
7
+
8
+| Platform | ACP mode | Terminal mode |
9
+|----------|----------|---------------|
10
+| macOS | ✓ | ✓ |
11
+| Linux | ✓ | ✓ |
12
+| Windows | ✓ | not yet |
13
+
14
+siGit Code speaks [Agent Client Protocol](https://agentclientprotocol.com) v1 over stdio.
15
+As of 1.7.0 it implements the whole stable v1 surface an agent can offer:
16
+
17
+| Area | What is supported |
18
+|------|-------------------|
19
+| Sessions | `session/new`, `load`, `resume`, `fork`, `list` (paged, with a `cwd` filter), `close`, `delete`, and multi-root projects through `additionalDirectories` |
20
+| Prompts | Text, images, audio, embedded resources and resource links. Stop reasons `end_turn`, `max_tokens`, `max_turn_requests`, `refusal` and `cancelled` |
21
+| Updates | Message and thought chunks with a `messageId`, tool calls with diffs, locations and embedded terminals, plans, `usage_update`, `session_info_update`, slash commands |
22
+| Cancellation | `session/cancel`, and `$/cancel_request` for a prompt or a sign-in |
23
+| Permissions | `session/request_permission` with allow or deny, once or for the session. Manual, Auto and Plan as config options and as session modes |
24
+| Client features | `fs/read_text_file` and `fs/write_text_file`, `terminal/*`, URL-mode elicitation and boolean config options, each used only when the client advertises it |
25
+| MCP | stdio and Streamable HTTP servers passed in `mcpServers` |
26
+| Auth | `authenticate` (browser sign-in) and `logout` |
27
+
28
+`session/fork` is still marked unstable in the protocol. Draft v2 is not enabled.
docs/assets/logo.png
Binary files /dev/null and b/docs/assets/logo.png differ
docs/distribution.md
new
+52
@@ -0,0 +1,52 @@
1
+# Distribution
2
+
3
+There are two products under the siGit Code name, and they ship through different channels.
4
+
5
+- **siGit Code** is the command-line agent in this repository. It runs in a terminal, in CI, or
6
+ inside any ACP editor.
7
+- **siGit Code & Deploy** is the desktop and mobile app, built from
8
+ [getsigit/sigit-app](https://github.com/getsigit/sigit-app). It adds a Git client, a code
9
+ editor and deploy to smbCloud around the same agent.
10
+
11
+Every channel is listed, and kept current, at <https://getsigit.5mb.app/>.
12
+
13
+## Command line
14
+
15
+| Channel | Package | Platforms |
16
+|---------|---------|-----------|
17
+| [crates.io](https://crates.io/crates/sigit) | `sigit` | macOS, Linux, Windows |
18
+| Homebrew | `getsigit/tap`, formula `sigit` | macOS |
19
+| [npm](https://www.npmjs.com/package/@getsigit/sigit) | `@getsigit/sigit` | macOS, Linux, Windows |
20
+| [PyPI](https://pypi.org/project/sigit-code/) | `sigit-code` | macOS, Linux, Windows |
21
+| NuGet | `SiGit.Code` | macOS, Linux, Windows |
22
+| winget | `getSigit.siGitCode` | Windows |
23
+| Scoop | bucket `getsigit/scoop-bucket`, package `sigit` | Windows |
24
+| `.deb` and `.rpm` | [GitHub releases](https://github.com/getsigit/sigit/releases) | Linux (arm64, x64) |
25
+
26
+Each release is cut from this repository.
27
+
28
+## Apps
29
+
30
+| Store | Platforms | Link |
31
+|-------|-----------|------|
32
+| App Store | iOS, iPadOS, macOS | [siGit Code & Deploy](https://apps.apple.com/app/id6753018849) |
33
+| Google Play | Android | [siGit Code & Deploy](https://play.google.com/store/apps/details?id=xyz.smbcloud.SiGit) |
34
+| Microsoft Store | Windows | [siGit Code & Deploy](https://apps.microsoft.com/detail/9p69ph1k7nxx) |
35
+| Snap Store | Linux (amd64) | [`sudo snap install sigit`](https://snapcraft.io/sigit) |
36
+| Direct download | macOS, Windows, Linux | [sigit-app releases](https://github.com/getsigit/sigit-app/releases) |
37
+
38
+App versions are numbered separately from the CLI.
39
+
40
+### The snap is the desktop app
41
+
42
+`sudo snap install sigit` installs the desktop app, not the terminal agent. If you want the
43
+`sigit` command, use one of the command-line channels above.
44
+
45
+The snap uses strict confinement, so the agent inside it has no shell tool. It reads and edits
46
+files in the folder you open and answers through siGit Code Cloud.
47
+
48
+## Inference
49
+
50
+The CLI runs models on-device through [Onde Inference](https://ondeinference.com) by default, and
51
+can use siGit Code Cloud when you choose it. The desktop and mobile apps currently use siGit Code
52
+Cloud.
docs/editors.md
new
+78
@@ -0,0 +1,78 @@
1
+# Editor setup
2
+
3
+siGit Code runs inside any [ACP](acp.md) editor. Every client must pass `--acp`.
4
+
5
+## Zed setup
6
+
7
+Add this to `~/.config/zed/settings.json`:
8
+
9
+```json
10
+{
11
+ "agent_servers": {
12
+ "siGit Code": {
13
+ "type": "custom",
14
+ "command": "/absolute/path/to/sigit",
15
+ "args": ["--acp"]
16
+ }
17
+ }
18
+}
19
+```
20
+
21
+Use the full absolute path. `~` does not expand here.
22
+
23
+## Xcode custom agent
24
+
25
+In Xcode, open **Settings > Intelligence > Agents**, add a custom agent, and set:
26
+
27
+- **Executable:** the absolute path to `sigit`
28
+- **Arguments:** `--acp`
29
+
30
+In Xcode the `--acp` mode also loads the selected on-device model on the first
31
+prompt, so you do not need to send `/load` from the Xcode chat.
32
+
33
+To let siGit use Xcode's build, test, and project tools, enable **Allow external
34
+agents to use Xcode tools** in Xcode's Intelligence settings, keep the project
35
+open, and add this to `~/.config/sigit/mcp.toml`:
36
+
37
+```toml
38
+[[server]]
39
+name = "xcode"
40
+command = "xcrun"
41
+args = ["mcpbridge"]
42
+```
43
+
44
+## VS Code
45
+
46
+### With siGit Code Extension
47
+
48
+Install from the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=getsigit.sigit-code).
49
+
50
+```jsonc
51
+{
52
+ "sigit.agents": {
53
+ "sigit": {
54
+ "name": "siGit (on-device)",
55
+ "command": "sigit",
56
+ "args": ["--acp"],
57
+ "env": {}
58
+ },
59
+ },
60
+ "sigit.agent.default": "sigit"
61
+}
62
+```
63
+
64
+### With ACP Client
65
+
66
+Install [ACP Client](https://marketplace.visualstudio.com/items?itemName=formulahendry.acp-client), then add:
67
+
68
+```json
69
+{
70
+ "acp.agents": {
71
+ "siGit Code": {
72
+ "command": "sigit",
73
+ "args": ["--acp"],
74
+ "env": {}
75
+ }
76
+ }
77
+}
78
+```
docs/install.md
new
+36
@@ -0,0 +1,36 @@
1
+# Install
2
+
3
+siGit Code is a single binary. Pick the channel you already use.
4
+
5
+```sh
6
+cargo install sigit
7
+```
8
+
9
+| Method | Command |
10
+|--------|---------|
11
+| Homebrew | `brew tap getsigit/tap && brew trust --tap getsigit/tap && brew install sigit` |
12
+| pip | `pip install sigit-code` |
13
+| uv | `uvx --from sigit-code sigit` |
14
+| npm | `npm install -g @getsigit/sigit` |
15
+| NuGet | `dotnet tool install --global SiGit.Code` |
16
+| winget | `winget install getSigit.siGitCode` |
17
+| Scoop | `scoop bucket add getsigit https://github.com/getsigit/scoop-bucket && scoop install sigit` |
18
+| Debian/Ubuntu | download the `.deb` from [releases](https://github.com/getsigit/sigit/releases), then `sudo dpkg -i sigit_*.deb` |
19
+| Fedora/RHEL | download the `.rpm` from [releases](https://github.com/getsigit/sigit/releases), then `sudo rpm -i sigit-*.rpm` |
20
+
21
+See [distribution](distribution.md) for how each channel is fed, and for the desktop and mobile
22
+apps, which are a separate product.
23
+
24
+## First run
25
+
26
+The first launch downloads a GGUF model from Hugging Face. Expect roughly 1 to 2 GB, depending on the model. After that, loads come from disk and are much faster.
27
+
28
+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.
29
+
30
+## Platform support
31
+
32
+| Platform | Architecture |
33
+|----------|-------------|
34
+| macOS | arm64, x64 |
35
+| Linux (glibc) | arm64, x64 |
36
+| Windows | arm64, x64 |
docs/telemetry.md
new
+29
@@ -0,0 +1,29 @@
1
+# Telemetry
2
+
3
+siGit Code itself collects no usage analytics. On-device models run on
4
+[Onde Inference](https://ondeinference.com), and Onde can report model timing to its own
5
+dashboard. That reporting only switches on in builds where Onde's credentials were embedded at
6
+compile time. When it is on, siGit Code sends:
7
+
8
+- one event when an on-device model finishes loading: the model's Hugging Face repo ID, its
9
+ display name, and how long the load took;
10
+- one event per on-device response: the model ID, a per-process request ID, the response time,
11
+ the time to first token when it was measured, and whether it succeeded, errored, or was
12
+ cancelled.
13
+
14
+Nothing from your conversation goes with them: no prompts, responses, file paths, or code.
15
+siGit Code doesn't set a machine identifier, so every install reports as the same
16
+`onde-unknown` edge, and it sends no location. Models you run through siGit Code Cloud or your
17
+own endpoint send no Onde events.
18
+
19
+To see whether your build reports, load an on-device model and check the log for
20
+`ChatEngine: pulse telemetry enabled` or `ChatEngine: pulse telemetry disabled`. siGit Code logs
21
+to stderr, which an editor shows in its agent log. Terminal mode writes it to
22
+`$TMPDIR/sigit.log`.
23
+
24
+To turn it off, set `ONDE_DISABLE_PULSE=1` in the environment siGit Code runs in. For an
25
+editor, put it in the agent's `env` block:
26
+
27
+```json
28
+"env": { "ONDE_DISABLE_PULSE": "1" }
29
+```
docs/terminal.md
new
+7
@@ -0,0 +1,7 @@
1
+# Terminal mode
2
+
3
+Run `sigit` in a terminal and you get the same model and system prompt as the editor integration, just in a full-screen chat UI.
4
+
5
+Terminal mode currently needs Unix terminal behavior, so it works on macOS and Linux only.
6
+
7
+The interactive UI emits [OSC 7501 program status](https://www.superlogical.com/rex/docs/build/program-status) reports so supporting terminals can show working, waiting for permission or input, browser sign-in, completion, and errors across tabs. User-driven quit reports idle; terminals expire active work on process exit and retain completion or error reports. Status sequences are never written to headless/JSON or ACP output.