README.md RawHistoryFolder

1<div align="center">
2  <a href="https://www.zot.sh">
3    <img src="internal/assets/zot-logo.png" alt="zot coding agent harness" width="130" height="130" />
4  </a>
5</div>
6<p align="center">
7  <a href="https://www.zot.sh">zot.sh</a>
8</p>
9
10## What is it?
11
12Yet another coding agent harness, lightweight and written (vibe-slopped) in go.
13
14- one static binary.
15- built-in providers for Anthropic, OpenAI/Codex/Responses, Kimi, DeepSeek, Google Gemini/Vertex, GitHub Copilot, Bedrock, Azure OpenAI, OpenRouter, Groq, Cerebras, xAI, Together, Hugging Face, Mistral, Moonshot, Z.AI, Xiaomi, MiniMax, Fireworks, Vercel AI Gateway, OpenCode, Cloudflare AI, and Ollama/local models.
16- four tools (read, write, edit, bash).
17- three run modes (interactive tui, print, json).
18- built-in telegram bot.
19- extensions in any language via subprocess + json-rpc. None installed by default; opt in with `zot ext install` or `zot --ext`. See [docs/extensions.md](docs/extensions.md).
20- reusable instructions via `SKILL.md` files; see [docs/skills.md](docs/skills.md).
21- no community atm.
22
23## Install
24
25### One-liner (macOS, Linux)
26
27```bash
28curl -fsSL https://www.zot.sh/install.sh | bash
29```
30
31Detects your OS and architecture, downloads the latest release from GitHub, verifies the SHA-256 against the release's `checksums.txt`, extracts the binary, and drops it in `/usr/local/bin`, `~/.local/bin`, or `~/bin`, whichever is writable first. Pass a version or prefix to pin:
32
33```bash
34curl -fsSL https://www.zot.sh/install.sh | bash -s -- v0.0.1 ~/bin
35```
36
37### One-liner (Windows, PowerShell)
38
39```powershell
40iwr -useb https://www.zot.sh/install.ps1 | iex
41```
42
43Drops `zot.exe` into `$HOME\bin` and adds it to the user PATH if missing. Open a fresh terminal afterwards.
44
45### go install
46
47```bash
48go install github.com/patriceckhart/zot/cmd/zot@latest
49```
50
51### From source
52
53```bash
54git clone https://github.com/patriceckhart/zot
55cd zot
56make build        # produces ./bin/zot
57make install      # into $GOPATH/bin
58```
59
60### Prebuilt binaries
61
62Every release on the [releases page](https://github.com/patriceckhart/zot/releases) ships archives for Linux, macOS, and Windows on amd64 and arm64 (except windows/arm64), plus a `checksums.txt` file. Download, verify, `chmod +x`, and drop on your `$PATH`.
63
64## Authenticate
65
66The easiest way is to just run `zot` and type `/login`. The TUI opens even without credentials and walks you through a browser-based login flow.
67
68### Credential lookup order
69
701. `--api-key` flag
712. provider-specific env var (`ANTHROPIC_API_KEY`, `OPENAI_API_KEY`, `KIMI_API_KEY`, `MOONSHOT_API_KEY`, `DEEPSEEK_API_KEY`, `GEMINI_API_KEY`, `GOOGLE_API_KEY`, `GROQ_API_KEY`, `OPENROUTER_API_KEY`, `MISTRAL_API_KEY`, `XAI_API_KEY`, `CEREBRAS_API_KEY`, `TOGETHER_API_KEY`, `HF_TOKEN`, `ZAI_API_KEY`, `XIAOMI_API_KEY`, `MINIMAX_API_KEY`, `FIREWORKS_API_KEY`, `AI_GATEWAY_API_KEY`, `COPILOT_GITHUB_TOKEN`, `GITHUB_COPILOT_TOKEN`, and others for provider-specific backends)
723. `$ZOT_HOME/auth.json` (API key or OAuth token; mode 0600)
73
74`$ZOT_HOME` defaults to:
75- macOS: `~/Library/Application Support/zot`
76- Linux: `$XDG_STATE_HOME/zot` or `~/.local/state/zot`
77- Windows: `%LOCALAPPDATA%\zot`
78
79### `/login` flow
80
81Run `zot` and type `/login`. Pick one of two methods:
82
83- **API key**: a small local web server starts on `127.0.0.1:<free-port>`, your browser opens a form, you pick a provider from the full API-key provider list, paste the key, and zot saves it to `auth.json` if accepted. Providers with a lightweight model-list endpoint are probed before saving; provider backends that need extra project/account env vars are saved directly.
84- **Subscription**: use your Claude Pro/Max, ChatGPT Plus/Pro, Kimi Code, or GitHub Copilot subscription. DeepSeek and Google Gemini do **not** have a subscription login path. For those, use the API-key flow.
85  - Anthropic and OpenAI pin the browser callback to fixed provider-specific ports (`localhost:53692` for Anthropic, `localhost:1455` for OpenAI) because those are the only ports their auth servers will redirect to.
86  - Anthropic uses the Claude Code OAuth flow. Messages go to `api.anthropic.com` with a bearer token and the Claude Code identity headers.
87  - OpenAI uses the Codex CLI OAuth flow. Messages go to `chatgpt.com/backend-api/codex/responses` with the `chatgpt-account-id` extracted from the returned id_token.
88  - Kimi uses the Kimi Code device-code OAuth flow. zot opens the verification URL, polls until you approve it in the browser, then sends messages to `api.kimi.com/coding/v1` with the Kimi Code identity headers.
89  - GitHub Copilot uses GitHub's device-code login flow. zot stores the GitHub access token and exchanges it for short-lived Copilot inference tokens on demand.
90
91> **Note on subscription login.** The OAuth client IDs used are the ones published in Anthropic's Claude Code CLI, OpenAI's Codex CLI, Kimi Code CLI, and GitHub Copilot's device-code flow. Reusing them from a third-party tool may be against their terms of service and may be revoked at any time. Use it at your own risk; the API-key flow is the safe default.
92
93### Token refresh
94
95OAuth access tokens are short-lived (Anthropic ~8h, OpenAI ~30d; Kimi and GitHub Copilot also use refresh/exchange flows). zot refreshes or exchanges them automatically:
96
97- At every credential lookup, zot checks the stored `expiry` and, if past it (with a 60s safety margin), hits the provider's `oauth/token` endpoint with the stored `refresh_token`, persists the new `access_token`, `refresh_token`, and `expiry` back to `auth.json`, and hands the fresh token to the client.
98- The telegram bridge additionally refreshes once per turn so a bot that runs for days keeps working without manual intervention.
99- If the refresh itself fails (the `refresh_token` was revoked, or the account was logged out everywhere), the error bubbles up to the caller: the TUI shows it in the status line, the bot replies with it in your DM. Run `/login` to get a fresh token pair.
100
101All data lives under `$ZOT_HOME`:
102
103```
104$ZOT_HOME/
105├── config.json         # last-used provider/model/theme, saved automatically
106├── auth.json           # api keys and oauth tokens (mode 0600)
107├── sessions/           # jsonl transcripts, one dir per cwd
108├── models-cache.json   # live /v1/models discovery cache (6h ttl)
109├── SYSTEM.md           # optional: replaces the default system prompt
110├── skills/             # optional: user SKILL.md files (opt in with --with-skills)
111├── extensions/         # installed extensions, one dir per extension
112└── logs/               # app log files
113```
114
115Drop a `SYSTEM.md` in `$ZOT_HOME` to replace the built-in identity and guidelines for every run. `--system-prompt` still wins per-invocation. Delete the file to revert to the default.
116
117## Changelog on update
118
119The first time you launch a newer zot binary, the TUI shows the GitHub release notes once in a dismissible overlay. Press any key to close. The version is recorded in `config.json`'s `last_changelog_shown` so the same release notes never reappear. Fresh installs don't see a changelog (no upgrade has happened yet). The fetch is best-effort: a network failure or a missing release page silently skips, with another attempt on the next launch.
120
121## Usage
122
123```bash
124zot                              # interactive tui
125zot "fix the failing test"       # tui, pre-filled prompt
126zot -p "list all go files"       # print final text, exit
127zot --json "refactor main.go"    # newline-delimited json events, exit
128zot --continue                   # resume the most recent session for this cwd
129zot --resume                     # pick a session to resume
130zot --list-models                # show supported models
131zot --help
132```
133
134## Flags
135
136| Flag | Description |
137|---|---|
138| `--provider <id>` | Pick the provider (for example `anthropic`, `openai`, `openai-codex`, `kimi`, `google`, `github-copilot`, `groq`, `openrouter`, `amazon-bedrock`, `ollama`; see Providers). |
139| `--model <id>` | Pick the model (see `--list-models`). |
140| `--api-key <key>` | Override the API key. |
141| `--base-url <url>` | Override the provider base URL (tests, self-hosted). |
142| `--system-prompt <text>` | Replace the default system prompt for this run (also overrides `$ZOT_HOME/SYSTEM.md`). |
143| `--append-system-prompt <text>` | Append text to the system prompt (repeatable). |
144| `--reasoning low\|medium\|high` | Enable reasoning on supported models. |
145| `-c`, `--continue` | Resume the latest session for this cwd. |
146| `-r`, `--resume` | Pick a session to resume. |
147| `--session <path>` | Resume a specific session file. |
148| `--no-session` | Don't read or write session files. |
149| `--cwd <path>` | Use `<path>` as the working directory. |
150| `--no-tools` | Disable all tools. |
151| `--tools <csv>` | Only enable the listed tools. |
152| `--max-steps <n>` | Cap agent loop iterations (default 50). |
153| `-e`, `--ext <path>` | Load an extension from `<path>` for this run (repeatable; wins against installed extensions of the same name). |
154| `--no-ext` | Skip extension discovery for this run. `--ext` still works on top, so `--no-ext --ext ./x` runs only `x`. |
155| `--with-skills` | Also load user-installed skills. Without this, only the built-in skills shipped in the binary are loaded. |
156| `--no-skill` | Disable all skills, including built-ins. No `skill` tool is registered and the system prompt has no skill manifest. |
157| `--no-yolo` | Confirm every tool call before it runs (interactive TUI only). A dialog shows the tool name and a one-line preview of its args with four choices: yes, yes-always-this-tool-this-session, yes-always-this-session, no. Ignored with a stderr warning in print / json / rpc modes, where tools still run freely so scripts and automation keep working. |
158
159## Tools
160
161- `read`: read text files, or inline images (PNG, JPEG, GIF, WebP).
162- `write`: create or overwrite files, making parent directories as needed.
163- `edit`: one or more exact-match replacements in an existing file.
164- `bash`: run a shell command in the session cwd, with merged stdout/stderr and a timeout.
165
166When the sandbox is on (see `/jail`), all four tools refuse paths outside the session cwd.
167
168## Modes
169
170- **Interactive** (default): chat TUI with streaming output, spinner, cost meter, slash commands.
171- **Print**: `zot -p "prompt"` runs the agent to completion and writes only the final assistant text to stdout.
172- **JSON**: `zot --json "prompt"` emits one JSON object per agent event to stdout, newline-delimited. The schema is documented in [docs/rpc.md](docs/rpc.md).
173- **RPC**: `zot rpc` runs as a long-lived child process; commands in on stdin, events and responses out on stdout, both as NDJSON. Designed for embedding zot in third-party apps written in any language. See [docs/rpc.md](docs/rpc.md) for the wire schema and `examples/rpc/{python,node,shell,go}` for working clients.
174
175## Embedding
176
177Two ways to drive zot from another program:
178
179- **Go in-process**: import `github.com/patriceckhart/zot/pkg/zotcore`. One `Runtime` per project; `Prompt(ctx, text, images)` returns a channel of `Event`. Small example in `examples/sdk/`.
180- **Any language, out-of-process**: spawn `zot rpc` as a subprocess and exchange newline-delimited JSON over its stdin/stdout. Wire format and event schema in [docs/rpc.md](docs/rpc.md). Reference clients live under `examples/rpc/`.
181
182Both interfaces share the same event schema, so transcripts captured by one can be replayed through the other.
183
184## Slash commands
185
186Type `/` in the TUI to open the autocomplete popup. Available commands:
187
188| Command | Description |
189|---|---|
190| `/help` | Show key bindings and commands. |
191| `/login` | Log in via API key or subscription (opens a dialog). |
192| `/logout [provider]` | Clear credentials for any logged-in provider, or all when omitted. `/logout openai-codex` clears ChatGPT/Codex subscription auth while preserving a public OpenAI API key; `/logout kimi` also disables fallback to the official Kimi Code CLI token until you log in to Kimi through zot again. |
193| `/model` | Pick a model from a list (or `/model <id>` to set directly). |
194| `/sessions` | Resume a previous session for this directory. |
195| `/session` | Four ops on the current session: `export` to a portable `.zotsession` file, `import` one back in, `fork` from a past user message into a new branch, `tree` to switch between branches. Opens a picker without an argument; direct forms: `/session export [path]`, `/session import <path>`, `/session fork`, `/session tree`. Default export destination is `~/Downloads`. |
196| `/jump` | Scroll the chat to a previous turn (or `/jump <text>` to filter). |
197| `/btw` | Side chat with full context that doesn't add to the main thread. |
198| `/swarm` | Spawn, monitor, and chat with background subagents. Each runs in parallel with your main session and shares its working directory. |
199| `/skills` | List discovered skills (SKILL.md files) and preview their bodies. |
200| `/compact` | Summarize the transcript into one message to free up context. |
201| `/study` | Run the canned prompt "Read and understand everything in the current directory." so the agent has full project context before you start asking targeted questions. Pass a path — typed, drag-dropped, or selected via `@` — to target a specific file or directory instead: `/study [dir:internal/]`, `/study cmd/zot/main.go`. |
202| `/jail` | Confine tools to the current directory. |
203| `/unjail` | Allow tools to touch paths outside again. |
204| `/reload-ext` | Hot-reload all extensions (re-read manifests, respawn subprocesses, rebuild tool registry). |
205| `/telegram` | Connect, disconnect, or show status of the Telegram bridge (takes `connect` / `disconnect` / `status` as an optional argument; opens a picker without one). When connected, DMs from the paired user become prompts in the running session and the assistant's replies are mirrored back to Telegram. Alias: `/tg`. |
206| `/clear` | Clear the chat transcript. |
207| `/exit` | Exit zot. |
208
209Extension-registered commands appear under a divider at the bottom of the popup, sorted by name.
210
211### `/sessions`
212
213Shows previous sessions for the current working directory, newest first, with timestamp, model, message count, cost, and the first user prompt. Pick one with `up`/`down`, `enter` to resume, `esc` to cancel. zot swaps the current session file for the selected one and replays the full transcript (including tool calls) into the agent. Sessions remember the model they ended on, so resuming picks up on that exact model even if your global default changed.
214
215### `/session`
216
217Four ops on the current session. `/session` alone opens a picker; each is also runnable directly.
218
219- **`/session export [path]`**. Writes the running transcript to a portable `.zotsession` file. Default destination is `~/Downloads/<timestamp>-<session-id>-<prompt-slug>.zotsession`. Pass a path to override; a directory is fine (a dated name is built inside), a bare name gets `.zotsession` appended. The meta's cwd is stripped on the way out so the recipient doesn't see your filesystem layout.
220
221  **What's included.** Only the main chat thread of the running session — messages, tool calls, tool results, compactions, and usage. **`/swarm` subagents are NOT included.** Their transcripts, unix-socket inboxes, and per-agent session files are all machine-local; a `.zotsession` is just a chat transcript and has no way to revive a unix socket on another box. If you want the conversation, copy it out of the dashboard manually.
222- **`/session import <path>`**. Copies a `.zotsession` file into `$ZOT_HOME/sessions/<cwd-hash>/` with a fresh id and the current cwd, then switches the running agent onto it. Imported sessions are first-class: they show up in `/sessions`, `/jump`, and the tree. Drag-drop paths in the editor are accepted (zot strips the surrounding quotes automatically).
223- **`/session fork`**. Opens a turn picker (same shape as `/jump`). Pick any past user message; zot copies every message up to and including that turn into a new session, records `parent` + `fork_point` in the new meta, and switches onto the branch. The parent session stays on disk. Use it to try a different question without polluting the original transcript, or to rewind after the agent went down the wrong path.
224- **`/session tree`**. Shows every session in the current cwd arranged by parent/child relationships, depth-first with indent per level. The current session is tagged `[current]`. Pick any entry to switch into it. Parentless sessions are roots; branches created via `/session fork` nest under whichever session they were forked from. Orphaned children (whose parent file was deleted) still show as roots so they stay discoverable.
225
226### `/jump`
227
228Opens a turn picker for the current session, one row per user prompt, each showing the turn number, how many tools that turn invoked, and the first line of the prompt. `up`/`down` to pick, `enter` to jump, `esc` to cancel. Any printable rune while the picker is open extends a filter; backspace narrows it back. `/jump <text>` pre-applies the filter; if exactly one turn matches, zot jumps straight there without showing the picker.
229
230Jumping is non-destructive. The transcript is untouched, the viewport just scrolls so the chosen turn is at the top. A muted line at the top of the chat reads `viewing turn N of M, pgdn to catch up`. Scroll back to the bottom with `pgdn` (or keep scrolling with the arrow keys) and the indicator goes away.
231
232### `/btw`
233
234Opens a side-chat overlay with the full main session as frozen context, so you can ask quick clarifying questions ("does asyncio.gather() catch exceptions?", "btw the bundle budget is 10MB", "what's the default fetch timeout?") without bloating the main thread.
235
236Each question fires a one-off model call against `system + main transcript + side-chat history so far`. Responses render in the overlay and stay there. When you press `esc` to close, **nothing** has been added to the main session and subsequent main-thread turns don't re-read any of the side-chat exchanges, keeping the running context window lean.
237
238```
239/btw                              # open the overlay, type questions interactively
240/btw does PUT replace the whole resource?
241```
242
243Inside the overlay: `enter` sends, `esc` cancels an in-flight call (or closes the overlay if idle), `ctrl+c` closes immediately. Side-chat exchanges never touch the transcript and aren't persisted to the session file.
244
245### `/swarm`
246
247Background subagents that run alongside your main session. Each one is a separate `zot` subprocess with its own model loop, its own persistent session file, and its own chat in the dashboard — but they all run in **the same working directory as the host**, so they see and edit the same files you do. Spawn one for a side task (“draft the migration”, “investigate this stack trace”, “write the test harness for module X”), keep going in the main thread, check in on it whenever you want.
248
249> **Agents edit the same files you do.** They use the same `read` / `write` / `edit` / `bash` tools as the main agent against the host's working directory. There's no per-agent worktree or branch. If you need parallel edits on isolated checkouts, set that up yourself with `git worktree` outside zot.
250
251```
252/swarm                            # open the dashboard
253/swarm new <task>                 # spawn an agent
254/swarm new --model gpt-5 <task>    # pin the new agent to a specific model
255/swarm logs <id>                  # jump straight into one agent's transcript
256/swarm send <id> <text>           # send a follow-up without opening the dashboard
257/swarm resume                     # pick a stopped agent to bring back
258/swarm resume <id>                # bring a specific agent back
259/swarm kill <id>                  # stop a running agent (its state stays)
260/swarm remove <id>                # delete the agent's session and state
261/swarm list                       # alias for opening the dashboard
262```
263
264**Dashboard (`/swarm` with no arg)** — a list of every agent for the current session, with status, age, and current activity. Keys:
265
266| Key | Action |
267|---|---|
268| `↑` / `↓` | Move cursor between rows. |
269| `enter` | Open the highlighted agent's transcript view. |
270| `n` | Spawn a new agent (opens an inline task editor; inherits the host's current model). |
271| `p` | One-off prompt editor for the selected row (without entering the transcript). |
272| `R` | Resume a stopped agent in place. |
273| `k` | Kill the selected running agent. Its session and state stay so you can resume it later. |
274| `r` | Remove the selected agent entirely (session + meta gone). |
275| `esc` | Close the dashboard. |
276
277**Inside an agent's transcript** — a chat overlay with an always-on inline composer at the bottom. The conversation flows above it; type and `enter` to send a follow-up. The view auto-follows streaming output and shows an inline spinner with the agent's current activity (`thinking`, `tool: edit_file`, etc.) while it's busy. `esc` returns to the dashboard.
278
279**Switching the spawn model from inside the editor** — while composing a task in the `n`-prompt, type `/model` on its own line and `enter`. The standard `/model` picker pops up; pick a model, the picker closes, and the editor reopens with your typed task intact and the new model pinned for the spawn.
280
281**Session scoping** — each agent is stamped with the host session that spawned it and only shows up in that session's dashboard. Swap sessions with `/sessions` and the dashboard re-narrows accordingly. Agents from other sessions keep running in the background and reappear when you switch back.
282
283**Persistence across zot restarts** — every spawn writes a `meta.json` next to its event log and session file under `$ZOT_HOME/swarm/agents/<id>/`. On the next `zot` launch they show up in the dashboard as **detached**; press `R` (or `/swarm resume <id>`) to bring one back. Resumed agents reattach to the same session and inbox socket, so the conversation continues from where it left off.
284
285**Where state lives** — everything per-agent (session file, events log, inbox socket, meta) lives under `$ZOT_HOME/swarm/agents/<id>/`. The agent's actual code edits land directly in your repo; track them with normal `git status` / `git diff`.
286
287**`/session export` does NOT bundle subagents.** A `.zotsession` is just the main chat transcript; per-agent state (session file, unix-socket inbox) is machine-local and doesn't round-trip through a JSONL file. To share what an agent said, copy it out of the transcript view manually.
288
289### `/skills`
290
291Opens a picker listing every discovered SKILL.md file, built-ins hidden. Each row shows the skill name, source, and description. `enter` opens the body inline (scrollable with `up`/`down`/`pgup`/`pgdn`); `esc` goes back. Re-runs discovery each time it opens, so edits to a SKILL.md during a session are reflected immediately.
292
293### `/compact`
294
295Sends the current transcript through the model with a structured summarization prompt. The returned summary replaces the transcript as one synthetic user message, with the last few exchanges kept verbatim for continuity. The status bar's context meter resets. Use it when the context meter creeps past ~80%.
296
297zot also auto-compacts in the background: after any turn that leaves context usage at or above **85%** of the model's window, the agent kicks off a condense pass on its own. You'll see `condensing history, esc to cancel` above the status bar and an `(auto)` tag next to the context percentage; `esc` aborts it without touching the transcript.
298
299### `/jail`
300
301Enforces a sandbox rooted at the cwd shown in the status bar. `read`, `write`, and `edit` resolve their target path (including through symlinks) and refuse anything outside the sandbox. `bash` refuses obvious escape patterns: `sudo`, `rm -rf /`, leading `cd /`, `cd ..`, `cd ~`, `chmod -R`, `dd of=/`, and similar. The status bar shows `jailed, ~/your/cwd` while active.
302
303This is a guardrail against accidents, not a hard security boundary. If you need real isolation, run zot under docker or a proper sandbox.
304
305## Sessions
306
307Every interactive or print/json run (unless `--no-session`) writes a JSONL transcript under `$ZOT_HOME/sessions/<cwd-hash>/`. Resume any of them with `--continue`, `--resume`, `--session <path>`, or interactively via `/sessions` inside the TUI. Empty sessions (the user exited without prompting) are deleted on close so the list stays tidy.
308
309## Providers
310
311zot's built-in provider catalog includes:
312
313- **Subscription-capable**: Anthropic Claude Pro/Max (`anthropic`), OpenAI Codex / ChatGPT Plus/Pro (`openai-codex`), Kimi Code (`kimi`), GitHub Copilot (`github-copilot`).
314- **Direct API providers**: Anthropic, OpenAI Chat Completions, OpenAI Responses, DeepSeek, Google Gemini, Kimi/Moonshot, Moonshot CN, Groq, Cerebras, xAI, Together AI, Hugging Face Router, OpenRouter, Mistral, Z.AI, Xiaomi/MiMo token-plan regions, MiniMax global/CN, Fireworks, Vercel AI Gateway, OpenCode/OpenCode Go.
315- **Cloud/platform providers**: Amazon Bedrock, Google Vertex AI, Azure OpenAI, Cloudflare Workers AI, Cloudflare AI Gateway.
316- **Local/compatible**: Ollama and OpenAI-compatible local endpoints via `--base-url`.
317
318Use `/login` to store API keys or subscription credentials. `/model` only shows models from providers that are currently available from env vars, `auth.json`, Kimi CLI fallback, or local Ollama.
319
320## Models
321
322`--list-models` or the `/model` picker shows the full catalog across all built-in providers. Three sources:
323
324- **Catalog**: models baked into zot, covering Claude, GPT/Codex, Gemini/Gemma, Kimi/Moonshot, DeepSeek, Groq-hosted Llama/Gemma/Compound, OpenRouter-routed models, Bedrock model ids, Vertex model ids, Azure OpenAI deployments, Copilot models, and other provider-specific catalog entries.
325- **Live**: IDs discovered from `GET /v1/models` using your stored API key (cached for 6h in `$ZOT_HOME/models-cache.json`, refreshed in the background on startup).
326- **Speculative**: IDs that appear in the upstream generator but aren't live on the public API yet. They'll 404 today and start working the moment the provider ships them.
327
328The context meter in the status line uses the model's advertised context window to show how much of it your last turn consumed.
329
330### Model fallback (rescue)
331
332When a turn fails because of a recoverable provider error — expired token (`401`), permission denied (`403`), rate limit (`429`), provider outage (`502`/`503`/`504`), or a transient network failure — zot opens a **rescue** picker over the chat instead of just painting a red banner.
333
334The picker is the same vertical list / fuzzy filter UI as `/model`, but it only shows models from providers you're currently logged in to (env vars, `auth.json`, Kimi CLI fallback, ollama). The failed model is excluded. Press `↑`/`↓` to choose, `enter` to retry the **same prompt** on the new model, `esc` to dismiss.
335
336Before the actual provider request fires, the OpenAI / Anthropic / Kimi / DeepSeek / Google / OpenAI-Codex clients also do up to two silent retries with short backoff (250ms, 750ms) on `502`/`503`/`504` and connection-reset / EOF-before-headers errors. Most edge-proxy blips disappear without you ever seeing the rescue picker.
337
338A rescue retry always **drops launch-time `--api-key` and `--base-url`** before rebuilding the agent. Those overrides are usually the reason the rescue triggered (bad key, typo'd base URL, corporate gateway only valid for the originally-picked provider), so the retry re-resolves credentials from env vars / `auth.json` / provider defaults instead. Use `/model` if you want overrides to stick.
339
340No configuration is required — the candidate list is built dynamically from your active credentials. Bad-request / context-length / serialization errors are NOT routed to the rescue picker, because switching models won't fix them; those still surface as a normal error.
341
342### Custom models
343
344Place a `models.json` in `$ZOT_HOME` (macOS: `~/Library/Application Support/zot/`, Linux: `~/.local/state/zot/`) to add models that aren't in the baked-in catalog or to override existing entries:
345
346```json
347{
348  "providers": {
349    "openai": {
350      "models": [
351        {
352          "id": "gpt-5.5",
353          "name": "GPT-5.5",
354          "reasoning": true,
355          "contextWindow": 400000,
356          "maxTokens": 128000
357        }
358      ]
359    }
360  }
361}
362```
363
364Supported fields per model: `id` (required), `name`, `reasoning`, `contextWindow`, `maxTokens`, `baseUrl`, `priceInput`, `priceOutput`, `priceCacheRead`, `priceCacheWrite`.
365
366Provider keys are normalized: `openai-codex` and `openai-responses` map to `openai`, `anthropic-messages` maps to `anthropic`, `moonshot`, `moonshot-ai`, and `kimi-code` map to `kimi`, and `deepseek-chat` and `deepseek-ai` map to `deepseek`. Built-in provider ids such as `groq`, `openrouter`, `github-copilot`, `amazon-bedrock`, `google-vertex`, `azure-openai-responses`, `fireworks`, `vercel-ai-gateway`, `mistral`, and `xai` can also be used directly.
367
368User-defined models show `source: user` in `--list-models` and take precedence over both the baked-in catalog and live-discovered models. Missing or invalid files are silently ignored.
369
370### Kimi Code
371
372zot has built-in Kimi support through Kimi's OpenAI-compatible chat API.
373
374```bash
375zot --provider kimi
376```
377
378By default this uses:
379
380- model: `kimi-for-coding`
381- base URL: `https://api.kimi.com/coding/v1`
382
383Credential lookup order for Kimi:
384
3851. `--api-key`
3862. `KIMI_API_KEY`
3873. `MOONSHOT_API_KEY`
3884. `$ZOT_HOME/auth.json`
3895. the official Kimi Code CLI token at `~/.kimi/credentials/kimi-code.json`, unless disabled by `/logout kimi`
390
391Use `/login` for either API-key login or Kimi Code subscription login. The subscription flow uses Kimi Code's device-code OAuth flow: zot opens the verification URL, waits for browser approval, stores the token in `auth.json`, and refreshes it automatically.
392
393For direct Moonshot API keys or a custom compatible endpoint:
394
395```bash
396zot --provider kimi --model kimi-k2-0905-preview --base-url https://api.moonshot.ai/v1 --api-key "$KIMI_API_KEY"
397```
398
399You can add additional Kimi/Moonshot model IDs to `models.json` under the `kimi` provider.
400
401### DeepSeek
402
403zot has built-in DeepSeek support through DeepSeek's OpenAI-compatible chat API.
404
405```bash
406zot --provider deepseek
407```
408
409By default this uses:
410
411- model: `deepseek-v4-pro`
412- base URL: `https://api.deepseek.com/v1`
413
414Catalog ships with `deepseek-v4-pro` (reasoning) and `deepseek-v4-flash`. These are exactly the IDs returned by `GET https://api.deepseek.com/models` today. You can add additional model IDs to `models.json` under the `deepseek` provider.
415
416Credential lookup order for DeepSeek:
417
4181. `--api-key`
4192. `DEEPSEEK_API_KEY`
4203. `$ZOT_HOME/auth.json`
421
422Use `/login` and pick **api key** to paste a DeepSeek key. zot probes `/v1/models` once and stores the key under `deepseek` in `auth.json`.
423
424> **Auth model: API key only.** DeepSeek does not offer a subscription OAuth flow. The `/login subscription` step lists only Anthropic, OpenAI, and Kimi; DeepSeek shows up only under `/login → api key`.
425
426> **Text only at the wire level.** DeepSeek's chat-completions endpoint currently rejects the multimodal content schema (`unknown variant image_url, expected text`). When the active provider is `deepseek`, zot silently drops `ImageBlock` parts from outgoing user/tool messages and keeps only the text. Switching back to a vision-capable model (Claude, GPT-4o/5, Gemini) re-sends the image normally because the session file still stores it.
427
428For a custom-compatible endpoint (mirror, gateway, self-host):
429
430```bash
431zot --provider deepseek --base-url https://my-deepseek-mirror.example.com/v1 --api-key "$DEEPSEEK_API_KEY"
432```
433
434### Google Gemini
435
436zot has built-in Google Gemini support through the [AI Studio Generative Language API](https://aistudio.google.com/).
437
438```bash
439zot --provider google
440```
441
442By default this uses:
443
444- model: `gemini-2.5-pro`
445- base URL: `https://generativelanguage.googleapis.com`
446
447Catalog ships with `gemini-2.5-pro`, `gemini-2.5-flash`, `gemini-2.5-flash-lite`, `gemini-2.0-flash`, and `gemini-2.0-flash-lite`. Live discovery against `/v1beta/models` adds anything else your key can see.
448
449Credential lookup order for Google:
450
4511. `--api-key`
4522. `GEMINI_API_KEY`
4533. `GOOGLE_API_KEY`
4544. `$ZOT_HOME/auth.json`
455
456Use `/login` and pick **api key** to paste an AI Studio key. zot probes `/v1beta/models` once and stores the key under `google` in `auth.json`.
457
458> **Auth model: API key only.** Google does not issue OAuth tokens for consumer Gemini Advanced / Google One AI Premium subscriptions, so there is no "log in with your Google subscription" flow. Programmatic access requires either an AI Studio API key (this provider) or a Vertex AI / GCP service-account credential (not yet wired up in zot). The `/login subscription` step quietly downgrades to the api-key form when you pick Google so you don't end up in a dead end.
459
460> **Free-tier rate limits.** AI Studio's free tier has tight per-minute and per-day caps that vary by model: `gemini-2.5-pro` is the strictest (a few requests per minute, ~50 per day), Flash and Flash-Lite are far more generous. If a Pro turn 429s with `"You exceeded your current quota"` while Flash on the same key still works, you've hit the Pro free-tier RPD. Either switch to Flash for agent loops, or [enable billing](https://aistudio.google.com/app/apikey) on your AI Studio project to flip the same key from free to pay-as-you-go pricing (`$1.25/M` input, `$10/M` output for Pro).
461
462Reasoning levels (`--reasoning low|medium|high`) map differently per generation: 2.5 family uses `thinkingBudget` token budgets per model (Pro caps at 32k, Flash at 24k); Gemini 3.x uses the `thinkingLevel` enum (`MINIMAL`/`LOW`/`MEDIUM`/`HIGH`), with Gemini-3-Pro pinned to `LOW` minimum and `HIGH` for any "medium" or "high" request. 2.0-family models have no thinking config at all.
463
464You can add additional Gemini model IDs to `models.json` under the `google` provider.
465
466### Local models with ollama
467
468zot works with [ollama](https://ollama.com) out of the box. Ollama serves an OpenAI-compatible API locally, so any model you have pulled works with zot.
469
470Quick start:
471
472```bash
473ollama pull qwen3.5:4b
474zot --provider ollama --model qwen3.5:4b
475```
476
477That's it. No API key needed for local models. zot defaults to `http://localhost:11434`.
478
479For a remote ollama instance or one behind auth:
480
481```bash
482zot --provider ollama --model llama3 --base-url https://my-server.com/v1 --api-key my-token
483```
484
485You can also add models to your `models.json` so you don't need flags every time:
486
487```json
488{
489  "providers": {
490    "ollama": {
491      "models": [
492        {
493          "id": "qwen3.5:4b",
494          "name": "Qwen 3.5 4B",
495          "contextWindow": 32768,
496          "maxTokens": 8192
497        }
498      ]
499    }
500  }
501}
502```
503
504The `ollama` provider uses the OpenAI chat completions protocol internally, so it also works with any OpenAI-compatible server (vLLM, LM Studio, LocalAI, etc.).
505
506## Inline images
507
508When a tool returns an image (for example `read` on a PNG), zot renders it inline on terminals that support it: **Ghostty**, **Kitty**, **iTerm2**, **WezTerm**. On other terminals you see a text placeholder with MIME type, pixel dimensions, and byte size. Control with the `ZOT_INLINE_IMAGES` env var:
509
510| Value | Effect |
511|---|---|
512| unset (default) | Auto-detect based on `TERM_PROGRAM`. |
513| `iterm`, `iterm2` | Force the iTerm2 OSC 1337 protocol. |
514| `kitty` | Force the Kitty graphics protocol. |
515| `off`, `none` | Always use the text placeholder. |
516
517Frames containing images are full-repainted (no differential diff) to prevent stale image pixels from lingering through scroll. That costs one terminal flash per image-containing frame; set `ZOT_INLINE_IMAGES=off` if that bothers you.
518
519## Queued messages
520
521You can keep typing while the agent is working. Pressing `enter` during a turn queues the message instead of interrupting: it shows up above the status bar as `sliding in: <text>` and is delivered as the next user turn the moment the current one finishes. Queue as many as you want; they run in order. `esc` cancels the active turn and drops the queue so a runaway turn doesn't flood you with stale follow-ups; `ctrl+c` while busy arms the exit hint instead of interrupting, a second `ctrl+c` within two seconds exits zot.
522
523To recover the most recently queued message back into the editor (to tweak it before it runs), press `Option+↑`. In VS Code's integrated terminal that chord doesn't survive xterm.js's macOS key handling — use `Option+Shift+↑` there. zot's hint line under the sliding-in queue adapts automatically based on `$TERM_PROGRAM`.
524
525Slash commands also work while the agent is busy. Read-only ones (`/help`, `/jump`, `/btw`, `/sessions`, `/skills`, `/jail`, `/unjail`, `/exit`) take effect immediately. Destructive ones (`/clear`, `/compact`, `/login`, `/logout`, `/model`, `/reload-ext`) cancel the active turn first and then run.
526
527
528## Keys (interactive mode)
529
530### Input
531
532| Key | Action |
533|---|---|
534| `enter` | Submit (queued if the agent is busy). |
535| `alt+enter` | Newline. |
536| `tab` | Complete the selected slash command. |
537| `esc` | Cancel the current turn (while busy); clear input (while idle). |
538| `ctrl+c` | Clear the input and queue (while idle) or arm the exit hint (while busy). Press again within 2s to exit. Use `esc` to cancel a running turn. |
539| `ctrl+d` | Exit on empty input. |
540| `ctrl+l` | Redraw the screen. |
541| `ctrl+o` | Expand or collapse long tool results (read, write, edit, bash outputs over ~12 lines). |
542| `@` | Open the file picker. Browse files and directories in the working directory. |
543
544### File picker (`@`)
545
546| Key | Action |
547|---|---|
548| `@` | Open the file picker (type after a space or at the start of input). |
549| `up`, `down` | Navigate the file list. |
550| `right` | Open the selected directory. |
551| `left` | Go back to the parent directory. |
552| `enter` | Select the file or directory and insert it as a chip (`[file:name]` or `[dir:name/]`). |
553| `esc` | Close the file picker. |
554
555Type `@` followed by a filter string to narrow the list (e.g. `@read` shows only entries containing "read"). Selected files are inserted as compact chips that expand to the full path on submit. Dragged-and-dropped files and directories also collapse to chips automatically.
556
557### Editor line navigation
558
559| Key | Action |
560|---|---|
561| `ctrl+a`, `ctrl+e` | Jump to start or end of line. |
562| `alt+left`, `alt+right` | Jump one word back or forward. |
563| `ctrl+u`, `ctrl+k` | Delete to start or end of line. |
564| `ctrl+w`, `alt+backspace` | Delete the previous word. |
565| `up`, `down` (editor non-empty) | Cycle through prompt history. |
566
567### Chat scroll
568
569| Key | Action |
570|---|---|
571| `pgup`, `pgdn` | Scroll one page up or down. |
572| `up`, `down` (editor empty) | Scroll three lines up or down. This is how the mouse wheel reaches the scroll logic on most terminals. |
573
574## Extensions
575
576zot can be extended in any language via a subprocess + JSON-RPC protocol. Extensions can register slash commands, expose tools to the model, intercept tool calls (block or rewrite args), gate whole turns before the model is called, and rewrite the assistant's visible text before it reaches the user. None are installed by default; opt in explicitly. Hot-reload any time with `/reload-ext`.
577
578### Install and manage
579
580```bash
581zot ext install <path|git-url>   # copy / clone into $ZOT_HOME/extensions/
582zot ext list                      # show installed extensions
583zot ext logs <name> [-f]          # cat or tail the extension's stderr log
584zot ext enable <name>             # re-enable a disabled extension
585zot ext disable <name>            # disable without removing
586zot ext remove <name>             # delete an extension directory
587```
588
589For development, point `zot --ext <path>` at a working directory and skip the install step entirely. Repeatable; takes precedence over installed extensions of the same name.
590
591### Reference
592
593`examples/extensions/` ships reference implementations in Go, TypeScript, Node, and shell. See [docs/extensions.md](docs/extensions.md) for the full protocol, the SDK API (`pkg/zotext`), and the phase roadmap.
594
595## Skills
596
597A skill is a per-folder `SKILL.md` file with a YAML frontmatter header. zot discovers skills at startup, surfaces their names in the system prompt, and exposes a built-in `skill` tool the model uses to load the body on demand.
598
599By default only the built-in skills shipped with the zot binary are loaded. Pass `--with-skills` to also load user-installed skills from:
600
601- `./.zot/skills/<name>/SKILL.md` (project)
602- `$ZOT_HOME/skills/<name>/SKILL.md` (global)
603- `./.claude/skills/<name>/SKILL.md`, `~/.claude/skills/<name>/SKILL.md` (Claude-compatible layout)
604- `./.agents/skills/<name>/SKILL.md`, `~/.agents/skills/<name>/SKILL.md` (agent-compatible layout)
605
606See [docs/skills.md](docs/skills.md) for the frontmatter fields, authoring tips, and example skills under `examples/skills/`.
607
608## Telegram bot (bridge)
609
610zot can run as a telegram bot so you can DM it from your phone. Two ways to run it: **from inside the TUI** (the running session mirrors into Telegram) or **as a standalone background daemon** (a headless bot with its own independent agent).
611
612### From inside the TUI
613
614Type `/telegram` in the running TUI to open a picker with **connect**, **disconnect**, and **status**. When connected:
615
616- DMs from the paired user become prompts in the **same** session you're typing in, so you can continue a conversation from the terminal on your phone and back again.
617- Messages you type in the TUI are mirrored into the Telegram thread prefixed `you: ...` and the assistant's replies come back prefixed `zot: ...`, so the Telegram chat stays a complete record of both sides of the conversation.
618- Messages sent from Telegram show up as your own bubble in Telegram (no mirror) and the assistant's reply to them comes back bare (no prefix).
619- The status bar shows a `- tg -` tag while the bridge is active.
620- `/telegram connect` / `/telegram disconnect` / `/telegram status` (or `/tg`) also work as direct commands without the picker.
621
622The in-TUI bridge refuses to start while the standalone daemon (below) is running, since two concurrent long-poll consumers of the same bot race on every update and silently drop messages.
623
624### Standalone daemon
625
626For headless servers or long-running bots unattached to a TUI:
627
628```bash
629zot telegram-bot setup     # paste a BotFather token, verify, save
630zot telegram-bot run       # foreground: long-poll in this terminal (ctrl+c to stop)
631zot telegram-bot start     # background: detach and return immediately
632zot telegram-bot stop      # SIGTERM the background bot (SIGKILL after 5s)
633zot telegram-bot logs -f   # tail $ZOT_HOME/logs/bot.log (omit -f to just cat)
634zot telegram-bot status    # config (token masked) + running/stopped
635zot telegram-bot reset     # forget the token and paired user
636# short alias: `zot tg ...` is accepted for every subcommand
637```
638
639The background flavor writes the child's PID to `$ZOT_HOME/bot.pid` and redirects stdout and stderr to `$ZOT_HOME/logs/bot.log`. `zot telegram-bot stop` reads that PID, sends SIGTERM, waits up to five seconds, then escalates to SIGKILL if the child is still alive. Running two instances at once is refused at startup.
640
641> **Use the installed binary for `start`.** `go run ./cmd/zot telegram-bot start` won't work. `go run` builds a binary in a temp directory and deletes it when it exits, which kills the detached child. Run `make install` (or `go build`) first and invoke the installed binary.
642
643Setup flow:
644
6451. Talk to [@BotFather](https://t.me/BotFather) on telegram, run `/newbot`, copy the token it gives you.
6462. Run `zot telegram-bot setup` and paste the token when prompted.
6473. Run `zot telegram-bot run` in the directory you want the agent to operate in.
6484. Open your bot on telegram, send `/start`. The first user to do this claims the bridge (stored as `allowed_user_id`); every other user is rejected.
649
650From then on, any DM you send is forwarded to the agent as a user prompt. Attached photos or `image/*` documents are downloaded and passed to vision-capable models. In-bot telegram commands: `/help`, `/status`, `/stop` (cancel the current turn). Config lives in `$ZOT_HOME/bot.json` (mode 0600).
651
652Bot mode respects the usual zot flags: `--provider`, `--model`, `--cwd`, `--reasoning`, `--continue`, `--no-session`, `--no-tools`, and so on. Run `zot tg run -c --model claude-opus-4-1` to resume the latest session on Opus, for example.
653
654## Development
655
656```bash
657make build     # build ./bin/zot
658make test      # go test -race ./...
659make lint      # go vet + gofmt check
660make fmt       # gofmt -w .
661make release   # cross-compile linux/darwin/windows on amd64 and arm64
662```
663
664Source layout:
665
666```
667cmd/zot/                      main()
668internal/agent/               cli wiring, arg parsing, system prompt, config
669internal/agent/extensions/    extension subprocess manager
670internal/agent/modes/         interactive tui, print, json, dialogs
671internal/agent/tools/         read, write, edit, bash, sandbox
672internal/auth/                credential store, api-key probe, oauth, login server
673internal/core/                agent loop, sessions, cost tracking
674internal/extproto/            extension wire-format types
675internal/provider/            anthropic + openai-compatible streaming clients, model catalog
676internal/skills/              skill discovery, frontmatter parser, skill tool
677internal/tui/                 terminal raw-mode, input parser, editor, renderer, markdown, view
678pkg/zotcore/                  public Go SDK for embedding zot in-process
679pkg/zotext/                   public Go SDK for writing extensions
680```
681
682## License
683
684MIT