feature/tool-permission-system
claude/code-feature-parity-q003hm
claude/elegant-carson-l1menh
claude/sigit-acp-local-chat-cx6380
claude/sigit-cloud-agent-expansion-reox0a
claude/tool-permission-system
claude/zen-feynman-0u78dk
development
feature/agent-tools-multiedit-glob-todos-remember
feature/background-commands
feature/commit-coauthor-attribution
feature/headless-mode
feature/init-command
feature/load-local-model-explicitly
feature/session-persistence-compaction
feature/sigit-code-cloud
feature/subagent-tool
feature/tool-permission-system
feature/tui-repo-tabs
feature/tui-tabs
main
release/v1.3.1
| 1 | # CLAUDE.md |
| 2 | |
| 3 | This file provides guidance to AI coding agents when working with code in this repository. |
| 4 | |
| 5 | ## What this is |
| 6 | |
| 7 | `sigit` ("siGit Code") is a single Rust binary: a local-first AI coding agent that runs LLM |
| 8 | inference on-device (via the `onde` crate / GGUF models) or against a hosted/OpenAI-compatible |
| 9 | endpoint. It exposes itself two ways from the *same* binary, chosen at startup by whether stdin |
| 10 | is a TTY: |
| 11 | |
| 12 | - **ACP mode** (stdin not a TTY): speaks the Agent Client Protocol over stdio for editor |
| 13 | integration (Zed, VS Code ACP Client). Cross-platform. |
| 14 | - **Interactive terminal mode** (stdin is a TTY): a full-screen ratatui chat UI. **Unix-only** — |
| 15 | it relies on fd redirection to keep logs out of the TUI, so Windows gets ACP mode only. |
| 16 | |
| 17 | Before the TTY/ACP split, `main` also dispatches the account subcommands `sigit login`, |
| 18 | `sigit logout`, `sigit whoami` (see `src/main.rs` `main()`). |
| 19 | |
| 20 | ## Working in this repo |
| 21 | |
| 22 | **IMPORTANT — branch naming:** Prefix every working branch with `feature/` (new functionality) |
| 23 | or `fix/` (bug fixes) — never a tool- or agent-name prefix like `claude/`. Name the branch after |
| 24 | the *changes it contains*, as a short, descriptive, kebab-case slug that is self-explanatory |
| 25 | from the name alone (e.g. `feature/tool-permission-system`, `fix/glob-mtime-sort`), never after |
| 26 | a task, ticket, or session id (not `feature/task-q003hm`). |
| 27 | |
| 28 | **IMPORTANT — pull request target:** Always open pull requests against the `development` branch, |
| 29 | never `main`. `main` is release-only; `development` is where day-to-day work integrates. |
| 30 | |
| 31 | **IMPORTANT — branch off `development`:** Start every working branch from the latest |
| 32 | `origin/development`. Exception: when new work *depends on* a feature branch that has not merged |
| 33 | yet (e.g. it builds on tools or APIs that branch introduces), it may be stacked on top of that |
| 34 | branch instead. When stacking: merge the base PR into `development` first, then rebase the |
| 35 | stacked branch onto `development` before opening its pull request, so each PR shows only its own |
| 36 | commits. |
| 37 | |
| 38 | **IMPORTANT — run CI before pushing:** Run the full CI gate locally and confirm it is green |
| 39 | *before* pushing a branch or opening a pull request — never push work that fails these: |
| 40 | |
| 41 | ```sh |
| 42 | cargo fmt -- --check # formatting |
| 43 | cargo clippy --tests -- -D warnings # lint (warnings are errors) |
| 44 | cargo test --locked # tests |
| 45 | ``` |
| 46 | |
| 47 | ## Build / test / lint |
| 48 | |
| 49 | ```sh |
| 50 | cargo build # debug build |
| 51 | cargo build --release # release binary at target/release/sigit |
| 52 | cargo run # launches interactive TUI (stdin is a TTY) |
| 53 | cargo test # CI runs: cargo test --locked --target <target> |
| 54 | cargo clippy --tests -- -D warnings # CI gate: clippy is -D warnings on all 4 targets |
| 55 | cargo fmt -- --check # CI gate (edition 2024) |
| 56 | ``` |
| 57 | |
| 58 | CI (`.github/workflows/ci.yml`) runs fmt + clippy + test across four targets: |
| 59 | `aarch64-apple-darwin`, `x86_64-apple-darwin`, `x86_64-unknown-linux-gnu`, |
| 60 | `x86_64-pc-windows-msvc`. Clippy is `-D warnings`, so warnings fail the build. |
| 61 | |
| 62 | Run a single test: `cargo test <test_name>`. |
| 63 | |
| 64 | ## Critical platform constraint: `#[cfg(unix)]` dead code |
| 65 | |
| 66 | The interactive client is `#[cfg(unix)]`-only. The `InferenceBackend` seam (`backend.rs`) and |
| 67 | provider resolution (`provider.rs`) are consumed by both the interactive client and the ACP |
| 68 | server, but several of their items are reached only through the Unix-only interactive paths, so |
| 69 | the dead-code lint is suppressed *on non-Unix targets only*. |
| 70 | |
| 71 | Consequence: code can pass clippy on macOS/Linux but fail on the Windows target (or vice versa). |
| 72 | When touching `backend.rs`, `provider.rs`, or the interactive path, keep the `cfg` gates intact — |
| 73 | don't "fix" an unused-warning by deleting code that's live on Unix. |
| 74 | |
| 75 | ## Architecture |
| 76 | |
| 77 | The agent loop is backend-agnostic. The flow: a turn (messages + tool specs) goes to an |
| 78 | `InferenceBackend`, which returns assistant text and/or tool calls; the loop executes tools and |
| 79 | feeds results back. Neither the loop nor ACP/TUI surfaces depend on a concrete backend. |
| 80 | |
| 81 | - **`src/main.rs`** — entry point, mode dispatch, the full ACP `Agent` impl (session lifecycle: |
| 82 | new/load/fork/prompt/cancel, config options, slash-command advertisement), and the `SYSTEM_PROMPT` |
| 83 | (note: it bakes in smbCloud-specific context the agent should use when the repo is clearly |
| 84 | smbCloud, and stay general otherwise). |
| 85 | - **`src/backend.rs`** — the `InferenceBackend` trait and neutral types (`ToolSpec`, `ToolCall`, |
| 86 | `ToolResult`, `TurnResult`). Two impls: `LocalBackend` (on-device via `onde::ChatEngine`) and |
| 87 | `OpenAiBackend` (any OpenAI-compatible HTTP endpoint). |
| 88 | - **`src/provider.rs`** — decides *which* backend serves inference. Resolution order, first match |
| 89 | wins: (1) override via `OPENAI_BASE_URL`+`OPENAI_API_KEY` or active profile in |
| 90 | `~/.config/sigit/providers.toml`; (2) siGit Code Cloud when logged in; (3) on-device. |
| 91 | - **`src/tools.rs`** — agent tool schemas + execution: `read_file`, `create_directory`, |
| 92 | `list_directory`, `search_files`, `glob`, `read_website`, `create_file`, `edit_file`, |
| 93 | `multi_edit`, `delete_file`, `run_command`, `write_todos`, `remember`. Add a tool in both the |
| 94 | spec list (`all_tools`) and the execute `match` (`execute_tool`). |
| 95 | - **`src/skills.rs`** — [Agent Skills](https://agentskills.io) support. Discovers skill |
| 96 | folders (each with a `SKILL.md`: YAML frontmatter `name` + `description`, then Markdown |
| 97 | instructions) from `.sigit/skills/` and `.claude/skills/` in the cwd, `$SIGIT_CONFIG_DIR/skills/`, |
| 98 | and `~/.claude/skills/`. Progressive disclosure: the discovery list (name + description) is |
| 99 | baked into the dynamically-built `skill` tool's description, and activating a skill (the model |
| 100 | calls `skill` with a name) loads the full `SKILL.md` body. The `skill` tool is appended in the |
| 101 | `*_as_specs`/`build_tool_specs` layer (not in `all_tools()`) so its description can be dynamic, |
| 102 | and only when at least one skill exists. |
| 103 | - **`src/mcp.rs`** — [Model Context Protocol](https://modelcontextprotocol.io) *client*. Connects to |
| 104 | MCP servers over the **Streamable HTTP** transport (one JSON-RPC POST endpoint; replies are |
| 105 | `application/json` or SSE), runs the `initialize`/`tools/list` handshake, and forwards `tools/call`. |
| 106 | Discovery is best-effort at startup (`mcp::init`, called from both branches of `main()`) and cached |
| 107 | in a process-global so the synchronous spec builders (`mcp::tool_specs`) and the async dispatch |
| 108 | (`mcp::call_tool`) can both read it. Tools are namespaced `mcp__<server>__<tool>`, appended in the |
| 109 | `*_as_specs`/`build_tool_specs` layer and routed in `tools::execute_tool` via `mcp::is_mcp_tool`. The |
| 110 | official server (`<cloud>/mcp`, default `https://sigit.si/api/v1/mcp`) is baked in and authed with the |
| 111 | cloud session token; extra servers live in `mcp.toml` (global `$SIGIT_CONFIG_DIR/mcp.toml` and |
| 112 | project-local `.sigit/mcp.toml`). stdio transport is not supported. |
| 113 | - **`src/permissions.rs`** — tool permission policy. Every tool call passes through |
| 114 | `decision_for` before executing: read-only tools always run; mutating tools (and all |
| 115 | `mcp__*`/unknown tools) are governed by, in order: per-session plan mode (`/plan` — deny all |
| 116 | mutating tools with a present-a-plan message), session "always allow" grants, per-tool |
| 117 | overrides and the default mode from `[permissions]` in `settings.toml` (`allow`/`ask`/`deny`, |
| 118 | default `ask`; `SIGIT_PERMISSIONS` env overrides the default). On `ask`, the ACP path sends |
| 119 | `session/request_permission` (allow once / allow for session / deny) and the TUI pauses the |
| 120 | inference task on a y/a/n prompt. Note: ACP turn-affecting handlers run in `cx.spawn`ed tasks |
| 121 | serialized by `SiGitAgent::turn_lock` so the dispatch loop can route the client's permission |
| 122 | answer mid-turn — don't move them back inline, and don't await client requests from inline |
| 123 | handlers (deadlock). |
| 124 | - **`src/instructions.rs`** — project instruction files, the always-on counterpart to skills. |
| 125 | Reads `AGENTS.md` (the cross-tool [agents.md](https://agents.md) standard) and `CLAUDE.md`, |
| 126 | walking from the session cwd up to the repo root (nearest ancestor with `.git`, never above it), |
| 127 | plus a global file under `$SIGIT_CONFIG_DIR`. Files are ordered outermost-first so the deepest |
| 128 | (most specific) wins. The combined block is injected via `session_context_message` in `main.rs` |
| 129 | — pushed as a system message at every ACP session entry point (new/load/fork + model switch) |
| 130 | and appended to the system prompt on the cloud and TUI-startup paths. |
| 131 | - **`src/chat.rs`** — the Unix-only ratatui TUI. Loading-spinner phase then chat; uses |
| 132 | `tokio::select!` to multiplex terminal events with streaming tokens. |
| 133 | - **`src/setup.rs`** — model cache location, local model discovery, selected-model persistence. |
| 134 | Must run (`setup_shared_model_cache`) *before* anything touches `ChatEngine`/`hf-hub`, since |
| 135 | those read env vars once at init. |
| 136 | - **`src/account.rs`** — siGit Code Cloud auth (`/login`, `/logout`, `/whoami`); authenticates |
| 137 | against the account API and stores a session token. Performs no console I/O. |
| 138 | - **`src/credentials.rs`** — local session-token store (TOML, `0600` on Unix). |
| 139 | - **`src/models.rs`** — model-picker types shared across platforms. |
| 140 | |
| 141 | Slash commands (`/help`, `/models`, `/skills`, `/mcp`, `/login`, `/logout`, `/whoami`, `/reload`, |
| 142 | `/plan`, `/permissions`, `/clear`, `/status`) are advertised via `advertise_commands` in `main.rs` |
| 143 | and handled in both the TUI and ACP sessions. |
| 144 | |
| 145 | ## Model cache (macOS) |
| 146 | |
| 147 | On macOS the HF model cache lives in an App Group container shared with the siGit desktop app: |
| 148 | `~/Library/Group Containers/group.com.ondeinference.apps/models/`. Other platforms fall back to |
| 149 | `~/.cache/huggingface/`. The CLI reuses a model the desktop app already downloaded. First run |
| 150 | downloads a GGUF model (~1–2 GB) from Hugging Face. |
| 151 | |
| 152 | ## Logging |
| 153 | |
| 154 | In TTY (interactive) mode, *all* output — `log`, `tracing`, stray `println!` — is redirected to |
| 155 | `$TMPDIR/sigit.log` so the ratatui surface stays clean; the TUI holds a separate fd to the real |
| 156 | terminal. In ACP mode, stdout is reserved for protocol JSON and logs go to stderr. Control |
| 157 | verbosity with `RUST_LOG`. |
| 158 | |
| 159 | ## Relevant env vars |
| 160 | |
| 161 | `OPENAI_BASE_URL` / `OPENAI_API_KEY` (provider override), `SIGIT_API_URL` (account API base, |
| 162 | default `https://sigit.si`), `SIGIT_CLOUD_URL`, `SIGIT_CONFIG_DIR` (default `~/.config/sigit`), |
| 163 | `SIGIT_MODEL`, `SIGIT_MCP` (`off` disables MCP), `SIGIT_MCP_OFFICIAL` (`off` drops the baked-in |
| 164 | server), `SIGIT_PERMISSIONS` (`allow`/`ask`/`deny` — overrides the default permission mode for |
| 165 | mutating tools; the escape hatch for clients without permission-request support), |
| 166 | `HF_HOME` / `HF_HUB_CACHE`, `RUST_LOG`. |
| 167 | |
| 168 | ## Releasing |
| 169 | |
| 170 | Version lives in `Cargo.toml`. The binary is published to five registries via separate workflows |
| 171 | (`release-crates`, `release-github`, `release-homebrew`, `release-npm`, `release-pypi`); the |
| 172 | `npm/` and `pypi/` dirs hold the wrapper-package templates. Update `CHANGELOG.md` for releases. |