1<img src="internal/assets/zot-logo.png" alt="zot" width="130" height="130" />
2
3# zot
4
5Yet another coding agent harness, lightweight and written (vibe-slopped) in go.
6
7- one static binary.
8- two providers atm (anthropic, openai/codex).
9- four tools (read, write, edit, bash).
10- three run modes (interactive tui, print, json).
11- built-in telegram bot.
12- 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).
13- reusable instructions via `SKILL.md` files; see [docs/skills.md](docs/skills.md).
14- no community atm.
15
16## Install
17
18### One-liner (macOS, Linux)
19
20```bash
21curl -fsSL https://zot.patriceckhart.com/install.sh | bash
22```
23
24Detects 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:
25
26```bash
27curl -fsSL https://zot.patriceckhart.com/install.sh | bash -s -- v0.0.1 ~/bin
28```
29
30### One-liner (Windows, PowerShell)
31
32```powershell
33iwr -useb https://zot.patriceckhart.com/install.ps1 | iex
34```
35
36Drops `zot.exe` into `$HOME\bin` and adds it to the user PATH if missing. Open a fresh terminal afterwards.
37
38### go install
39
40```bash
41go install github.com/patriceckhart/zot/cmd/zot@latest
42```
43
44### From source
45
46```bash
47git clone https://github.com/patriceckhart/zot
48cd zot
49make build        # produces ./bin/zot
50make install      # into $GOPATH/bin
51```
52
53### Prebuilt binaries
54
55Every 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`.
56
57## Authenticate
58
59The 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.
60
61### Credential lookup order
62
631. `--api-key` flag
642. `ANTHROPIC_API_KEY` or `OPENAI_API_KEY` env var
653. `$ZOT_HOME/auth.json` (API key or OAuth token; mode 0600)
66
67`$ZOT_HOME` defaults to:
68- macOS: `~/Library/Application Support/zot`
69- Linux: `$XDG_STATE_HOME/zot` or `~/.local/state/zot`
70- Windows: `%LOCALAPPDATA%\zot`
71
72### `/login` flow
73
74Run `zot` and type `/login`. Pick one of two methods:
75
76- **API key**: a small local web server starts on `127.0.0.1:<free-port>`, your browser opens a form, you paste your `sk-ant-...` or `sk-...` key. zot probes the provider once and saves it to `auth.json` if accepted.
77- **Subscription**: use your Claude Pro/Max or ChatGPT Plus/Pro subscription. The OAuth flow pins the callback to a fixed port per provider (`localhost:53692` for Anthropic, `localhost:1455` for OpenAI) because those are the only ports their auth servers will redirect to.
78  - Anthropic uses the Claude Code OAuth flow. Messages go to `api.anthropic.com` with a bearer token and the Claude Code identity headers.
79  - 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.
80
81> **Note on subscription login.** The OAuth client IDs used are the ones published in Anthropic's Claude Code CLI and OpenAI's Codex CLI. Reusing them from a third-party tool is 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.
82
83### Token refresh
84
85OAuth access tokens are short-lived (Anthropic ~8h, OpenAI ~30d). zot refreshes them automatically:
86
87- 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.
88- The telegram bridge additionally refreshes once per turn so a bot that runs for days keeps working without manual intervention.
89- 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.
90
91All data lives under `$ZOT_HOME`:
92
93```
94$ZOT_HOME/
95├── config.json         # last-used provider/model/theme, saved automatically
96├── auth.json           # api keys and oauth tokens (mode 0600)
97├── sessions/           # jsonl transcripts, one dir per cwd
98├── models-cache.json   # live /v1/models discovery cache (6h ttl)
99├── SYSTEM.md           # optional: replaces the default system prompt
100├── skills/             # optional: user SKILL.md files (opt in with --with-skills)
101├── extensions/         # installed extensions, one dir per extension
102└── logs/               # app log files
103```
104
105Drop 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.
106
107## Changelog on update
108
109The 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.
110
111## Usage
112
113```bash
114zot                              # interactive tui
115zot "fix the failing test"       # tui, pre-filled prompt
116zot -p "list all go files"       # print final text, exit
117zot --json "refactor main.go"    # newline-delimited json events, exit
118zot --continue                   # resume the most recent session for this cwd
119zot --resume                     # pick a session to resume
120zot --list-models                # show supported models
121zot --help
122```
123
124## Flags
125
126| Flag | Description |
127|---|---|
128| `--provider anthropic\|openai` | Pick the provider. |
129| `--model <id>` | Pick the model (see `--list-models`). |
130| `--api-key <key>` | Override the API key. |
131| `--base-url <url>` | Override the provider base URL (tests, self-hosted). |
132| `--system-prompt <text>` | Replace the default system prompt for this run (also overrides `$ZOT_HOME/SYSTEM.md`). |
133| `--append-system-prompt <text>` | Append text to the system prompt (repeatable). |
134| `--reasoning low\|medium\|high` | Enable reasoning on supported models. |
135| `-c`, `--continue` | Resume the latest session for this cwd. |
136| `-r`, `--resume` | Pick a session to resume. |
137| `--session <path>` | Resume a specific session file. |
138| `--no-session` | Don't read or write session files. |
139| `--cwd <path>` | Use `<path>` as the working directory. |
140| `--no-tools` | Disable all tools. |
141| `--tools <csv>` | Only enable the listed tools. |
142| `--max-steps <n>` | Cap agent loop iterations (default 50). |
143| `-e`, `--ext <path>` | Load an extension from `<path>` for this run (repeatable; wins against installed extensions of the same name). |
144| `--no-ext` | Skip extension discovery for this run. `--ext` still works on top, so `--no-ext --ext ./x` runs only `x`. |
145| `--with-skills` | Also load user-installed skills. Without this, only the built-in skills shipped in the binary are loaded. |
146| `--no-skill` | Disable all skills, including built-ins. No `skill` tool is registered and the system prompt has no skill manifest. |
147| `--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. Type `/yolo` in the TUI to disable the gate for the rest of the session. |
148
149## Tools
150
151- `read`: read text files, or inline images (PNG, JPEG, GIF, WebP).
152- `write`: create or overwrite files, making parent directories as needed.
153- `edit`: one or more exact-match replacements in an existing file.
154- `bash`: run a shell command in the session cwd, with merged stdout/stderr and a timeout.
155
156When the sandbox is on (see `/jail`), all four tools refuse paths outside the session cwd.
157
158## Modes
159
160- **Interactive** (default): chat TUI with streaming output, spinner, cost meter, slash commands.
161- **Print**: `zot -p "prompt"` runs the agent to completion and writes only the final assistant text to stdout.
162- **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).
163- **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.
164
165## Embedding
166
167Two ways to drive zot from another program:
168
169- **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/`.
170- **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/`.
171
172Both interfaces share the same event schema, so transcripts captured by one can be replayed through the other.
173
174## Slash commands
175
176Type `/` in the TUI to open the autocomplete popup. Available commands:
177
178| Command | Description |
179|---|---|
180| `/help` | Show key bindings and commands. |
181| `/login` | Log in via API key or subscription (opens a dialog). |
182| `/logout [provider]` | Clear credentials for `anthropic`, `openai`, or all when omitted. |
183| `/model` | Pick a model from a list (or `/model <id>` to set directly). |
184| `/sessions` | Resume a previous session for this directory. |
185| `/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`. |
186| `/jump` | Scroll the chat to a previous turn (or `/jump <text>` to filter). |
187| `/btw` | Side chat with full context that doesn't add to the main thread. |
188| `/skills` | List discovered skills (SKILL.md files) and preview their bodies. |
189| `/compact` | Summarize the transcript into one message to free up context. |
190| `/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. |
191| `/jail` | Confine tools to the current directory. |
192| `/unjail` | Allow tools to touch paths outside again. |
193| `/reload-ext` | Hot-reload all extensions (re-read manifests, respawn subprocesses, rebuild tool registry). |
194| `/yolo` | Turn off `--no-yolo` confirmation for the rest of this session. |
195| `/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`. |
196| `/clear` | Clear the chat transcript. |
197| `/exit` | Exit zot. |
198
199Extension-registered commands appear under a divider at the bottom of the popup, sorted by name.
200
201### `/sessions`
202
203Shows 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.
204
205### `/session`
206
207Four ops on the current session. `/session` alone opens a picker; each is also runnable directly.
208
209- **`/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.
210- **`/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).
211- **`/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.
212- **`/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.
213
214### `/jump`
215
216Opens 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.
217
218Jumping 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.
219
220### `/btw`
221
222Opens 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.
223
224Each 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.
225
226```
227/btw                              # open the overlay, type questions interactively
228/btw does PUT replace the whole resource?
229```
230
231Inside 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.
232
233### `/skills`
234
235Opens 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.
236
237### `/compact`
238
239Sends 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%.
240
241zot 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.
242
243### `/jail`
244
245Enforces 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.
246
247This is a guardrail against accidents, not a hard security boundary. If you need real isolation, run zot under docker or a proper sandbox.
248
249## Sessions
250
251Every 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.
252
253## Models
254
255`--list-models` or the `/model` picker shows the full catalog. Three sources:
256
257- **Catalog**: models baked into zot, always available.
258- **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).
259- **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.
260
261The context meter in the status line uses the model's advertised context window to show how much of it your last turn consumed.
262
263## Inline images
264
265When a tool returns an image (for example `read` on a PNG), zot renders it inline on terminals that support it: **iTerm2**, **WezTerm**, **Kitty**, **Ghostty**. On other terminals you see a text placeholder with MIME type, pixel dimensions, and byte size. Control with the `ZOT_INLINE_IMAGES` env var:
266
267| Value | Effect |
268|---|---|
269| unset (default) | Auto-detect based on `TERM_PROGRAM`. |
270| `iterm`, `iterm2` | Force the iTerm2 OSC 1337 protocol. |
271| `kitty` | Force the Kitty graphics protocol. |
272| `off`, `none` | Always use the text placeholder. |
273
274Frames 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.
275
276## Queued messages
277
278You 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.
279
280Slash 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.
281
282
283## Keys (interactive mode)
284
285### Input
286
287| Key | Action |
288|---|---|
289| `enter` | Submit (queued if the agent is busy). |
290| `alt+enter` | Newline. |
291| `tab` | Complete the selected slash command. |
292| `esc` | Cancel the current turn (while busy); clear input (while idle). |
293| `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. |
294| `ctrl+d` | Exit on empty input. |
295| `ctrl+l` | Redraw the screen. |
296| `ctrl+o` | Expand or collapse long tool results (read, write, edit, bash outputs over ~12 lines). |
297
298### Editor line navigation
299
300| Key | Action |
301|---|---|
302| `ctrl+a`, `ctrl+e` | Jump to start or end of line. |
303| `alt+left`, `alt+right` | Jump one word back or forward. |
304| `ctrl+u`, `ctrl+k` | Delete to start or end of line. |
305| `ctrl+w`, `alt+backspace` | Delete the previous word. |
306| `up`, `down` (editor non-empty) | Cycle through prompt history. |
307
308### Chat scroll
309
310| Key | Action |
311|---|---|
312| `pgup`, `pgdn` | Scroll one page up or down. |
313| `up`, `down` (editor empty) | Scroll three lines up or down. This is how the mouse wheel reaches the scroll logic on most terminals. |
314
315## Extensions
316
317zot 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`.
318
319### Install and manage
320
321```bash
322zot ext install <path|git-url>   # copy / clone into $ZOT_HOME/extensions/
323zot ext list                      # show installed extensions
324zot ext logs <name> [-f]          # cat or tail the extension's stderr log
325zot ext enable <name>             # re-enable a disabled extension
326zot ext disable <name>            # disable without removing
327zot ext remove <name>             # delete an extension directory
328```
329
330For 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.
331
332### Reference
333
334`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.
335
336## Skills
337
338A 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.
339
340By default only the built-in skills shipped with the zot binary are loaded. Pass `--with-skills` to also load user-installed skills from:
341
342- `./.zot/skills/<name>/SKILL.md` (project)
343- `$ZOT_HOME/skills/<name>/SKILL.md` (global)
344- `./.claude/skills/<name>/SKILL.md`, `~/.claude/skills/<name>/SKILL.md` (Claude-compatible layout)
345- `./.agents/skills/<name>/SKILL.md`, `~/.agents/skills/<name>/SKILL.md` (agent-compatible layout)
346
347See [docs/skills.md](docs/skills.md) for the frontmatter fields, authoring tips, and example skills under `examples/skills/`.
348
349## Telegram bot (bridge)
350
351zot 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).
352
353### From inside the TUI
354
355Type `/telegram` in the running TUI to open a picker with **connect**, **disconnect**, and **status**. When connected:
356
357- 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.
358- 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.
359- 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).
360- The status bar shows a `- tg -` tag while the bridge is active.
361- `/telegram connect` / `/telegram disconnect` / `/telegram status` (or `/tg`) also work as direct commands without the picker.
362
363The 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.
364
365### Standalone daemon
366
367For headless servers or long-running bots unattached to a TUI:
368
369```bash
370zot telegram-bot setup     # paste a BotFather token, verify, save
371zot telegram-bot run       # foreground: long-poll in this terminal (ctrl+c to stop)
372zot telegram-bot start     # background: detach and return immediately
373zot telegram-bot stop      # SIGTERM the background bot (SIGKILL after 5s)
374zot telegram-bot logs -f   # tail $ZOT_HOME/logs/bot.log (omit -f to just cat)
375zot telegram-bot status    # config (token masked) + running/stopped
376zot telegram-bot reset     # forget the token and paired user
377# short alias: `zot tg ...` is accepted for every subcommand
378```
379
380The 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.
381
382> **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.
383
384Setup flow:
385
3861. Talk to [@BotFather](https://t.me/BotFather) on telegram, run `/newbot`, copy the token it gives you.
3872. Run `zot telegram-bot setup` and paste the token when prompted.
3883. Run `zot telegram-bot run` in the directory you want the agent to operate in.
3894. 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.
390
391From 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).
392
393Bot 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.
394
395## Development
396
397```bash
398make build     # build ./bin/zot
399make test      # go test -race ./...
400make lint      # go vet + gofmt check
401make fmt       # gofmt -w .
402make release   # cross-compile linux/darwin/windows on amd64 and arm64
403```
404
405Source layout:
406
407```
408cmd/zot/                      main()
409internal/agent/               cli wiring, arg parsing, system prompt, config
410internal/agent/extensions/    extension subprocess manager
411internal/agent/modes/         interactive tui, print, json, dialogs
412internal/agent/tools/         read, write, edit, bash, sandbox
413internal/auth/                credential store, api-key probe, oauth, login server
414internal/core/                agent loop, sessions, cost tracking
415internal/extproto/            extension wire-format types
416internal/provider/            anthropic + openai streaming clients, model catalog
417internal/skills/              skill discovery, frontmatter parser, skill tool
418internal/tui/                 terminal raw-mode, input parser, editor, renderer, markdown, view
419pkg/zotcore/                  public Go SDK for embedding zot in-process
420pkg/zotext/                   public Go SDK for writing extensions
421```
422
423## License
424
425MIT