v0.19.0 d7aa01a

extensions.md RawHistoryFolder

zut extensions

zut can be extended with custom slash commands by running an external program as a subprocess and exchanging newline-delimited JSON over its stdin/stdout. Extensions can be written in any language that can read and write JSON lines from stdio — Go, TypeScript, Python, Rust, shell with jq, anything.

Six phases shipped so far:

  • Phase 1: slash commands, chat notifications, and host alerts.
  • Phase 2: tools the LLM can call.
  • Phase 3: lifecycle event subscriptions + tool-call interception for guardrail extensions.
  • Phase 4: interactive extension-owned panels rendered inside zut.
  • Phase 5: branch-aware session lifecycle events and opaque extension state persisted with session files.
  • Phase 6: hidden per-turn context, persistent status/widgets, and extension-bundled skills.
  • Theme-only extensions: ship theme.json without launching a subprocess. See themes.md.

Quick start

The simplest extension is a script that prints a hello frame, reads commands, and prints responses. Here's the whole thing in Python, no SDK required:

#!/usr/bin/env python3
# $ZUT_HOME/extensions/hello-py/hello.py
import json, sys

def emit(obj):
    sys.stdout.write(json.dumps(obj) + "\n")
    sys.stdout.flush()

emit({"type":"hello","protocol_version":2,"name":"hello-py","version":"1.0.0","capabilities":["commands"]})

for line in sys.stdin:
    msg = json.loads(line)
    if msg["type"] == "hello_ack":
        if msg.get("protocol_version") != 2:
            raise SystemExit("unsupported extension protocol version")
        emit({"type":"register_command","name":"hellopy","description":"say hi (python)"})
        emit({"type":"ready"})
    elif msg["type"] == "command_invoked":
        emit({"type":"command_response","id":msg["id"],"action":"prompt",
              "prompt": "Greet me very briefly in one sentence."})
    elif msg["type"] == "shutdown":
        emit({"type":"shutdown_ack"})
        break

Drop it in a directory with this extension.json:

{
  "name": "hello-py",
  "version": "1.0.0",
  "exec": "./hello.py",
  "language": "python",
  "enabled": true
}

exec is required for protocol extensions. If an extension only ships theme.json or themes/theme.json, no exec is required and zut does not spawn a subprocess.

chmod +x hello.py, install:

zut ext install ./hello-py

Restart zut, type /hellopy, the agent greets you. Done.

Built-in extensions

zut ships with no extensions installed by default. A fresh zut install (or go install) gives you a clean agent. Extensions are entirely opt-in: you install (or --ext for one run) only the ones you want.

The examples/extensions/ directory in the repo is reference code, not a default install set. To use any of those:

# install a Go example and explicitly build it in the staged install
zut ext install --build=go path/to/zut/examples/extensions/hello

# or build it in the source tree for a one-run development load
cd path/to/zut/examples/extensions/hello
go build -o hello .
zut --ext .

zut ext install never builds source code implicitly. For local installs it validates extension.json and any executable path relative to the extension directory, then stages the copy so a missing or ignored runtime artifact fails with an explicit error instead of becoming a broken installed extension. For a local Go extension, opt into the fixed builder explicitly with zut ext install --build=go <path>. The builder runs go build -trimpath from the source directory, writes the manifest-declared relative executable into the staging directory, and validates it before installation. It may resolve Go modules and access the network according to the user's Go environment. Bare launchers such as go, node, and npx remain resolved from PATH when zut starts; they cannot be used as the output of --build=go.

Nothing is auto-installed and nothing reaches out to the network without your explicit action.

Layout & discovery

zut scans two directories on startup, in this order:

  1. Project-local: ./.zut/extensions/<name>/extension.json
  2. Global: $ZUT_HOME/extensions/<name>/extension.json

A project-local extension with the same name wins over a global one. When XDG_STATE_HOME is set on any platform, $ZUT_HOME defaults to $XDG_STATE_HOME/zut. Otherwise it defaults to ~/Library/Application Support/zut/ on macOS, ~/.local/state/zut on Linux, or %LOCALAPPDATA%\zut on Windows.

Because each extension owns its own directory, the recommended place for extension state is inside that directory itself (for example todos.json, settings.json, or an auth/cache file used only by that extension). The host also passes this path back in hello_ack as extension_dir / data_dir so runtime code does not need to guess it.

Each extension owns its own subdirectory. The extension.json manifest tells zut how to launch it:

{
  "name": "weather",
  "version": "1.0.0",
  "exec": "./weather",
  "args": ["--mode", "daemon"],
  "language": "go",
  "description": "current weather for any city",
  "skills": ["skills"],
  "enabled": true
}
field meaning
name required. how zut identifies the extension; must match what's sent in the hello frame.
version optional. shown in zut ext list.
exec required. path to the executable (relative to the manifest).
args optional. extra argv passed to exec.
language optional. informational only (go, python, typescript, ...).
description optional. shown in zut ext list.
skills optional. relative directories containing bundled <name>/SKILL.md files or a direct SKILL.md. Paths must remain inside the extension directory.
enabled optional, defaults to true. set to false to disable without removing.

