8 files changed
+346
-105
.agents/skills/branding/SKILL.md
new
+173
@@ -0,0 +1,173 @@
1
+# Skill: Branding and naming reference
2
+
3
+## Overview
4
+
5
+Use this file when writing docs, release notes, UI copy, package metadata, or setup guides for this repository.
6
+
7
+The short version:
8
+
9
+- **Product / brand name:** `siGit Code`
10
+- **CLI command:** `sigit`
11
+- **Rust crate:** `sigit`
12
+- **npm package:** `@smbcloud/sigit`
13
+- **PyPI package:** `sigit-code`
14
+- **Company name:** `smbCloud`
15
+- **LLM backend name:** `Onde Inference`
16
+
17
+The most common mistake is mixing the product name with the command name.
18
+
19
+---
20
+
21
+## Primary rule
22
+
23
+When you mean the product, write **`siGit Code`** exactly like that.
24
+
25
+Correct:
26
+
27
+- `siGit Code is a local coding agent.`
28
+- `siGit Code works in Zed over ACP.`
29
+- `siGit Code shares its model cache with the desktop app on macOS.`
30
+
31
+Wrong:
32
+
33
+- `Sigit Code`
34
+- `SiGit Code`
35
+- `siGit`
36
+- `sigit Code`
37
+- `SIGIT`
38
+
39
+Do not shorten the product name to just `siGit` in documentation or marketing copy unless there is a very specific reason and the surrounding text makes it unmistakable.
40
+
41
+---
42
+
43
+## Use lowercase names for commands and packages
44
+
45
+Use lowercase `sigit` when you mean the executable, crate, repo slug, or package name.
46
+
47
+Examples:
48
+
49
+- Run `sigit` in a terminal.
50
+- Install with `cargo install sigit`.
51
+- Install with `npm install -g @smbcloud/sigit`.
52
+- Install with `pip install sigit-code`.
53
+- The repository is `getsigit/sigit`.
54
+
55
+This distinction matters:
56
+
57
+- **Brand / product:** `siGit Code`
58
+- **Command / package / repo:** `sigit`
59
+
60
+---
61
+
62
+## Recommended wording patterns
63
+
64
+### Product description
65
+
66
+Prefer:
67
+
68
+- `siGit Code is a local coding agent.`
69
+- `siGit Code runs on your machine.`
70
+- `siGit Code works with any codebase.`
71
+
72
+Avoid:
73
+
74
+- `siGit is a local coding agent.`
75
+- `sigit is a coding assistant.`
76
+- `The siGit product...`
77
+
78
+### Install instructions
79
+
80
+Prefer:
81
+
82
+- `Install siGit Code with Cargo:`
83
+- `Install siGit Code from npm:`
84
+- To start siGit Code, run `sigit`.
85
+
86
+That keeps the brand name in prose and the command name in code.
87
+
88
+### Editor setup
89
+
90
+In UI-facing examples, keep the displayed agent name as `siGit Code`.
91
+
92
+Example:
93
+
94
+```/dev/null/branding-example.json#L1-8
95
+{
96
+ "agent_servers": {
97
+ "siGit Code": {
98
+ "type": "custom",
99
+ "command": "/absolute/path/to/sigit"
100
+ }
101
+ }
102
+}
103
+```
104
+
105
+The visible name is `siGit Code`. The executable path is `sigit`.
106
+
107
+---
108
+
109
+## Other names that should stay consistent
110
+
111
+### smbCloud
112
+
113
+Always write `smbCloud` with a lowercase `smb` and uppercase `C`.
114
+
115
+Correct:
116
+
117
+- `smbCloud`
118
+
119
+Wrong:
120
+
121
+- `SMBCloud`
122
+- `SmbCloud`
123
+- `smbcloud`
124
+
125
+### Onde Inference
126
+
127
+Use `Onde Inference` when referring to the product or project.
128
+
129
+Use `onde` when referring to the Rust crate.
130
+
131
+Examples:
132
+
133
+- `siGit Code uses Onde Inference as its local LLM backend.`
134
+- The Rust dependency is `onde`.
135
+
136
+### ACP
137
+
138
+Use `ACP` for the protocol acronym.
139
+
140
+Preferred long form:
141
+
142
+- `Agent Client Protocol (ACP)` on first mention when useful
143
+
144
+---
145
+
146
+## Copy checklist
147
+
148
+Before you finish any docs or release-note edit, check these quickly:
149
+
150
+1. Did you use `siGit Code` for the product name?
151
+2. Did you keep `sigit` lowercase for commands and package names?
152
+3. Did you keep `smbCloud` cased correctly?
153
+4. Did you keep `Onde Inference` cased correctly in prose?
154
+5. In setup examples, does the visible editor label say `siGit Code` while the command stays `sigit`?
155
+
156
+---
157
+
158
+## Fast replacements
159
+
160
+Common fixes:
161
+
162
+- `siGit is` -> `siGit Code is`
163
+- `siGit works` -> `siGit Code works`
164
+- `siGit knows` -> `siGit Code knows`
165
+- `On macOS, siGit` -> `On macOS, siGit Code`
166
+- `Sigit` -> usually `siGit Code` or `sigit`, depending on context
167
+
168
+When in doubt, ask:
169
+
170
+> Am I talking about the branded product, or the literal command/package name?
171
+
172
+If it is the product, use `siGit Code`.
173
+If it is something users type or install, use `sigit`.
CHANGELOG.md
+114
-38
@@ -1,69 +1,145 @@
1
# Changelog
2
3
-## 1.0.0 — 2026
3
+## 1.0.3
4
5
-We've been running siGit in real smbCloud codebases for a while now. It holds up. Time to call it 1.0.
5
+This is the cleanup release for the editor-side startup problems.
6
7
----
7
+### What changed
8
9
-### The short version
9
+- Fixed ACP sessions failing on the first real prompt because the server claimed the model was ready before anything had actually been loaded
10
+- Changed ACP startup so the default model loads lazily on the first non-slash prompt instead of pretending it is already in memory
11
+- Kept `initialize` and `session/new` lightweight while still sending proper progress updates once model loading begins
12
+- Updated the Onde integration to `1.0.0`
13
+- Removed a few dependencies we were no longer using
14
11
-siGit is a local coding agent. It runs a quantized LLM on your machine, talks to editors over ACP, and can read files, run commands, search the web, and write code, all without sending anything to a cloud API. You can install it with cargo, pip, npm, or Homebrew. Then you use it like any other tool on your machine.
15
+## 1.0.2
16
13
----
17
+This release was supposed to fix the ACP auth breakage. It did fix the stdout pollution problem, but it turned out not to be the whole story.
18
+
19
+### What changed
20
+
21
+- Delayed model loading in ACP mode so startup diagnostics would not leak into protocol stdout during the auth handshake
22
+- Tightened up the ACP startup path for editor integrations
23
+- Refreshed some README wording while cutting `1.0.2`
24
+
25
+## 1.0.1
26
+
27
+The first patch after `1.0.0` was mostly about making model loading and model switching feel less opaque.
28
+
29
+### What changed
30
+
31
+- Added ToolCall-based progress UI for startup model loading and downloading
32
+- Improved model-switch progress reporting in ACP clients
33
+- Fixed model-load error handling so failed switches did not leave the UI in a weird state
34
+- Cleaned up a few status messages and docs while the release was going out
35
+
36
+## 1.0.0 (2026)
37
+
38
+siGit Code has been living in real smbCloud repos for a while now. At some point it stopped feeling like an experiment, so we called it 1.0.
39
+
40
+### What this release is
41
+
42
+siGit Code is a local coding agent. It runs a quantized model on your machine, talks to editors over ACP, and can read files, run commands, fetch web pages, and write code without sending your project to a hosted API.
43
+
44
+You can install it with Cargo, pip, npm, or Homebrew and use it like any other tool on your machine.
45
+
46
+### What shipped in 1.0
47
+
48
+#### Editor integration
49
+
50
+This is the core of the project.
51
+
52
+Zed and VS Code can talk to siGit Code over ACP. Multi-turn sessions work. Tool calling works. Session forking works. Working-directory context works. That was the original goal, and it feels solid now.
53
15
-### What's actually in here
54
+#### Terminal UI
55
17
-**The editor integration** is the main thing. Zed and VSCode both pick it up as an ACP agent. Multi-turn sessions, tool calling, session forking, working directory context, all there. This was the original goal, and it feels solid now.
56
+The terminal UI started as a side quest and turned out to be useful. You get a full-screen ratatui chat, streaming tokens, a spinner while the model is busy, and a model picker you can open in the middle of a session.
57
19
-**The terminal UI** started as a bonus and ended up being genuinely useful. You get a full-screen ratatui chat, streaming tokens with a blinking cursor, a spinner while the model thinks, and a model picker you can open mid-session. It runs on macOS and Linux. Windows gets the editor integration for now. TUI support there is still on the list.
58
+It runs on macOS and Linux. Windows gets ACP and editor mode for now. The Windows terminal UI is still unfinished.
59
21
-**Tool calling** is what makes it feel like an agent instead of a chat window. The loop runs up to 10 rounds per message:
60
+#### Tool calling
61
+
62
+This is the part that makes siGit Code feel like an agent instead of a chat box. The loop can run up to 10 rounds per message.
63
+
64
+Available tools:
65
66
- `read_file` / `write_file` / `delete_file`
67
- `list_directory` / `search_files`
25
-- `run_command` — shell commands with optional working directory
26
-- `read_website` — fetches a URL and strips it to readable text
68
+- `run_command`, with an optional working directory
69
+- `read_website`, which fetches a URL and strips it down to readable text
70
28
-The model decides which tools to call, sees the results, and keeps going until it has something useful to say.
71
+The model can call a tool, inspect the result, and keep going until it has a real answer.
72
30
-**Model support** ended up broader than we expected for 1.0. Qwen 3 1.7B, 4B, 8B, and 14B. Qwen 2.5 1.5B and 3B. Qwen 2.5 Coder 1.5B, 3B, and 7B. DeepSeek Coder 6.7B. All GGUF, all pulled from HuggingFace on first run.
73
+#### Model support
74
32
-Qwen 3 is the interesting one. It uses extended thinking mode. The model reasons inside `<think>…</think>` blocks before answering. The TUI strips those out and renders them dimmed above the reply, so you can see what it was doing without cluttering the conversation. The 8B is the default on desktop. Mobile defaults to 1.7B because iOS gives apps about 2 to 3 GB, and we found out the hard way that 3B causes OOM on an iPhone 16e.
75
+The model list ended up wider than we expected for 1.0:
76
34
-**The model picker** (`/models` in the TUI, or an agent config option in editors) shows what is cached locally, what is available to download, whether a model supports tool calling, and whether its local cache looks healthy. Switching models downloads and loads in the background. The UI stays alive the whole time, with a progress bar.
77
+- Qwen 3 1.7B, 4B, 8B, and 14B
78
+- Qwen 2.5 1.5B and 3B
79
+- Qwen 2.5 Coder 1.5B, 3B, and 7B
80
+- DeepSeek Coder 6.7B
81
36
-**smbCloud context** is baked into the system prompt. siGit knows the difference between platform user flows and tenant app auth flows, how `Project` / `FrontendApp` / `AuthApp` / GresIQ fit together, that Next.js SSR deploys are not the generic git-push path, and what workspace patterns smbCloud repos tend to follow. Outside smbCloud, it behaves like a normal coding agent and does not force platform-specific advice where it does not belong.
82
+They are all GGUF models and they all come from Hugging Face on first run.
83
38
-**Distribution** ended up being more work than the software itself, honestly. Pre-built binaries for macOS (arm64 + x64), Linux (arm64 + x64), and Windows (arm64 + x64). Four install methods: `cargo install sigit`, `pip install sigit-code`, `npm install -g @smbcloud/sigit`, `brew install sigit`. Getting all of that working across CI, crates.io, PyPI, npm, and Homebrew was basically its own project.
84
+Qwen 3 is the interesting one. It uses extended thinking mode. The model reasons inside `<think>...</think>` blocks before answering. The TUI strips those blocks out and renders them dimmed above the reply, so you can see what happened without turning the whole conversation into noise.
85
40
----
86
+The 8B model is the desktop default. Mobile stays on 1.7B because iOS gives apps roughly 2 to 3 GB of memory, and we learned the hard way that 3B can blow up on an iPhone 16e.
87
42
-### What doesn't work yet
88
+#### Model picker
89
44
-The Windows TUI. ACP and editor mode work fine on Windows. It is just the interactive terminal UI that is still missing. The underlying issue is Unix-specific terminal handling that we have not abstracted yet.
90
+The model picker shows:
91
46
----
92
+- what is already cached locally
93
+- what can be downloaded
94
+- which models support tool calling
95
+- whether the local cache looks healthy
96
+
97
+You can open it with `/models` in the TUI or through the editor config option. Switching models happens in the background and the UI stays alive while the download or load is in progress.
98
+
99
+#### smbCloud context
100
+
101
+siGit Code knows smbCloud repos better than a generic coding assistant does. It understands the difference between platform-user flows and tenant-app auth flows, how `Project`, `FrontendApp`, `AuthApp`, and GresIQ fit together, and why Next.js SSR deploys are not the same thing as the generic git-push path.
102
+
103
+Outside smbCloud, it backs off and behaves like a normal coding agent.
104
+
105
+#### Distribution
106
+
107
+Distribution took an unreasonable amount of time, honestly.
108
+
109
+There are prebuilt binaries for macOS, Linux, and Windows on both arm64 and x64 where relevant, plus install paths through Cargo, PyPI, npm, and Homebrew:
110
+
111
+- `cargo install sigit`
112
+- `pip install sigit-code`
113
+- `npm install -g @smbcloud/sigit`
114
+- `brew install sigit`
115
+
116
+Getting that whole pipeline to behave across CI, crates.io, PyPI, npm, and Homebrew was basically its own project.
117
+
118
+### What still does not work
119
+
120
+The Windows terminal UI is still missing.
121
+
122
+ACP and editor mode work on Windows. The part that is still missing is the interactive full-screen terminal UI. The blocker is Unix-specific terminal handling that has not been abstracted cleanly yet.
123
124
### Changes since 0.1.2
125
50
-- Qwen 3 14B support
51
-- Qwen 3 `<think>` block parsing, which strips and renders thinking content separately in the TUI
52
-- Moved all TUI code into `#[cfg(unix)]`, which fixed a pile of dead-code errors on Windows CI that were blocking releases
53
-- Live download progress bar during model switch, with cancellation support (Ctrl+C mid-download works)
54
-- Model download and loading progress shown in the Zed agent config panel
55
-- Animated spinner during model switching
56
-- Qwen 2.5 Coder 7B
57
-- Available-for-download models shown in the picker, not just locally cached ones
58
-- Model selection persists across restarts
59
-- Session working directory support
60
-- Model picker logic moved to a platform-independent module so it compiles on Windows even without the TUI
61
-- `/models N` shortcut for picking a model by number directly
62
-- `read_website` tool
63
-- Better `read_file` handling and empty reply detection
64
-- Async tool execution
126
+- Added Qwen 3 14B support
127
+- Added Qwen 3 `<think>` block parsing and separate rendering in the TUI
128
+- Moved all TUI code into `#[cfg(unix)]`, which fixed a pile of dead-code errors on Windows CI
129
+- Added live download progress during model switches, including cancellation with Ctrl+C
130
+- Added model download and loading progress in the Zed agent config panel
131
+- Added an animated spinner during model switching
132
+- Added Qwen 2.5 Coder 7B
133
+- Added downloadable models to the picker, not just locally cached ones
134
+- Made model selection persist across restarts
135
+- Added session working-directory support
136
+- Moved model picker logic into a platform-independent module so Windows can compile without the TUI
137
+- Added the `/models N` shortcut for picking a model by number
138
+- Added the `read_website` tool
139
+- Improved `read_file` handling and empty-reply detection
140
+- Added async tool execution
141
- Fixed CI cross-compilation for macOS, iOS, Linux, and Windows
66
-- npm, PyPI, and Homebrew distribution added
142
+- Added npm, PyPI, and Homebrew distribution
143
144
---
145
Cargo.lock
+1
-1
@@ -5002,7 +5002,7 @@ checksum = "0fda2ff0d084019ba4d7c6f371c95d8fd75ce3524c3cb8fb653a3023f6323e64"
5002
5003
[[package]]
5004
name = "sigit"
5005
-version = "1.0.2"
5005
+version = "1.0.3"
5006
dependencies = [
5007
"agent-client-protocol",
5008
"anyhow",
Cargo.toml
+1
-1
@@ -1,6 +1,6 @@
1
[package]
2
name = "sigit"
3
-version = "1.0.2"
3
+version = "1.0.3"
4
edition = "2024"
5
description = "siGit Code — ACP-compatible AI coding agent for smbCloud platform."
6
documentation = "https://github.com/getsigit/sigit"
README.md
+19
-19
@@ -8,14 +8,14 @@
8
<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>
9
</p>
10
11
-siGit is a coding agent that runs on your machine. No API keys, no cloud round-trips, no subscription.
11
+siGit Code is a local coding agent. It runs on your machine, not someone else's. No API keys, no cloud round-trips, no subscription.
12
13
-It works with any codebase. It knows smbCloud repos a bit better — the Rust workspace layout, deploy flows, auth boundaries, GresIQ — so you spend less time explaining the setup.
13
+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.
14
15
-Two modes:
15
+You can use it in two ways:
16
17
-- **ACP mode** — Zed or another ACP-compatible editor starts it over stdio
18
-- **Terminal mode** — run `sigit` for an interactive chat UI
17
+- **ACP mode:** Zed or another ACP-compatible editor starts it over stdio
18
+- **Terminal mode:** run `sigit` for the interactive chat UI
19
20
| Platform | ACP mode | Terminal mode |
21
|----------|----------|---------------|
@@ -25,14 +25,14 @@ Two modes:
25
26
## smbCloud context
27
28
-In an smbCloud repo, siGit knows the terrain:
28
+In an smbCloud repo, siGit Code already knows a few important things:
29
30
-- platform user flows and tenant app auth flows are different things
31
-- `Project` is the umbrella workspace; `FrontendApp`, `AuthApp`, and GresIQ are separate deployable units
32
-- Next.js SSR deploys aren't the same as the git-push path
33
-- existing workspace patterns and crate boundaries over new abstractions
30
+- platform-user flows and tenant-app auth flows are different systems
31
+- `Project` is the umbrella workspace, while `FrontendApp`, `AuthApp`, and GresIQ are separate deployable units
32
+- Next.js SSR deploys are not the same thing as the generic git-push path
33
+- existing crate boundaries and workspace patterns are usually the right place to start
34
35
-In other repos it stays general and doesn't pretend otherwise.
35
+In other repos it stays general and does not pretend everything is about smbCloud.
36
37
## Install
38
@@ -49,13 +49,13 @@ cargo install sigit
49
50
## First run
51
52
-On first launch siGit downloads a GGUF model from Hugging Face, usually 1–2 GB. After that it loads from disk in a few seconds.
52
+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.
53
54
-On macOS, the model cache is shared with the siGit desktop app via an App Group container. If the desktop app already pulled the model, the CLI reuses it.
54
+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.
55
56
## Zed setup
57
58
-Add to `~/.config/zed/settings.json`:
58
+Add this to `~/.config/zed/settings.json`:
59
60
```json
61
{
@@ -68,11 +68,11 @@ Add to `~/.config/zed/settings.json`:
68
}
69
```
70
71
-Use the full absolute path. `~` doesn't expand here.
71
+Use the full absolute path. `~` does not expand here.
72
73
-## VSCode via ACP Client extension
73
+## VS Code with ACP Client
74
75
-Install [ACP client](https://marketplace.visualstudio.com/items?itemName=formulahendry.acp-client):
75
+Install [ACP Client](https://marketplace.visualstudio.com/items?itemName=formulahendry.acp-client), then add:
76
77
```json
78
{
@@ -88,9 +88,9 @@ Install [ACP client](https://marketplace.visualstudio.com/items?itemName=formula
88
89
## Terminal mode
90
91
-Run `sigit` in a terminal and you get an interactive chat UI. Same model and system prompt as the editor integration, just without Zed.
91
+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.
92
93
-Terminal mode needs Unix terminal behavior, so macOS and Linux only for now.
93
+Terminal mode currently needs Unix terminal behavior, so it works on macOS and Linux only.
94
95
## Platform support
96
npm/README.md.tmpl
+9
-11
@@ -1,8 +1,8 @@
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.
4
+ A local coding agent powered by <a href="https://ondeinference.com">Onde Inference</a>.<br>
5
+ Runs on your machine. No API keys. No cloud round-trips.
6
</p>
7
8
<p align="center">
@@ -13,13 +13,11 @@
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
-
16
## `${node_pkg}`
17
20
-This is the npm distribution of siGit Code, a platform-specific binary package for [`@smbcloud/sigit`](https://www.npmjs.com/package/@smbcloud/sigit). You don't need to install it directly.
18
+This package is one of the platform-specific binaries behind [`@smbcloud/sigit`](https://www.npmjs.com/package/@smbcloud/sigit). You usually do not need to install it directly.
19
22
-Install the main package and npm pulls in the right binary for your OS and architecture:
20
+Install the main package and npm will pull in the right binary for your OS and architecture:
21
22
```sh
23
npm install -g @smbcloud/sigit
@@ -29,11 +27,11 @@ npm install -g @smbcloud/sigit
27
28
| Channel | Command |
29
|---------|---------|
32
-| **npm** | `npm install -g @smbcloud/sigit` |
33
-| **Homebrew** | `brew tap getsigit/tap && brew install sigit` |
34
-| **pip** | `pip install sigit-code` |
35
-| **uv** | `uvx --from sigit-code sigit` |
36
-| **Cargo** | `cargo install sigit` |
30
+| npm | `npm install -g @smbcloud/sigit` |
31
+| Homebrew | `brew tap getsigit/tap && brew install sigit` |
32
+| pip | `pip install sigit-code` |
33
+| uv | `uvx --from sigit-code sigit` |
34
+| Cargo | `cargo install sigit` |
35
36
## Platform support
37
npm/sigit/README.md
+19
-21
@@ -1,8 +1,8 @@
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 entirely on your machine — no API keys, no cloud round-trips.
4
+ A local coding agent powered by <a href="https://ondeinference.com">Onde Inference</a>.<br>
5
+ Runs on your machine. No API keys. No cloud round-trips.
6
</p>
7
8
<p align="center">
@@ -13,26 +13,28 @@
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
----
17
-
16
## Install
17
18
```sh
19
npm install -g @smbcloud/sigit
20
```
21
24
-The right binary for your platform is pulled in automatically. Works on macOS (Apple Silicon and Intel), Linux (x64 and arm64), and Windows (x64 and arm64).
22
+npm pulls in the right binary for your platform automatically.
23
+
24
+Supported targets:
25
+
26
+- macOS, Apple Silicon and Intel
27
+- Linux, x64 and arm64
28
+- Windows, x64 and arm64
29
26
-### Other ways to install
30
+## Other install methods
31
32
| Method | Command |
33
|---|---|
30
-| **Homebrew** | `brew tap getsigit/tap && brew install sigit` |
31
-| **pip** | `pip install sigit-code` |
32
-| **uv** | `uvx --from sigit-code sigit` |
33
-| **Cargo** | `cargo install sigit` |
34
-
35
----
34
+| Homebrew | `brew tap getsigit/tap && brew install sigit` |
35
+| pip | `pip install sigit-code` |
36
+| uv | `uvx --from sigit-code sigit` |
37
+| Cargo | `cargo install sigit` |
38
39
## Usage
40
@@ -40,9 +42,9 @@ The right binary for your platform is pulled in automatically. Works on macOS (A
42
sigit
43
```
44
43
-Opens a TUI coding agent that runs entirely on your device using a local LLM.
45
+That starts the local terminal UI.
46
45
-### Zed (ACP agent)
47
+### Zed
48
49
Add this to `~/.config/zed/settings.json`:
50
@@ -57,9 +59,9 @@ Add this to `~/.config/zed/settings.json`:
59
}
60
```
61
60
-Then select **siGit Code** as your agent in the Zed assistant panel.
62
+Then select **siGit Code** in the Zed assistant panel.
63
62
-### VSCode via ACP Client extension
64
+### VS Code with ACP Client
65
66
Install [ACP Client](https://marketplace.visualstudio.com/items?itemName=formulahendry.acp-client), then add:
67
@@ -75,8 +77,6 @@ Install [ACP Client](https://marketplace.visualstudio.com/items?itemName=formula
77
}
78
```
79
78
----
79
-
80
## Platform support
81
82
| Platform | Architecture | Package |
@@ -88,8 +88,6 @@ Install [ACP Client](https://marketplace.visualstudio.com/items?itemName=formula
88
| Windows | x64 | [`@smbcloud/sigit-windows-x64`](https://www.npmjs.com/package/@smbcloud/sigit-windows-x64) |
89
| Windows | arm64 | [`@smbcloud/sigit-windows-arm64`](https://www.npmjs.com/package/@smbcloud/sigit-windows-arm64) |
90
91
----
92
-
91
## Links
92
93
- [smbCloud](https://smbcloud.xyz/)
@@ -103,4 +101,4 @@ Install [ACP Client](https://marketplace.visualstudio.com/items?itemName=formula
101
102
## Copyright
103
106
-© 2026 [smbCloud](https://smbcloud.xyz/) (Splitfire AB).
\ No newline at end of file
104
+© 2026 [smbCloud](https://smbcloud.xyz/) (Splitfire AB).
pypi/README.md
+10
-14
@@ -1,8 +1,8 @@
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.
4
+ A local coding agent powered by <a href="https://ondeinference.com">Onde Inference</a>.<br>
5
+ Runs on your machine. No API keys. No cloud round-trips.
6
</p>
7
8
<p align="center">
@@ -13,10 +13,6 @@
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
-
16
## Install
17
18
```sh
@@ -24,21 +20,21 @@ pip install sigit-code
20
uvx --from sigit-code sigit
21
```
22
27
-Installs a native `sigit` binary for your platform. No compiler, no runtime dependencies.
23
+This installs a native `sigit` binary for your platform. You do not need a compiler or extra runtime setup.
24
25
## Quick start
26
31
-### Terminal
27
+### Terminal mode
28
29
```sh
30
sigit
31
```
32
37
-Opens a chat UI where you talk to a local LLM coding agent directly.
33
+That opens the local chat UI.
34
39
-### Zed (ACP agent)
35
+### Zed
36
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:
37
+siGit Code works as an [ACP-compatible](https://github.com/nicobailon/agent-client-protocol) agent in [Zed](https://zed.dev). Add this to your Zed settings:
38
39
```json
40
{
@@ -51,7 +47,7 @@ siGit works as an [ACP-compatible](https://github.com/nicobailon/agent-client-pr
47
}
48
```
49
54
-Then pick **sigit** as your agent in the Zed assistant panel.
50
+Then pick **siGit Code** in the assistant panel.
51
52
## Other install methods
53
@@ -80,7 +76,7 @@ cargo build --release
76
77
## Source and issues
78
83
-This package ships a pre-built binary. Source code is at [github.com/getsigit/sigit](https://github.com/getsigit/sigit). File bugs there.
79
+This package ships a prebuilt binary. The source code lives at [github.com/getsigit/sigit](https://github.com/getsigit/sigit). If something breaks, file the issue there.
80
81
## License
82
@@ -88,4 +84,4 @@ This package ships a pre-built binary. Source code is at [github.com/getsigit/si
84
85
## Copyright
86
91
-© 2026 [smbCloud](https://smbcloud.xyz/) (Splitfire AB).
\ No newline at end of file
87
+© 2026 [smbCloud](https://smbcloud.xyz/) (Splitfire AB).