@hej / sigit
Code Commits Issues Pulls Sessions CI/CD
feature/crates-release
development feature/crates-release feature/v1.0.4 main
md 109 lines 3.44 KB
Rendered Raw
1 # siGit Code
2
3 <p align="center">
4 <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>
5 <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>
6 <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>
7 <a href="https://smbcloud.xyz"><img src="https://img.shields.io/badge/smbcloud.xyz-235843?style=flat-square&labelColor=17211D" alt="Website"></a>
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.
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.
14
15 Two modes:
16
17 - **ACP mode** — Zed or another ACP-compatible editor starts it over stdio
18 - **Terminal mode** — run `sigit` for an interactive chat UI
19
20 | Platform | ACP mode | Terminal mode |
21 |----------|----------|---------------|
22 | macOS | ✓ | ✓ |
23 | Linux | ✓ | ✓ |
24 | Windows | ✓ | not yet |
25
26 ## smbCloud context
27
28 In an smbCloud repo, siGit knows the terrain:
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
34
35 In other repos it stays general and doesn't pretend otherwise.
36
37 ## Install
38
39 ```sh
40 cargo install sigit
41 ```
42
43 | Method | Command |
44 |--------|---------|
45 | Homebrew | `brew tap getsigit/tap && brew install sigit` |
46 | pip | `pip install sigit-code` |
47 | uv | `uvx --from sigit-code sigit` |
48 | npm | `npm install -g @smbcloud/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.
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.
55
56 ## Zed setup
57
58 Add to `~/.config/zed/settings.json`:
59
60 ```json
61 {
62 "agent_servers": {
63 "siGit Code": {
64 "type": "custom",
65 "command": "/absolute/path/to/sigit"
66 }
67 }
68 }
69 ```
70
71 Use the full absolute path. `~` doesn't expand here.
72
73 ## VSCode via ACP Client extension
74
75 Install [ACP client](https://marketplace.visualstudio.com/items?itemName=formulahendry.acp-client):
76
77 ```json
78 {
79 "acp.agents": {
80 "siGit Code": {
81 "command": "sigit",
82 "args": [],
83 "env": {}
84 }
85 }
86 }
87 ```
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.
92
93 Terminal mode needs Unix terminal behavior, so macOS and Linux only for now.
94
95 ## Platform support
96
97 | Platform | Architecture |
98 |----------|-------------|
99 | macOS | arm64, x64 |
100 | Linux (glibc) | arm64, x64 |
101 | Windows | arm64, x64 |
102
103 ## License
104
105 [Apache 2.0](https://github.com/getsigit/sigit/blob/main/LICENSE)
106
107 ## Copyright
108
109 © 2026 [smbCloud](https://smbcloud.xyz/) (Splitfire AB).