Lifecycle

  1. Discovery: zut reads every extension.json in the search dirs.
  2. Spawn: enabled extensions are launched as subprocesses. stderr redirects to $ZUT_HOME/logs/ext-<name>.log (one file per extension, append-mode).
  3. Hello handshake: the extension's first stdout frame must be hello with protocol_version: 2; zut rejects a mismatched major and replies with hello_ack containing the same protocol version, the active provider/model/cwd, and the extension's own data directory so it can persist files beside its manifest.
  4. Registration: after receiving hello_ack, the extension sends register_command, register_tool, and subscription frames, then sends ready. First-come-first-served: a name already taken by a built-in or by a previously-loaded extension is silently shadowed (logged in the extension's own log file).
  5. Runtime: after ready, zut dispatches command_invoked frames when the user runs a registered command; the extension responds with command_response. Extensions can also push notify, persistent status/widget, and structured alert frames during runtime. Extensions subscribed to session lifecycle events receive the active branch identity and their own restored opaque state. Panel-capable extensions may open an interactive panel, receive key events, and push redraws while the panel is focused.
  6. Shutdown: when zut exits, it sends shutdown and waits up to 2s for the extension to send shutdown_ack. Holdouts are SIGTERM'd, then SIGKILL'd.

A crashing extension does not bring down zut. The slash command it owned simply stops working until the extension is fixed and zut is restarted.

Wire format

All frames are one JSON object per line. Top-level type is the discriminator. Optional id correlates request frames with their responses. The canonical startup order is hello, hello_ack, registration frames, then ready. Do not send notify, alert, logs, or any other stdout frame before hello.

Extension → host

hello (required, first frame)

{"type":"hello","protocol_version":2,"name":"weather","version":"1.0.0",
 "capabilities":["commands","tools","alerts","panels"]}

register_command

{"type":"register_command","name":"weather",
 "description":"current weather for a city"}

Command names are matched case-insensitively. zut sends command_invoked.name using the canonical spelling registered here. Registrations that differ only by case conflict, and the first registration remains active.

register_tool

Registers a tool the LLM can call. schema is a JSON Schema object describing the tool's args (the same shape Anthropic and OpenAI accept).

{"type":"register_tool","name":"weather",
 "description":"Get the current weather for a city.",
 "schema":{
   "type":"object",
   "properties":{"city":{"type":"string"}},
   "required":["city"]
 }}

Tool names live in the same namespace as built-in tools (read, write, edit, bash, create_worktree, grep, lsp, web_search, skill). Conflicts with active built-ins are silently shadowed by the built-in. The native web_search name is reserved even when the setting disables that built-in, so an extension cannot claim or replace it. The grep name is reserved even when Args.NoTools/SDK Config.NoTools or an explicit Args.Tools/SDK Config.Tools allowlist disables the native search tool, so an extension cannot claim or replace it.

Set "deferred": true to register a tool without advertising its definition initially. A loader tool can activate registered deferred tools by returning their names in activate_tools:

{"type":"tool_result","id":"...",
 "content":[{"type":"text","text":"Enabled weather lookup"}],
 "activate_tools":["weather"]}

On Kimi K3's OpenAI-compatible routes, zut places newly activated schemas at the tool-result position using Kimi's native deferred-tool format. Other models receive the complete active tool list on the next request. Unknown names are ignored. The Go extension SDK exposes DeferredTool and ToolResult.ActivateTools for the same protocol.

ready

Sentinel telling zut "all initial registrations are flushed". Send it right after your last register_* frame so the host can build the agent's tool registry without racing the registration window.

{"type":"ready"}

tool_result

Reply to a tool_call from the host. content[] is a list of message blocks; each block is {"type":"text","text":"..."} or {"type":"image","mime_type":"image/png","data":"<base64>"}. Set is_error: true to mark the call as failed. activate_tools can name registered deferred tools that become available after this result.

{"type":"tool_result","id":"...",
 "content":[{"type":"text","text":"Berlin: 16°C, fog"}],
 "details":{"state":{"version":1}}}

details is opaque extension metadata. Zut excludes it from provider requests and persists it as the latest extension state for the active session branch. Keep it valid JSON and reasonably small; the host caps persisted snapshots at 256 KiB. The next session_opened, session_switched, session_forked, or session_compacted event returns the extension's own snapshot in state.

subscribe

Declares which lifecycle events the extension wants to observe and which it wants to intercept. Send once after hello, before ready.

{"type":"subscribe",
 "events":["session_start","turn_start","tool_call","tool_confirmation_requested","turn_end","assistant_message"],
 "intercept":["tool_call","turn_start","assistant_message"]}

Recognised event names include session_start, session_opened, session_switched, session_forked, session_compacted, turn_start, tool_call, tool_confirmation_requested, assistant_message, and turn_end.

Session events contain session with the current branch ID, parent ID, path, cwd, and fork point. They also contain state, but only for the receiving extension. Zut never exposes another extension's state.

tool_confirmation_requested fires only when zut is about to wait for interactive approval. Calls running in yolo mode, calls covered by a remembered approval, and calls blocked before confirmation do not emit it. The event includes tool_id, tool_name, and the short tool_preview shown in the confirmation dialog.

Interceptable events:

  • tool_call: block the call (model sees reason as the tool error) or rewrite args via modified_args.
  • turn_start: block the turn before the model is called. Useful for rate-limiting and business-hour gates. reason is shown to the user as a status line. No rewrite supported.
  • assistant_message: suppress the message via block, or rewrite the user-visible text via replace_text. The model's original text stays in the transcript so the model sees what it actually said on subsequent turns.

event_intercept_response

Reply to an event_intercept from the host. All fields default to "allow, pass through unmodified".

field meaning
block true refuses the action. For tool_call, reason is shown to the model; for turn_start / assistant_message, reason is shown to the user.
reason refusal text (on block) or pass-through note.
modified_args for tool_call: rewritten JSON args the tool will actually see. Must be a valid JSON object. Ignored when block is true. Rewrites replace the complete argument object; for bash, preserve the required positive integer timeout when changing command.
replace_text for assistant_message: replaces the user-visible text. The model's original output still lives in the transcript. Ignored when block is true.
context for turn_start: bounded hidden context sent only in the upcoming provider request. It is not a user message and is not persisted in the transcript.

Missing the response within 5s is treated as "allow" (i.e. an unresponsive extension never stalls the agent). When multiple extensions subscribe to the same event, they're consulted serially; the first block wins and rewrites (args / text) chain: each subsequent interceptor sees the previous one's output.

{"type":"event_intercept_response","id":"...",
 "block":true,"reason":"refused: matches danger pattern \"rm -rf\""}

{"type":"event_intercept_response","id":"...",
 "modified_args":{"command":"echo GUARDED: ls","timeout":30}}

{"type":"event_intercept_response","id":"...",
 "replace_text":"[redacted]"}

{"type":"event_intercept_response","id":"...",
 "context":"Current phase: parse files\nRemaining: validate inputs"}

command_response (reply to command_invoked)

{"type":"command_response","id":"...","action":"prompt",
 "prompt":"Show today's weather for Berlin in one line."}

action is one of:

  • "prompt" — submits prompt as a fresh user message; the agent runs a turn against it.
  • "insert" — inserts insert into the editor at the cursor without submitting.
  • "display" — appends display to the chat as a one-shot styled note. No model call, nothing written to the transcript.
  • "open_panel" — opens an extension-owned interactive panel inside zut. The panel content lives in open_panel.
  • "noop" — the extension handled it itself (e.g. it pushed notify frames or kicked off background work). zut doesn't change the UI in response.

Example:

{"type":"command_response","id":"...","action":"open_panel",
 "open_panel":{
   "id":"todos-main",
   "title":"Todos",
   "lines":["□ ship panel api","✓ persist state"],
   "footer":"↑/↓ navigate - a add - x complete - esc close"
 }}

If error is non-empty, zut renders it as a red status line regardless of action.

submit (one-way, any time)

Submits text as a user prompt in the interactive host. If the agent is idle, zut starts a turn immediately. If a turn is already running, zut queues the prompt behind it using the same queue path as typed input. Empty or whitespace-only text is ignored.

{"type":"submit","text":"Summarize the selected workspace."}

In print / JSON / RPC modes this frame is ignored because there is no interactive editor or prompt queue.

panel_render (one-way, while a panel is open)

Pushes a fresh frame for an already-open panel.

{"type":"panel_render","panel_id":"todos-main",
 "title":"Todos",
 "lines":["□ ship panel api","✓ persist state"],
 "footer":"↑/↓ navigate - a add - x complete - esc close"}

panel_close

Closes a previously-open panel.

{"type":"panel_close","panel_id":"todos-main"}

status (one-way, persistent)

Sets or replaces one status item owned by the extension. Sending an empty text clears the item.

{"type":"status","key":"progress","level":"success",
 "text":"2/4 tasks checked"}

widget (one-way, persistent)

Sets or replaces a compact widget. position is a host-defined placement hint with these interactive-zut values:

  • "above_input" keeps the widget in the existing persistent chrome above the editor.
  • "right_bar" keeps the widget in a display-only side rail beside the transcript when the terminal is wide enough.

The host owns right-bar layout: it orders widgets, bounds width and height, and truncates content. Narrow terminals and Ctrl+B use a bounded above_input fallback. Empty or unknown positions keep the historical above_input behavior. Use open_panel for interaction or navigation.

{"type":"widget","id":"plan","position":"right_bar",
 "title":"Tasked phases","lines":["Current phase: parse","[ ] validate inputs"]}

widget_clear (one-way)

{"type":"widget_clear","id":"plan"}

notify (one-way, any time)

{"type":"notify","level":"info",
 "message":"refreshed cache (12 entries)"}

level is one of info, success, warn, error. The note shows up below the transcript with the extension's name in brackets. Notes are one-shot: they clear automatically when the user sends their next prompt (and on esc / /clear).

alert (one-way, any time)

Requests a host-owned structured alert. The first supported kind is bell, which asks the interactive terminal to emit one terminal bell. reason is semantic metadata and is not rendered as terminal text. The shared terminal-alert setting in /settings applies to extension alerts too; disabled or non-interactive hosts may ignore the request.

{"type":"alert","kind":"bell","reason":"question_ready"}

The Go SDK sends the same frame with:

e.Alert(ext.AlertRequest{Kind: ext.AlertKindBell, Reason: "question_ready"})

Extensions must not write BEL, ANSI, or other terminal bytes to stdout; stdout is reserved for protocol frames. In --mode rpc, this becomes an ext_alert JSON event for the RPC client to interpret.

clear_notes (one-way, any time)

Removes every note this extension previously pushed via notify / display. Use it for transient status lines (e.g. an approval prompt) so they do not stack up; notes from other extensions are untouched.

{"type":"clear_notes"}

In --mode rpc, this surfaces to the host as an ext_clear_notes event (alongside ext_notify / ext_display).

shutdown_ack

Sent in response to shutdown. Extension should exit promptly after.

Host → extension

hello_ack

{"type":"hello_ack","protocol_version":2,
 "zut_version":"0.0.7","provider":"anthropic",
 "model":"claude-opus-4-7","cwd":"/path/to/zut",
 "extension_dir":"/path/to/zut/.zut/extensions/todos",
 "data_dir":"/path/to/zut/.zut/extensions/todos",
 "session":{"id":"branch-1","parent_id":"root-1",
             "path":".../session.jsonl","cwd":"/path/to/zut",
             "fork_point":4}}

Sent immediately after a matching hello. The protocol version is a major and must match the version sent by the extension. Wait for this frame before sending registrations if they depend on host metadata. The extension can use these fields to decide which commands to register (e.g. only register a Python tool on macOS, only register a model-specific shortcut for opus, etc.). cwd is the user's project directory; the extension process itself runs from the extension directory, so do not use os.Getwd() or process.cwd() when you need the project path. extension_dir / data_dir are where the extension should persist its own state (for example todos.json, cached metadata, or auth tokens scoped to that extension).

command_invoked

{"type":"command_invoked","id":"...",
 "name":"weather","args":"berlin"}

args is everything the user typed after the command name, trimmed.

tool_call

Sent when the LLM invokes a tool the extension registered. args is the parsed JSON object the model produced; the extension is responsible for validating/coercing it.

{"type":"tool_call","id":"...","name":"weather",
 "args":{"city":"Berlin"}}

Reply with tool_result within the host's tool timeout (default 60s). Missing the timeout surfaces an error to the model and the call is marked as failed.

event

Lifecycle notification for events the extension subscribed to via subscribe. One-way — no response expected.

{"type":"event","event":"session_opened",
 "session":{"id":"branch-1","parent_id":"root-1","fork_point":4},
 "state":{"version":1}}
{"type":"event","event":"turn_start","step":1}
{"type":"event","event":"tool_call",
 "tool_id":"...","tool_name":"read","tool_args":{"path":"foo.go"}}
{"type":"event","event":"tool_confirmation_requested",
 "tool_id":"...","tool_name":"read","tool_preview":"foo.go"}
{"type":"event","event":"turn_end","stop":"end_turn"}

event_intercept

Sent when zut wants to give the extension a chance to block, modify, or annotate a lifecycle event before it happens. Reply with event_intercept_response within 5s; missing the deadline is treated as "allow".

Payload fields depend on the event:

// tool_call: includes the tool id, name, and parsed args
{"type":"event_intercept","id":"...","event":"tool_call",
 "tool_id":"...","tool_name":"bash",
 "tool_args":{"command":"rm -rf /tmp/foo","timeout":30}}

// turn_start: includes the step number
{"type":"event_intercept","id":"...","event":"turn_start",
 "step":3}

// assistant_message: includes the assembled text
{"type":"event_intercept","id":"...","event":"assistant_message",
 "text":"here is your api key: sk-ant-..."}

panel_key

Sent while an extension-owned panel is focused. key is a normalized name (up, down, left, right, enter, esc, tab, pageup, pagedown, home, end, backspace, delete, rune). For key:"rune", text carries the typed character.

{"type":"panel_key","panel_id":"todos-main","key":"down"}
{"type":"panel_key","panel_id":"todos-main","key":"rune","text":"x"}

panel_close

Sent when the user closes the focused panel from zut (for example with Esc or Ctrl+C). The extension should treat this as the panel lifetime ending and stop sending panel_render updates for that panel_id.

{"type":"panel_close","panel_id":"todos-main"}

shutdown

Sent during graceful zut exit (or /reload-ext once that lands). Reply with shutdown_ack and then exit.

Managing extensions from the CLI

zut ext list                              list installed extensions and their state
zut ext doctor                            diagnose load, registration, and conflict issues
zut ext install <path|git-url>             copy / clone into $ZUT_HOME/extensions/
zut ext install --build=go <local-path>   build local Go source, then install
zut ext remove <name>                     delete an extension directory
zut ext enable <name>           re-enable a disabled extension
zut ext disable <name>          disable without removing
zut ext logs <name> [-f]        cat / tail the extension's stderr

zut ext doctor runs the same discovery path as zut startup, but reports what happened instead of changing the fail-soft runtime behavior. It shows manifest errors, disabled or shadowed extensions, subprocess load errors, ready/auto-ready status, registered commands/tools, registration conflicts, warnings, and each extension's stderr log path.

zut ext install <path> does a recursive copy; <git-url> does a shallow clone. Both validate that the destination contains an extension.json and roll back if not. No build runs unless the local install is invoked with the explicit --build=go option. That option currently supports only local Go source paths; clone remote source locally before building it.

Loading an extension for one run

For iteration on a working copy, skip the install + reload cycle and load straight from disk for one zut session:

zut --ext ./my-extension        # short form: -e ./my-extension
zut --ext ./a -e ./b            # repeatable

--ext paths take precedence over installed extensions of the same name, so you can shadow an installed copy with a work-in-progress version without uninstalling first. Nothing is copied or persisted; the extension dies with zut like any other subprocess.

SDKs

Writing the wire protocol by hand is fine for one-off scripts, but for anything bigger the SDKs handle the boilerplate.

Go — packages/agent/ext

package main

import (
    "encoding/json"
    "github.com/bnema/zut/packages/agent/ext"
)

func main() {
    e := ext.New("hello", "1.0.0")

    // Slash command
    e.Command("hello", "say hi", func(args string) ext.Response {
        return ext.Prompt("Greet me in one short sentence.")
    })

    // LLM-callable tool
    e.Tool("weather", "Current weather for a city.",
        json.RawMessage(`{"type":"object","properties":{"city":{"type":"string"}},"required":["city"]}`),
        func(args json.RawMessage) ext.ToolResult {
            var in struct{ City string `json:"city"` }
            json.Unmarshal(args, &in)
            return ext.TextResult(in.City + ": sunny")
        })

    // Optional: register project-specific commands after hello_ack.
    e.OnHello(func(host ext.HostInfo) {
        if host.CWD != "" {
            e.Command("cwd", "show the current project directory", func(args string) ext.Response {
                return ext.Display(host.CWD)
            })
        }
    })

    e.Run()
}

Build with go build -o hello ., drop the binary + an extension.json into $ZUT_HOME/extensions/hello/.

OnHello is optional. Use it when configuration or registrations need host metadata such as HostInfo.CWD, Provider, Model, ZutVersion, ExtensionDir, or DataDir. The SDK sends hello, waits for hello_ack, runs OnHello, announces registrations, then sends ready.

Session-aware extensions can subscribe to session_opened, session_switched, session_forked, and session_compacted; Event.Session identifies the active branch and Event.State contains that extension's latest persisted snapshot. A tool can return opaque state with result.Details = ext.JSONDetails(value).

TurnStartDecision.Context supplies hidden bounded context for the next model request. SetStatus, SetWidget, and their clear methods update persistent interactive chrome without entering the transcript.

For Go extensions, use the SDK constants so the host can choose the responsive layout without extension-specific terminal code:

e.SetWidget("plan", ext.WidgetPositionRightBar, "Tasked phases", lines)
e.ClearWidget("plan")

The SDK has four interceptor hooks, all optional:

// e is the *ext.Extension returned by ext.New(...).

// Refuse calls or rewrite args before they run.
e.InterceptToolCall(func(tool string, args json.RawMessage) (bool, string) {
    if tool == "bash" { /* inspect args, return false, reason */ }
    return true, ""
})

// Richer variant: returns ToolCallDecision so you can also rewrite
// args via ModifiedArgs.
e.InterceptToolCallX(func(tool string, args json.RawMessage) ext.ToolCallDecision {
    return ext.ToolCallDecision{
        ModifiedArgs: json.RawMessage(`{"command":"echo GUARDED","timeout":30}`),
    }
})

// Block the next turn before the model is called.
e.InterceptTurnStart(func(step int) ext.TurnStartDecision {
    if time.Now().Hour() < 9 { return ext.TurnStartDecision{Block: true, Reason: "outside business hours"} }
    return ext.TurnStartDecision{}
})

// Scrub or rewrite the assistant's final text before the user sees it.
e.InterceptAssistantMessage(func(text string) ext.AssistantMessageDecision {
    return ext.AssistantMessageDecision{
        ReplaceText: strings.ReplaceAll(text, "SECRET", "[redacted]"),
    }
})

See:

  • examples/extensions/hello/ — slash commands
  • examples/extensions/clock/ — slash commands in plain Node, no SDK
  • examples/extensions/weather/ — LLM-callable tool
  • examples/extensions/guard/ — event subscriptions + tool-call interception (refuses dangerous bash patterns)
  • examples/extensions/todo/ — interactive persistent panel + tool
  • examples/extensions/tasked-phases/ — spec, phased checklist, persistent tool, and /phases panel
  • examples/extensions/scratchpad/ — source-run TypeScript commands + tool

The tasked-phases example bundles its companion skill under examples/extensions/tasked-phases/skills/ and declares it in extension.json. Installing the extension therefore installs the workflow skill automatically. The standalone copy at examples/skills/tasked-phases/ remains useful for project-local skill installation. Its state is restored per session branch when zut session persistence is enabled; the extension keeps a project-file fallback for hosts that do not persist sessions.

Hot reload

Type /reload-ext in the TUI to tear down every running extension subprocess, re-read the manifests from disk, and respawn the set. The agent's tool registry is rebuilt automatically, so freshly- registered extension tools become callable without restarting zut. Useful while developing an extension: edit, save, /reload-ext, done. Explicit --ext paths are remembered and reloaded alongside discovered extensions. The temporary reload status reports each load error in red, including its message, and dismisses itself after five seconds. Extension failures from startup and /reload-ext remain in the scrolling chat until a successful reload or /clear, without being sent to the model or saved in the session transcript. Subprocess startup and handshake errors include the exact stderr log path for the failed extension. If a subprocess exits before sending hello, the error also reports its exit status or terminating signal.

TypeScript / Python

These SDKs aren't in the main repo yet; the wire format is small enough that a ~30 line raw script gets you started in either language. See the Quick start Python example for the shape. SDK packages will land in follow-up commits.

Security

Extensions run with the user's full filesystem and network permissions. Treat installing an extension the same as installing any other binary on your machine.

zut ext install <git-url> clones from any URL you give it. There's no sandbox in v1; if you need isolation, install only extensions you trust or run zut under your platform's sandboxing tool (bwrap / sandbox-exec / AppContainer).

Roadmap

Phase 1 (shipped):

  • subprocess lifecycle + hello handshake
  • register_command + command_invoked
  • notify + clear_notes + structured terminal alerts
  • zut ext CLI

Phase 2 (shipped):

  • register_tool + tool_call + tool_result
  • ready sentinel for safe agent-registry build timing
  • tool result attribution surfaces extension name in details

Phase 3 (shipped):

  • event subscriptions (session_start, session_opened, session_switched, session_forked, session_compacted, turn_start, turn_end, tool_call, assistant_message)
  • tool-call interception (block before execution)

Phase 4 (shipped):

  • interception for turn_start and assistant_message (in addition to tool_call)
  • modify tool args mid-flight via modified_args
  • rewrite user-visible assistant text via replace_text
  • /reload-ext slash command (hot-reload without restarting zut)

Phase 5 (shipped):

  • session/branch identity in hello_ack and lifecycle events
  • session open/switch/fork/compaction notifications
  • opaque extension state persisted with session branches

Phase 6 (shipped):

  • hidden bounded context returned from turn_start interception
  • persistent extension status and widget frames
  • manifest-declared bundled skill discovery with safe path validation

Future (no firm timeline):

  • TypeScript and Python SDK packages (currently the wire format is stable enough to hand-roll, see the Python quick-start)
  • HTTP / WebSocket transport variants (today: subprocess stdio)
  • per-extension permission scopes (today: full user privileges)
source
1# zut extensions
2
3zut can be extended with custom slash commands by running an external
4program as a subprocess and exchanging newline-delimited JSON over
5its stdin/stdout. Extensions can be written in **any language** that
6can read and write JSON lines from stdio — Go, TypeScript, Python,
7Rust, shell with `jq`, anything.
8
9Six phases shipped so far:
10
11- **Phase 1**: slash commands, chat notifications, and host alerts.
12- **Phase 2**: tools the LLM can call.
13- **Phase 3**: lifecycle event subscriptions + tool-call interception
14  for guardrail extensions.
15- **Phase 4**: interactive extension-owned panels rendered inside zut.
16- **Phase 5**: branch-aware session lifecycle events and opaque extension
17  state persisted with session files.
18- **Phase 6**: hidden per-turn context, persistent status/widgets, and
19  extension-bundled skills.
20- **Theme-only extensions**: ship `theme.json` without launching a
21  subprocess. See [themes.md](themes.md).
22
23## Quick start
24
25The simplest extension is a script that prints a hello frame, reads
26commands, and prints responses. Here's the whole thing in **Python**,
27no SDK required:
28
29```python
30#!/usr/bin/env python3
31# $ZUT_HOME/extensions/hello-py/hello.py
32import json, sys
33
34def emit(obj):
35    sys.stdout.write(json.dumps(obj) + "\n")
36    sys.stdout.flush()
37
38emit({"type":"hello","protocol_version":2,"name":"hello-py","version":"1.0.0","capabilities":["commands"]})
39
40for line in sys.stdin:
41    msg = json.loads(line)
42    if msg["type"] == "hello_ack":
43        if msg.get("protocol_version") != 2:
44            raise SystemExit("unsupported extension protocol version")
45        emit({"type":"register_command","name":"hellopy","description":"say hi (python)"})
46        emit({"type":"ready"})
47    elif msg["type"] == "command_invoked":
48        emit({"type":"command_response","id":msg["id"],"action":"prompt",
49              "prompt": "Greet me very briefly in one sentence."})
50    elif msg["type"] == "shutdown":
51        emit({"type":"shutdown_ack"})
52        break
53```
54
55Drop it in a directory with this `extension.json`:
56
57```json
58{
59  "name": "hello-py",
60  "version": "1.0.0",
61  "exec": "./hello.py",
62  "language": "python",
63  "enabled": true
64}
65```
66
67`exec` is required for protocol extensions. If an extension only ships
68`theme.json` or `themes/theme.json`, no `exec` is required and zut does
69not spawn a subprocess.
70
71`chmod +x hello.py`, install:
72
73```bash
74zut ext install ./hello-py
75```
76
77Restart `zut`, type `/hellopy`, the agent greets you. Done.
78
79## Built-in extensions
80
81**zut ships with no extensions installed by default.** A fresh `zut install` (or `go install`) gives you a clean agent. Extensions are entirely opt-in: you install (or `--ext` for one run) only the ones you want.
82
83The `examples/extensions/` directory in the repo is reference code, not a default install set. To use any of those:
84
85```bash
86# install a Go example and explicitly build it in the staged install
87zut ext install --build=go path/to/zut/examples/extensions/hello
88
89# or build it in the source tree for a one-run development load
90cd path/to/zut/examples/extensions/hello
91go build -o hello .
92zut --ext .
93```
94
95`zut ext install` never builds source code implicitly. For local installs it
96validates `extension.json` and any executable path relative to the extension
97directory, then stages the copy so a missing or ignored runtime artifact fails
98with an explicit error instead of becoming a broken installed extension. For a
99local Go extension, opt into the fixed builder explicitly with
100`zut ext install --build=go <path>`. The builder runs `go build -trimpath` from
101the source directory, writes the manifest-declared relative executable into the
102staging directory, and validates it before installation. It may resolve Go
103modules and access the network according to the user's Go environment. Bare
104launchers such as `go`, `node`, and `npx` remain resolved from `PATH` when zut
105starts; they cannot be used as the output of `--build=go`.
106
107Nothing is auto-installed and nothing reaches out to the network without your explicit action.
108
109## Layout & discovery
110
111zut scans two directories on startup, in this order:
112
1131. **Project-local**: `./.zut/extensions/<name>/extension.json`
1142. **Global**: `$ZUT_HOME/extensions/<name>/extension.json`
115
116A project-local extension with the same name wins over a global one.
117When `XDG_STATE_HOME` is set on any platform, `$ZUT_HOME` defaults to
118`$XDG_STATE_HOME/zut`. Otherwise it defaults to `~/Library/Application Support/zut/`
119on macOS, `~/.local/state/zut` on Linux, or `%LOCALAPPDATA%\zut` on Windows.
120
121Because each extension owns its own directory, the recommended place
122for extension state is inside that directory itself (for example
123`todos.json`, `settings.json`, or an auth/cache file used only by that
124extension). The host also passes this path back in `hello_ack` as
125`extension_dir` / `data_dir` so runtime code does not need to guess it.
126
127Each extension owns its own subdirectory. The `extension.json`
128manifest tells zut how to launch it:
129
130```json
131{
132  "name": "weather",
133  "version": "1.0.0",
134  "exec": "./weather",
135  "args": ["--mode", "daemon"],
136  "language": "go",
137  "description": "current weather for any city",
138  "skills": ["skills"],
139  "enabled": true
140}
141```
142
143| field | meaning |
144|---|---|
145| `name` | required. how zut identifies the extension; must match what's sent in the `hello` frame. |
146| `version` | optional. shown in `zut ext list`. |
147| `exec` | required. path to the executable (relative to the manifest). |
148| `args` | optional. extra argv passed to `exec`. |
149| `language` | optional. informational only (`go`, `python`, `typescript`, ...). |
150| `description` | optional. shown in `zut ext list`. |
151| `skills` | optional. relative directories containing bundled `<name>/SKILL.md` files or a direct `SKILL.md`. Paths must remain inside the extension directory. |
152| `enabled` | optional, defaults to `true`. set to `false` to disable without removing. |
153
154## Lifecycle
155
1561. **Discovery**: zut reads every `extension.json` in the search dirs.
1572. **Spawn**: enabled extensions are launched as subprocesses. stderr
158   redirects to `$ZUT_HOME/logs/ext-<name>.log` (one file per
159   extension, append-mode).
1603. **Hello handshake**: the extension's first stdout frame must be
161   `hello` with `protocol_version: 2`; zut rejects a mismatched major
162   and replies with `hello_ack` containing the same protocol version,
163   the active provider/model/cwd, and the extension's own data directory
164   so it can persist files beside its manifest.
1654. **Registration**: after receiving `hello_ack`, the extension sends
166   `register_command`, `register_tool`, and subscription frames, then
167   sends `ready`. First-come-first-served: a name already taken by a
168   built-in or by a previously-loaded extension is silently shadowed
169   (logged in the extension's own log file).
1705. **Runtime**: after `ready`, zut dispatches `command_invoked` frames
171   when the user runs a registered command; the extension responds
172   with `command_response`. Extensions can also push `notify`, persistent
173   status/widget, and structured `alert` frames during runtime. Extensions
174   subscribed to session lifecycle events receive the active branch identity
175   and their own restored opaque state. Panel-capable extensions may open an
176   interactive panel, receive key events, and push redraws while the panel is
177   focused.
1786. **Shutdown**: when zut exits, it sends `shutdown` and waits up to
179   2s for the extension to send `shutdown_ack`. Holdouts are
180   SIGTERM'd, then SIGKILL'd.
181
182A crashing extension does not bring down zut. The slash command it
183owned simply stops working until the extension is fixed and zut is
184restarted.
185
186## Wire format
187
188All frames are one JSON object per line. Top-level `type` is the
189discriminator. Optional `id` correlates request frames with their
190responses. The canonical startup order is `hello`, `hello_ack`,
191registration frames, then `ready`. Do not send `notify`, `alert`, logs,
192or any other stdout frame before `hello`.
193
194### Extension → host
195
196#### `hello` (required, first frame)
197
198```json
199{"type":"hello","protocol_version":2,"name":"weather","version":"1.0.0",
200 "capabilities":["commands","tools","alerts","panels"]}
201```
202
203#### `register_command`
204
205```json
206{"type":"register_command","name":"weather",
207 "description":"current weather for a city"}
208```
209
210Command names are matched case-insensitively. zut sends `command_invoked.name` using the canonical spelling registered here. Registrations that differ only by case conflict, and the first registration remains active.
211
212#### `register_tool`
213
214Registers a tool the LLM can call. `schema` is a JSON Schema object
215describing the tool's args (the same shape Anthropic and OpenAI accept).
216
217```json
218{"type":"register_tool","name":"weather",
219 "description":"Get the current weather for a city.",
220 "schema":{
221   "type":"object",
222   "properties":{"city":{"type":"string"}},
223   "required":["city"]
224 }}
225```
226
227Tool names live in the same namespace as built-in tools (`read`,
228`write`, `edit`, `bash`, `create_worktree`, `grep`, `lsp`, `web_search`, `skill`).
229Conflicts with active built-ins are silently shadowed by the built-in. The
230native `web_search` name is reserved even when the setting disables that
231built-in, so an extension cannot claim or replace it. The `grep` name is
232reserved even when `Args.NoTools`/SDK `Config.NoTools` or an explicit
233`Args.Tools`/SDK `Config.Tools` allowlist disables the native search tool, so
234an extension cannot claim or replace it.
235
236Set `"deferred": true` to register a tool without advertising its definition initially. A loader tool can activate registered deferred tools by returning their names in `activate_tools`:
237
238```json
239{"type":"tool_result","id":"...",
240 "content":[{"type":"text","text":"Enabled weather lookup"}],
241 "activate_tools":["weather"]}
242```
243
244On Kimi K3's OpenAI-compatible routes, zut places newly activated schemas at the tool-result position using Kimi's native deferred-tool format. Other models receive the complete active tool list on the next request. Unknown names are ignored. The Go extension SDK exposes `DeferredTool` and `ToolResult.ActivateTools` for the same protocol.
245
246#### `ready`
247
248Sentinel telling zut "all initial registrations are flushed". Send it
249right after your last `register_*` frame so the host can build the
250agent's tool registry without racing the registration window.
251
252```json
253{"type":"ready"}
254```
255
256#### `tool_result`
257
258Reply to a `tool_call` from the host. `content[]` is a list of
259message blocks; each block is `{"type":"text","text":"..."}` or
260`{"type":"image","mime_type":"image/png","data":"<base64>"}`. Set
261`is_error: true` to mark the call as failed. `activate_tools` can name
262registered deferred tools that become available after this result.
263
264```json
265{"type":"tool_result","id":"...",
266 "content":[{"type":"text","text":"Berlin: 16°C, fog"}],
267 "details":{"state":{"version":1}}}
268```
269
270`details` is opaque extension metadata. Zut excludes it from provider
271requests and persists it as the latest extension state for the active
272session branch. Keep it valid JSON and reasonably small; the host caps
273persisted snapshots at 256 KiB. The next `session_opened`,
274`session_switched`, `session_forked`, or `session_compacted` event returns
275the extension's own snapshot in `state`.
276
277#### `subscribe`
278
279Declares which lifecycle events the extension wants to observe and
280which it wants to intercept. Send once after `hello`, before `ready`.
281
282```json
283{"type":"subscribe",
284 "events":["session_start","turn_start","tool_call","tool_confirmation_requested","turn_end","assistant_message"],
285 "intercept":["tool_call","turn_start","assistant_message"]}
286```
287
288Recognised event names include `session_start`, `session_opened`,
289`session_switched`, `session_forked`, `session_compacted`, `turn_start`,
290`tool_call`, `tool_confirmation_requested`, `assistant_message`, and
291`turn_end`.
292
293Session events contain `session` with the current branch ID, parent ID,
294path, cwd, and fork point. They also contain `state`, but only for the
295receiving extension. Zut never exposes another extension's state.
296
297`tool_confirmation_requested` fires only when zut is about to wait for
298interactive approval. Calls running in yolo mode, calls covered by a
299remembered approval, and calls blocked before confirmation do not emit it.
300The event includes `tool_id`, `tool_name`, and the short `tool_preview`
301shown in the confirmation dialog.
302
303Interceptable events:
304
305- `tool_call`: block the call (model sees `reason` as the tool
306  error) or rewrite args via `modified_args`.
307- `turn_start`: block the turn before the model is called. Useful
308  for rate-limiting and business-hour gates. `reason` is shown to
309  the user as a status line. No rewrite supported.
310- `assistant_message`: suppress the message via `block`, or rewrite
311  the user-visible text via `replace_text`. The model's original
312  text stays in the transcript so the model sees what it actually
313  said on subsequent turns.
314
315#### `event_intercept_response`
316
317Reply to an `event_intercept` from the host. All fields default to
318"allow, pass through unmodified".
319
320| field | meaning |
321|---|---|
322| `block` | `true` refuses the action. For `tool_call`, `reason` is shown to the model; for `turn_start` / `assistant_message`, `reason` is shown to the user. |
323| `reason` | refusal text (on block) or pass-through note. |
324| `modified_args` | for `tool_call`: rewritten JSON args the tool will actually see. Must be a valid JSON object. Ignored when `block` is true. Rewrites replace the complete argument object; for `bash`, preserve the required positive integer `timeout` when changing `command`. |
325| `replace_text` | for `assistant_message`: replaces the user-visible text. The model's original output still lives in the transcript. Ignored when `block` is true. |
326| `context` | for `turn_start`: bounded hidden context sent only in the upcoming provider request. It is not a user message and is not persisted in the transcript. |
327
328Missing the response within 5s is treated as "allow" (i.e. an
329unresponsive extension never stalls the agent). When multiple
330extensions subscribe to the same event, they're consulted serially;
331the first `block` wins and rewrites (args / text) chain: each
332subsequent interceptor sees the previous one's output.
333
334```json
335{"type":"event_intercept_response","id":"...",
336 "block":true,"reason":"refused: matches danger pattern \"rm -rf\""}
337
338{"type":"event_intercept_response","id":"...",
339 "modified_args":{"command":"echo GUARDED: ls","timeout":30}}
340
341{"type":"event_intercept_response","id":"...",
342 "replace_text":"[redacted]"}
343
344{"type":"event_intercept_response","id":"...",
345 "context":"Current phase: parse files\nRemaining: validate inputs"}
346```
347
348#### `command_response` (reply to `command_invoked`)
349
350```json
351{"type":"command_response","id":"...","action":"prompt",
352 "prompt":"Show today's weather for Berlin in one line."}
353```
354
355`action` is one of:
356
357- `"prompt"` — submits `prompt` as a fresh user message; the agent
358  runs a turn against it.
359- `"insert"` — inserts `insert` into the editor at the cursor without
360  submitting.
361- `"display"` — appends `display` to the chat as a one-shot styled
362  note. No model call, nothing written to the transcript.
363- `"open_panel"` — opens an extension-owned interactive panel inside
364  zut. The panel content lives in `open_panel`.
365- `"noop"` — the extension handled it itself (e.g. it pushed
366  `notify` frames or kicked off background work). zut doesn't change
367  the UI in response.
368
369Example:
370
371```json
372{"type":"command_response","id":"...","action":"open_panel",
373 "open_panel":{
374   "id":"todos-main",
375   "title":"Todos",
376   "lines":["□ ship panel api","✓ persist state"],
377   "footer":"↑/↓ navigate - a add - x complete - esc close"
378 }}
379```
380
381If `error` is non-empty, zut renders it as a red status line
382regardless of `action`.
383
384#### `submit` (one-way, any time)
385
386Submits text as a user prompt in the interactive host. If the agent is
387idle, zut starts a turn immediately. If a turn is already running, zut
388queues the prompt behind it using the same queue path as typed input.
389Empty or whitespace-only text is ignored.
390
391```json
392{"type":"submit","text":"Summarize the selected workspace."}
393```
394
395In print / JSON / RPC modes this frame is ignored because there is no
396interactive editor or prompt queue.
397
398#### `panel_render` (one-way, while a panel is open)
399
400Pushes a fresh frame for an already-open panel.
401
402```json
403{"type":"panel_render","panel_id":"todos-main",
404 "title":"Todos",
405 "lines":["□ ship panel api","✓ persist state"],
406 "footer":"↑/↓ navigate - a add - x complete - esc close"}
407```
408
409#### `panel_close`
410
411Closes a previously-open panel.
412
413```json
414{"type":"panel_close","panel_id":"todos-main"}
415```
416
417#### `status` (one-way, persistent)
418
419Sets or replaces one status item owned by the extension. Sending an empty
420`text` clears the item.
421
422```json
423{"type":"status","key":"progress","level":"success",
424 "text":"2/4 tasks checked"}
425```
426
427#### `widget` (one-way, persistent)
428
429Sets or replaces a compact widget. `position` is a host-defined placement
430hint with these interactive-zut values:
431
432- `"above_input"` keeps the widget in the existing persistent chrome above
433  the editor.
434- `"right_bar"` keeps the widget in a display-only side rail beside the
435  transcript when the terminal is wide enough.
436
437The host owns right-bar layout: it orders widgets, bounds width and height,
438and truncates content. Narrow terminals and `Ctrl+B` use a bounded
439`above_input` fallback. Empty or unknown positions keep the historical
440`above_input` behavior. Use `open_panel` for interaction or navigation.
441
442```json
443{"type":"widget","id":"plan","position":"right_bar",
444 "title":"Tasked phases","lines":["Current phase: parse","[ ] validate inputs"]}
445```
446
447#### `widget_clear` (one-way)
448
449```json
450{"type":"widget_clear","id":"plan"}
451```
452
453#### `notify` (one-way, any time)
454
455```json
456{"type":"notify","level":"info",
457 "message":"refreshed cache (12 entries)"}
458```
459
460`level` is one of `info`, `success`, `warn`, `error`. The note shows
461up below the transcript with the extension's name in brackets. Notes
462are one-shot: they clear automatically when the user sends their next
463prompt (and on `esc` / `/clear`).
464
465#### `alert` (one-way, any time)
466
467Requests a host-owned structured alert. The first supported kind is
468`bell`, which asks the interactive terminal to emit one terminal bell.
469`reason` is semantic metadata and is not rendered as terminal text.
470The shared terminal-alert setting in `/settings` applies to extension
471alerts too; disabled or non-interactive hosts may ignore the request.
472
473```json
474{"type":"alert","kind":"bell","reason":"question_ready"}
475```
476
477The Go SDK sends the same frame with:
478
479```go
480e.Alert(ext.AlertRequest{Kind: ext.AlertKindBell, Reason: "question_ready"})
481```
482
483Extensions must not write BEL, ANSI, or other terminal bytes to stdout;
484stdout is reserved for protocol frames. In `--mode rpc`, this becomes an
485`ext_alert` JSON event for the RPC client to interpret.
486
487#### `clear_notes` (one-way, any time)
488
489Removes every note this extension previously pushed via `notify` /
490`display`. Use it for transient status lines (e.g. an approval prompt)
491so they do not stack up; notes from other extensions are untouched.
492
493```json
494{"type":"clear_notes"}
495```
496
497In `--mode rpc`, this surfaces to the host as an `ext_clear_notes`
498event (alongside `ext_notify` / `ext_display`).
499
500#### `shutdown_ack`
501
502Sent in response to `shutdown`. Extension should exit promptly after.
503
504### Host → extension
505
506#### `hello_ack`
507
508```json
509{"type":"hello_ack","protocol_version":2,
510 "zut_version":"0.0.7","provider":"anthropic",
511 "model":"claude-opus-4-7","cwd":"/path/to/zut",
512 "extension_dir":"/path/to/zut/.zut/extensions/todos",
513 "data_dir":"/path/to/zut/.zut/extensions/todos",
514 "session":{"id":"branch-1","parent_id":"root-1",
515             "path":".../session.jsonl","cwd":"/path/to/zut",
516             "fork_point":4}}
517```
518
519Sent immediately after a matching `hello`. The protocol version is a
520major and must match the version sent by the extension. Wait for this frame
521before sending registrations if they depend on host metadata. The extension can use
522these fields to decide which commands to register (e.g. only register
523a Python tool on macOS, only register a model-specific shortcut for
524opus, etc.). `cwd` is the user's project directory; the extension
525process itself runs from the extension directory, so do not use
526`os.Getwd()` or `process.cwd()` when you need the project path.
527`extension_dir` / `data_dir` are where the extension should persist
528its own state (for example `todos.json`, cached metadata, or auth
529tokens scoped to that extension).
530
531#### `command_invoked`
532
533```json
534{"type":"command_invoked","id":"...",
535 "name":"weather","args":"berlin"}
536```
537
538`args` is everything the user typed after the command name, trimmed.
539
540#### `tool_call`
541
542Sent when the LLM invokes a tool the extension registered. `args` is
543the parsed JSON object the model produced; the extension is
544responsible for validating/coercing it.
545
546```json
547{"type":"tool_call","id":"...","name":"weather",
548 "args":{"city":"Berlin"}}
549```
550
551Reply with `tool_result` within the host's tool timeout (default 60s).
552Missing the timeout surfaces an error to the model and the call is
553marked as failed.
554
555#### `event`
556
557Lifecycle notification for events the extension subscribed to via
558`subscribe`. One-way — no response expected.
559
560```json
561{"type":"event","event":"session_opened",
562 "session":{"id":"branch-1","parent_id":"root-1","fork_point":4},
563 "state":{"version":1}}
564{"type":"event","event":"turn_start","step":1}
565{"type":"event","event":"tool_call",
566 "tool_id":"...","tool_name":"read","tool_args":{"path":"foo.go"}}
567{"type":"event","event":"tool_confirmation_requested",
568 "tool_id":"...","tool_name":"read","tool_preview":"foo.go"}
569{"type":"event","event":"turn_end","stop":"end_turn"}
570```
571
572#### `event_intercept`
573
574Sent when zut wants to give the extension a chance to block, modify,
575or annotate a lifecycle event before it happens. Reply with
576`event_intercept_response` within 5s; missing the deadline is
577treated as "allow".
578
579Payload fields depend on the event:
580
581```json
582// tool_call: includes the tool id, name, and parsed args
583{"type":"event_intercept","id":"...","event":"tool_call",
584 "tool_id":"...","tool_name":"bash",
585 "tool_args":{"command":"rm -rf /tmp/foo","timeout":30}}
586
587// turn_start: includes the step number
588{"type":"event_intercept","id":"...","event":"turn_start",
589 "step":3}
590
591// assistant_message: includes the assembled text
592{"type":"event_intercept","id":"...","event":"assistant_message",
593 "text":"here is your api key: sk-ant-..."}
594```
595
596#### `panel_key`
597
598Sent while an extension-owned panel is focused. `key` is a normalized
599name (`up`, `down`, `left`, `right`, `enter`, `esc`, `tab`, `pageup`,
600`pagedown`, `home`, `end`, `backspace`, `delete`, `rune`). For
601`key:"rune"`, `text` carries the typed character.
602
603```json
604{"type":"panel_key","panel_id":"todos-main","key":"down"}
605{"type":"panel_key","panel_id":"todos-main","key":"rune","text":"x"}
606```
607
608#### `panel_close`
609
610Sent when the user closes the focused panel from zut (for example with
611Esc or Ctrl+C). The extension should treat this as the panel lifetime
612ending and stop sending `panel_render` updates for that `panel_id`.
613
614```json
615{"type":"panel_close","panel_id":"todos-main"}
616```
617
618#### `shutdown`
619
620Sent during graceful zut exit (or `/reload-ext` once that lands).
621Reply with `shutdown_ack` and then exit.
622
623## Managing extensions from the CLI
624
625```
626zut ext list                              list installed extensions and their state
627zut ext doctor                            diagnose load, registration, and conflict issues
628zut ext install <path|git-url>             copy / clone into $ZUT_HOME/extensions/
629zut ext install --build=go <local-path>   build local Go source, then install
630zut ext remove <name>                     delete an extension directory
631zut ext enable <name>           re-enable a disabled extension
632zut ext disable <name>          disable without removing
633zut ext logs <name> [-f]        cat / tail the extension's stderr
634```
635
636`zut ext doctor` runs the same discovery path as zut startup, but reports
637what happened instead of changing the fail-soft runtime behavior. It shows
638manifest errors, disabled or shadowed extensions, subprocess load errors,
639ready/auto-ready status, registered commands/tools, registration conflicts,
640warnings, and each extension's stderr log path.
641
642`zut ext install <path>` does a recursive copy; `<git-url>` does a
643shallow clone. Both validate that the destination contains an
644`extension.json` and roll back if not. No build runs unless the local install
645is invoked with the explicit `--build=go` option. That option currently supports
646only local Go source paths; clone remote source locally before building it.
647
648## Loading an extension for one run
649
650For iteration on a working copy, skip the install + reload cycle
651and load straight from disk for one zut session:
652
653```
654zut --ext ./my-extension        # short form: -e ./my-extension
655zut --ext ./a -e ./b            # repeatable
656```
657
658`--ext` paths take precedence over installed extensions of the same
659name, so you can shadow an installed copy with a work-in-progress
660version without uninstalling first. Nothing is copied or persisted;
661the extension dies with zut like any other subprocess.
662
663## SDKs
664
665Writing the wire protocol by hand is fine for one-off scripts, but
666for anything bigger the SDKs handle the boilerplate.
667
668### Go — `packages/agent/ext`
669
670```go
671package main
672
673import (
674    "encoding/json"
675    "github.com/bnema/zut/packages/agent/ext"
676)
677
678func main() {
679    e := ext.New("hello", "1.0.0")
680
681    // Slash command
682    e.Command("hello", "say hi", func(args string) ext.Response {
683        return ext.Prompt("Greet me in one short sentence.")
684    })
685
686    // LLM-callable tool
687    e.Tool("weather", "Current weather for a city.",
688        json.RawMessage(`{"type":"object","properties":{"city":{"type":"string"}},"required":["city"]}`),
689        func(args json.RawMessage) ext.ToolResult {
690            var in struct{ City string `json:"city"` }
691            json.Unmarshal(args, &in)
692            return ext.TextResult(in.City + ": sunny")
693        })
694
695    // Optional: register project-specific commands after hello_ack.
696    e.OnHello(func(host ext.HostInfo) {
697        if host.CWD != "" {
698            e.Command("cwd", "show the current project directory", func(args string) ext.Response {
699                return ext.Display(host.CWD)
700            })
701        }
702    })
703
704    e.Run()
705}
706```
707
708Build with `go build -o hello .`, drop the binary + an `extension.json`
709into `$ZUT_HOME/extensions/hello/`.
710
711`OnHello` is optional. Use it when configuration or registrations need
712host metadata such as `HostInfo.CWD`, `Provider`, `Model`, `ZutVersion`,
713`ExtensionDir`, or `DataDir`. The SDK sends `hello`, waits for
714`hello_ack`, runs `OnHello`, announces registrations, then sends `ready`.
715
716Session-aware extensions can subscribe to `session_opened`,
717`session_switched`, `session_forked`, and `session_compacted`; `Event.Session`
718identifies the active branch and `Event.State` contains that extension's
719latest persisted snapshot. A tool can return opaque state with
720`result.Details = ext.JSONDetails(value)`.
721
722`TurnStartDecision.Context` supplies hidden bounded context for the next model
723request. `SetStatus`, `SetWidget`, and their clear methods update persistent
724interactive chrome without entering the transcript.
725
726For Go extensions, use the SDK constants so the host can choose the responsive
727layout without extension-specific terminal code:
728
729```go
730e.SetWidget("plan", ext.WidgetPositionRightBar, "Tasked phases", lines)
731e.ClearWidget("plan")
732```
733
734The SDK has four interceptor hooks, all optional:
735
736```go
737// e is the *ext.Extension returned by ext.New(...).
738
739// Refuse calls or rewrite args before they run.
740e.InterceptToolCall(func(tool string, args json.RawMessage) (bool, string) {
741    if tool == "bash" { /* inspect args, return false, reason */ }
742    return true, ""
743})
744
745// Richer variant: returns ToolCallDecision so you can also rewrite
746// args via ModifiedArgs.
747e.InterceptToolCallX(func(tool string, args json.RawMessage) ext.ToolCallDecision {
748    return ext.ToolCallDecision{
749        ModifiedArgs: json.RawMessage(`{"command":"echo GUARDED","timeout":30}`),
750    }
751})
752
753// Block the next turn before the model is called.
754e.InterceptTurnStart(func(step int) ext.TurnStartDecision {
755    if time.Now().Hour() < 9 { return ext.TurnStartDecision{Block: true, Reason: "outside business hours"} }
756    return ext.TurnStartDecision{}
757})
758
759// Scrub or rewrite the assistant's final text before the user sees it.
760e.InterceptAssistantMessage(func(text string) ext.AssistantMessageDecision {
761    return ext.AssistantMessageDecision{
762        ReplaceText: strings.ReplaceAll(text, "SECRET", "[redacted]"),
763    }
764})
765```
766
767See:
768- `examples/extensions/hello/` — slash commands
769- `examples/extensions/clock/` — slash commands in plain Node, no SDK
770- `examples/extensions/weather/` — LLM-callable tool
771- `examples/extensions/guard/` — event subscriptions + tool-call
772  interception (refuses dangerous bash patterns)
773- `examples/extensions/todo/` — interactive persistent panel + tool
774- `examples/extensions/tasked-phases/` — spec, phased checklist, persistent tool, and `/phases` panel
775- `examples/extensions/scratchpad/` — source-run TypeScript commands + tool
776
777The `tasked-phases` example bundles its companion skill under
778`examples/extensions/tasked-phases/skills/` and declares it in
779`extension.json`. Installing the extension therefore installs the workflow
780skill automatically. The standalone copy at `examples/skills/tasked-phases/`
781remains useful for project-local skill installation. Its state is restored per
782session branch when zut session persistence is enabled; the extension keeps a
783project-file fallback for hosts that do not persist sessions.
784
785### Hot reload
786
787Type `/reload-ext` in the TUI to tear down every running extension
788subprocess, re-read the manifests from disk, and respawn the set.
789The agent's tool registry is rebuilt automatically, so freshly-
790registered extension tools become callable without restarting zut.
791Useful while developing an extension: edit, save, `/reload-ext`,
792done. Explicit `--ext` paths are remembered and reloaded alongside
793discovered extensions. The temporary reload status reports each load
794error in red, including its message, and dismisses itself after five
795seconds. Extension failures from startup and `/reload-ext` remain in the
796scrolling chat until a successful reload or `/clear`, without being sent to
797the model or saved in the session transcript. Subprocess startup and
798handshake errors include the exact stderr log path for the failed extension.
799If a subprocess exits before sending `hello`, the error also reports its exit
800status or terminating signal.
801
802### TypeScript / Python
803
804These SDKs aren't in the main repo yet; the wire format is small
805enough that a `~30 line` raw script gets you started in either
806language. See the [Quick start](#quick-start) Python example for the
807shape. SDK packages will land in follow-up commits.
808
809## Security
810
811Extensions run with **the user's full filesystem and network
812permissions**. Treat installing an extension the same as installing
813any other binary on your machine.
814
815`zut ext install <git-url>` clones from any URL you give it. There's
816no sandbox in v1; if you need isolation, install only extensions you
817trust or run zut under your platform's sandboxing tool (`bwrap` /
818`sandbox-exec` / AppContainer).
819
820## Roadmap
821
822Phase 1 (shipped):
823- [x] subprocess lifecycle + hello handshake
824- [x] `register_command` + `command_invoked`
825- [x] `notify` + `clear_notes` + structured terminal alerts
826- [x] `zut ext` CLI
827
828Phase 2 (shipped):
829- [x] `register_tool` + `tool_call` + `tool_result`
830- [x] `ready` sentinel for safe agent-registry build timing
831- [x] tool result attribution surfaces extension name in details
832
833Phase 3 (shipped):
834- [x] event subscriptions (`session_start`, `session_opened`,
835      `session_switched`, `session_forked`, `session_compacted`, `turn_start`,
836      `turn_end`, `tool_call`, `assistant_message`)
837- [x] tool-call interception (block before execution)
838
839Phase 4 (shipped):
840- [x] interception for `turn_start` and `assistant_message` (in
841      addition to `tool_call`)
842- [x] modify tool args mid-flight via `modified_args`
843- [x] rewrite user-visible assistant text via `replace_text`
844- [x] `/reload-ext` slash command (hot-reload without restarting zut)
845
846Phase 5 (shipped):
847- [x] session/branch identity in `hello_ack` and lifecycle events
848- [x] session open/switch/fork/compaction notifications
849- [x] opaque extension state persisted with session branches
850
851Phase 6 (shipped):
852- [x] hidden bounded context returned from `turn_start` interception
853- [x] persistent extension status and widget frames
854- [x] manifest-declared bundled skill discovery with safe path validation
855
856Future (no firm timeline):
857- [ ] TypeScript and Python SDK packages (currently the wire format
858      is stable enough to hand-roll, see the Python quick-start)
859- [ ] HTTP / WebSocket transport variants (today: subprocess stdio)
860- [ ] per-extension permission scopes (today: full user privileges)

Keyboard shortcuts

Single-key shortcuts are on. ctrl k and esc work whatever this says.

ctrl k :
go to a section, branch, tag, file or repository
?
this list
j k
move the row cursor down / up
enter
open the row under the cursor; on Files, a directory opens or closes in place
↑ ↓ ← → home end
in the file tree (focus on a row): previous / next row, close / open a directory or go to its parent / first entry, first / last row. They never open a file
l h
on Files: open a directory or a file / close a directory or go up to its parent, then to the parent page. Elsewhere: into the side panel (on a merge request, its files) / back to the content; there j k move between its controls
g g G
first / last row
/
filter the list; on Files, find a file anywhere in the repository (esc clears, enter opens the best match)
b
switch branch or tag
g s g f g c g b g m g i g r g a
tabs: summary, files, commits, branches & tags, merge requests, issues, releases, actions (when available)
g h
home
w
wide mode: use the whole width of the screen, or not (remembered)
y
copy a permalink pinned to the commit
d u x
diff: split / unified / collapse or expand all
e E
diff: the whole file in view / every file, with the lines the hunks hide
n
merge request: next note in the diff
esc
close a dialog, leave a field

Branches 1

Tags 476

↑↓ moveenter openesc close