Update readmes with --acp argument
Seto Elkahfi committed
Sep 17, 2026 at 11:50 UTC
e41d3747d5250888d98040bbc1438168b1c73af6
4 files changed
+30
-15
README.md
+11
-6
@@ -16,9 +16,13 @@ It works in any codebase. In smbCloud repos it is more useful out of the box bec
16
17
You can use it in two ways:
18
19
-- **ACP mode:** Zed or another ACP-compatible editor starts it over stdio
19
+- **ACP mode:** Zed or another ACP-compatible editor starts it over stdio with the `--acp` argument
20
- **Terminal mode:** run `sigit` for the interactive chat UI
21
22
+Every ACP client must pass `--acp`. It takes no other arguments, and it is what
23
+tells the binary to speak the Agent Client Protocol instead of opening the
24
+terminal UI.
25
+
26
| Platform | ACP mode | Terminal mode |
27
|----------|----------|---------------|
28
| macOS | ✓ | ✓ |
@@ -59,7 +63,8 @@ Add this to `~/.config/zed/settings.json`:
63
"agent_servers": {
64
"siGit Code": {
65
"type": "custom",
62
- "command": "/absolute/path/to/sigit"
66
+ "command": "/absolute/path/to/sigit",
67
+ "args": ["--acp"]
68
}
69
}
70
}
@@ -74,8 +79,8 @@ In Xcode, open **Settings > Intelligence > Agents**, add a custom agent, and set
79
- **Executable:** the absolute path to `sigit`
80
- **Arguments:** `--acp`
81
77
-The explicit `--acp` mode is designed for Xcode: it loads the selected on-device
78
-model on the first prompt, so you do not need to send `/load` from the Xcode chat.
82
+In Xcode the `--acp` mode also loads the selected on-device model on the first
83
+prompt, so you do not need to send `/load` from the Xcode chat.
84
85
To let siGit use Xcode's build, test, and project tools, enable **Allow external
86
agents to use Xcode tools** in Xcode's Intelligence settings, keep the project
@@ -100,7 +105,7 @@ Install from the [Visual Studio Code Marketplace](https://marketplace.visualstud
105
"sigit": {
106
"name": "siGit (on-device)",
107
"command": "sigit",
103
- "args": [],
108
+ "args": ["--acp"],
109
"env": {}
110
},
111
},
@@ -117,7 +122,7 @@ Install [ACP Client](https://marketplace.visualstudio.com/items?itemName=formula
122
"acp.agents": {
123
"siGit Code": {
124
"command": "sigit",
120
- "args": [],
125
+ "args": ["--acp"],
126
"env": {}
127
}
128
}
npm/sigit/README.md
+5
-3
@@ -50,7 +50,8 @@ Supported targets:
50
sigit
51
```
52
53
-That starts the local terminal UI.
53
+That starts the local terminal UI. To run it as an editor agent instead, launch it
54
+with `--acp`, which every ACP client must pass.
55
56
### Zed
57
@@ -61,7 +62,8 @@ Add this to `~/.config/zed/settings.json`:
62
"agent_servers": {
63
"siGit Code": {
64
"type": "custom",
64
- "command": "sigit"
65
+ "command": "sigit",
66
+ "args": ["--acp"]
67
}
68
}
69
}
@@ -78,7 +80,7 @@ Install [ACP Client](https://marketplace.visualstudio.com/items?itemName=formula
80
"acp.agents": {
81
"siGit Code": {
82
"command": "sigit",
81
- "args": [],
83
+ "args": ["--acp"],
84
"env": {}
85
}
86
}
nuget/sigit/README.md
+10
-4
@@ -21,8 +21,14 @@ dotnet tool update --global SiGit.Code
21
sigit
22
```
23
24
-In a terminal that opens the chat UI. When stdin is a pipe, the same binary speaks the Agent
25
-Client Protocol (ACP) over stdio instead, which is how editors such as Zed and VS Code drive it.
24
+In a terminal that opens the chat UI. Run it with `--acp` and the same binary speaks the Agent
25
+Client Protocol (ACP) over stdio instead, which is how editors such as Zed and VS Code drive it:
26
+
27
+```sh
28
+sigit --acp
29
+```
30
+
31
+Configure that argument in the editor's agent settings; `--acp` takes no other arguments.
32
33
First run downloads a GGUF model, so expect a wait of a gigabyte or two before the first reply.
34
On macOS the model cache is shared with the siGit Code desktop app, so a model either app has
@@ -36,8 +42,8 @@ This .NET tool bundles native `sigit` binaries for:
42
- Linux `arm64`, `x64` (glibc)
43
- Windows `arm64`, `x64`
44
39
-The terminal chat UI is Unix-only. On Windows the binary runs in ACP mode, so use it through an
40
-editor rather than directly.
45
+The terminal chat UI is Unix-only. On Windows the binary runs in ACP mode (`sigit --acp`), so use
46
+it through an editor rather than directly.
47
48
Because all six binaries ship in one package, the install is large. If that matters, the Homebrew,
49
npm, and PyPI packages each download only the binary for your platform.
pypi/README.md
+4
-2
@@ -30,7 +30,8 @@ This installs a native `sigit` binary for your platform. You do not need a compi
30
sigit
31
```
32
33
-That opens the local chat UI.
33
+That opens the local chat UI. Editors drive the same binary in ACP mode, which
34
+needs the `--acp` argument.
35
36
### Zed
37
@@ -41,7 +42,8 @@ siGit Code works as an [ACP-compatible](https://github.com/nicobailon/agent-clie
42
"agent_servers": {
43
"siGit Code": {
44
"type": "custom",
44
- "command": "/absolute/path/to/sigit"
45
+ "command": "/absolute/path/to/sigit",
46
+ "args": ["--acp"]
47
}
48
}
49
}