Commands
run-kitrun-kit — tmux session manager with web UI
usage
run-kit [flags]run-kit [command]
flags
| flag | type | description | copy |
|---|---|---|---|
--quiet | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit [flags]
run-kit [command]
Available Commands:
agent Agent instrumentation (state hooks setup and reporting)
board List boards and pin/unpin/reorder windows on them (needs rk serve up)
code Run VS Code commands in the code lens editor from the shell
code-server Manage the rk-owned code-server install (the /code lens editor)
completion Generate the autocompletion script for the specified shell
cron Scheduled agent prompts (add, edit, list, rm, mute, pin, tick)
daemon Manage the background run-kit daemon (tmux-managed run-kit serve)
desktop Install and update the Run Kit desktop app (macOS, Linux)
doctor Check runtime dependencies
gui Manage the host GUI surface (the rk-gui desktop session)
help Help about any command
mcp Serve run-kit's MCP tools over stdio (connector command: ssh <box> rk mcp)
mux Tmux substrate operations (server create, messaging, pane capture/kill/process, pane/session enumeration, janitor, recovery, config scaffold, tmux guard)
notify Send a Web Push notification to subscribed devices
operator Open the operator — the server-wide orchestrator agent tab (singleton)
present Show a file, directory, port, or URL to the user as a web tile
remote Use SSH-only machines as run-kit hosts (bootstrap, tunnel, connect)
riff Create a worktree, tmux window, and Claude Code session
role Mark or unmark the current window as the server's operator
serve Start the HTTP server (foreground)
skill Print run-kit's agent skill bundle (static usage briefing)
status Show tmux session summary
tab Drive a tab's UI state — layout, web tabs, code root, signals — from the shell
tutorial Open the guided tour — an agent-run tutorial tab in this session
update Update the run-kit CLI and desktop app to the latest version
url Print the run-kit server URL (env → tmux option → default)
Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
Use "run-kit [command] --help" for more information about a command.
run-kit agentAgent instrumentation (state hooks setup and reporting)
usage
run-kit agent [command]
flags
| flag | type | description | copy |
|---|---|---|---|
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit agent [command]
Available Commands:
hook Report an agent's lifecycle state to run-kit (invoked by installed hooks)
setup Install agent-harness hooks that report agent state to run-kit
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
Use "run-kit agent [command] --help" for more information about a command.
run-kit agent hookReport an agent's lifecycle state to run-kit (invoked by installed hooks)
usage
run-kit agent hook <state> [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--agent | string | Agent harness provider whose registry entry drives payload parsing and pid resolution (claude, codex, gemini, copilot, kimi, opencode, agy) (default "claude") | |
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit agent hook <state> [flags]
Flags:
--agent string Agent harness provider whose registry entry drives payload parsing and pid resolution (claude, codex, gemini, copilot, kimi, opencode, agy) (default "claude")
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit agent setupInstall agent-harness hooks that report agent state to run-kit
usage
run-kit agent setup [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--dry-run | Show the diff and write nothing (wins over --yes) | ||
--uninstall | Remove the rk-owned hook entries instead of installing them | ||
-y, --yes | Write without prompting (non-interactive consent) | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit agent setup [flags]
Flags:
--dry-run Show the diff and write nothing (wins over --yes)
--uninstall Remove the rk-owned hook entries instead of installing them
-y, --yes Write without prompting (non-interactive consent)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit boardList boards and pin/unpin/reorder windows on them (needs rk serve up)
usage
run-kit board [command]
flags
| flag | type | description | copy |
|---|---|---|---|
--after | string | reorder only: place the window after this neighbour (@N); neither flag appends | |
--before | string | reorder only: place the window before this neighbour (@N) | |
--json | Print the route body (show) or the {board, window[, orderKey]} receipt as JSON | ||
-L, --server | string | tmux server name the window lives on (default: the caller's own server from $TMUX, else the default server); applies to pin/unpin/reorder | |
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit board [command]
Available Commands:
pin Pin a window to a board
reorder Move a pinned window within a board
show List boards, or one board's pinned windows
unpin Remove a window from a board
Flags:
--after string reorder only: place the window after this neighbour (@N); neither flag appends
--before string reorder only: place the window before this neighbour (@N)
--json Print the route body (show) or the {board, window[, orderKey]} receipt as JSON
-L, --server string tmux server name the window lives on (default: the caller's own server from $TMUX, else the default server); applies to pin/unpin/reorder
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
Use "run-kit board [command] --help" for more information about a command.
run-kit board pinPin a window to a board
usage
run-kit board pin <name> <@N|=session:window> [--json] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--afterglobal | string | reorder only: place the window after this neighbour (@N); neither flag appends | |
--beforeglobal | string | reorder only: place the window before this neighbour (@N) | |
--jsonglobal | Print the route body (show) or the {board, window[, orderKey]} receipt as JSON | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name the window lives on (default: the caller's own server from $TMUX, else the default server); applies to pin/unpin/reorder |
No flags match that filter.
show raw -h output
Usage:
run-kit board pin <name> <@N|=session:window> [--json] [flags]
Global Flags:
--after string reorder only: place the window after this neighbour (@N); neither flag appends
--before string reorder only: place the window before this neighbour (@N)
--json Print the route body (show) or the {board, window[, orderKey]} receipt as JSON
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name the window lives on (default: the caller's own server from $TMUX, else the default server); applies to pin/unpin/reorder
run-kit board reorderMove a pinned window within a board
usage
run-kit board reorder <name> <@N|=session:window> [--before @N] [--after @N] [--json] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--afterglobal | string | reorder only: place the window after this neighbour (@N); neither flag appends | |
--beforeglobal | string | reorder only: place the window before this neighbour (@N) | |
--jsonglobal | Print the route body (show) or the {board, window[, orderKey]} receipt as JSON | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name the window lives on (default: the caller's own server from $TMUX, else the default server); applies to pin/unpin/reorder |
No flags match that filter.
show raw -h output
Usage:
run-kit board reorder <name> <@N|=session:window> [--before @N] [--after @N] [--json] [flags]
Global Flags:
--after string reorder only: place the window after this neighbour (@N); neither flag appends
--before string reorder only: place the window before this neighbour (@N)
--json Print the route body (show) or the {board, window[, orderKey]} receipt as JSON
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name the window lives on (default: the caller's own server from $TMUX, else the default server); applies to pin/unpin/reorder
run-kit board showList boards, or one board's pinned windows
usage
run-kit board show [name] [--json] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--afterglobal | string | reorder only: place the window after this neighbour (@N); neither flag appends | |
--beforeglobal | string | reorder only: place the window before this neighbour (@N) | |
--jsonglobal | Print the route body (show) or the {board, window[, orderKey]} receipt as JSON | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name the window lives on (default: the caller's own server from $TMUX, else the default server); applies to pin/unpin/reorder |
No flags match that filter.
show raw -h output
Usage:
run-kit board show [name] [--json] [flags]
Global Flags:
--after string reorder only: place the window after this neighbour (@N); neither flag appends
--before string reorder only: place the window before this neighbour (@N)
--json Print the route body (show) or the {board, window[, orderKey]} receipt as JSON
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name the window lives on (default: the caller's own server from $TMUX, else the default server); applies to pin/unpin/reorder
run-kit board unpinRemove a window from a board
usage
run-kit board unpin <name> <@N|=session:window> [--json] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--afterglobal | string | reorder only: place the window after this neighbour (@N); neither flag appends | |
--beforeglobal | string | reorder only: place the window before this neighbour (@N) | |
--jsonglobal | Print the route body (show) or the {board, window[, orderKey]} receipt as JSON | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name the window lives on (default: the caller's own server from $TMUX, else the default server); applies to pin/unpin/reorder |
No flags match that filter.
show raw -h output
Usage:
run-kit board unpin <name> <@N|=session:window> [--json] [flags]
Global Flags:
--after string reorder only: place the window after this neighbour (@N); neither flag appends
--before string reorder only: place the window before this neighbour (@N)
--json Print the route body (show) or the {board, window[, orderKey]} receipt as JSON
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name the window lives on (default: the caller's own server from $TMUX, else the default server); applies to pin/unpin/reorder
run-kit codeRun VS Code commands in the code lens editor from the shell
usage
run-kit code [command]
flags
| flag | type | description | copy |
|---|---|---|---|
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit code [command]
Available Commands:
commands List the command ids a code-bridge host can execute
exec Execute a VS Code command in a code-bridge host
hosts List live code-bridge hosts
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
Use "run-kit code [command] --help" for more information about a command.
run-kit code commandsList the command ids a code-bridge host can execute
usage
run-kit code commands [--folder <path>] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--folder | string | Target host by workspace folder (default: git toplevel of the cwd) | |
--host | string | Target host by id (see rk code hosts) | |
--tabstring[=" | auto"] Target the host whose folder is the tab's @rk_win_code_root (bare --tab = the caller's own tab; pass @N for another) | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit code commands [--folder <path>] [flags]
Flags:
--folder string Target host by workspace folder (default: git toplevel of the cwd)
--host string Target host by id (see rk code hosts)
--tab string[=" auto"] Target the host whose folder is the tab's @rk_win_code_root (bare --tab = the caller's own tab; pass @N for another)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit code execExecute a VS Code command in a code-bridge host
usage
run-kit code exec <command> [json-arg…] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--all | Fan out to every live host | ||
--folder | string | Target host by workspace folder (default: git toplevel of the cwd) | |
--host | string | Target host by id (see rk code hosts) | |
--json | Print the bridge response nested under result in the {"ok","result"} envelope instead of the bare result | ||
--tabstring[=" | auto"] Target the host whose folder is the tab's @rk_win_code_root (bare --tab = the caller's own tab; pass @N for another; --all ignores it) | ||
--timeout | duration | Timeout the extension enforces on the command (the Go deadline adds 2s) (default 30s) | |
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit code exec <command> [json-arg…] [flags]
Flags:
--all Fan out to every live host
--folder string Target host by workspace folder (default: git toplevel of the cwd)
--host string Target host by id (see rk code hosts)
--json Print the bridge response nested under result in the {"ok","result"} envelope instead of the bare result
--tab string[=" auto"] Target the host whose folder is the tab's @rk_win_code_root (bare --tab = the caller's own tab; pass @N for another; --all ignores it)
--timeout duration Timeout the extension enforces on the command (the Go deadline adds 2s) (default 30s)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit code hostsList live code-bridge hosts
usage
run-kit code hosts [--json] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--json | Print the host records as a JSON array inside the {"ok","result"} envelope | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit code hosts [--json] [flags]
Flags:
--json Print the host records as a JSON array inside the {"ok","result"} envelope
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit code-serverManage the rk-owned code-server install (the /code lens editor)
usage
run-kit code-server [command]
flags
| flag | type | description | copy |
|---|---|---|---|
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit code-server [command]
Available Commands:
install Download the latest code-server release and activate it
start Start the daemon-managed code-server session now
update Update the managed code-server to the latest release
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
Use "run-kit code-server [command] --help" for more information about a command.
run-kit code-server installDownload the latest code-server release and activate it
usage
run-kit code-server install [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit code-server install [flags]
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit code-server startStart the daemon-managed code-server session now
usage
run-kit code-server start [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit code-server start [flags]
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit code-server updateUpdate the managed code-server to the latest release
usage
run-kit code-server update [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit code-server update [flags]
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit cronScheduled agent prompts (add, edit, list, rm, mute, pin, tick)
usage
run-kit cron [command]
flags
| flag | type | description | copy |
|---|---|---|---|
-L, --server | string | tmux server name (entry-file-scoped verbs: add/edit/list/rm/mute/pin; default: the caller's own server from $TMUX, else the default server) | |
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit cron [command]
Available Commands:
add Add a cron entry to the server's intent file
edit Edit a cron entry's schedule or policies in place
list List the server's cron entries (disk-derived; no tmux probes)
mute Mute a cron entry (skip its fires) — --for leases the mute, --off unmutes
pin Pin a cron entry (exempt from orphan expiry) — --off unpins
rm Remove a cron entry by id
tick Run one cron evaluation sweep across every live server
Flags:
-L, --server string tmux server name (entry-file-scoped verbs: add/edit/list/rm/mute/pin; default: the caller's own server from $TMUX, else the default server)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
Use "run-kit cron [command] --help" for more information about a command.
run-kit cron addAdd a cron entry to the server's intent file
usage
run-kit cron add <prompt> --every <dur> | --idle-every <dur> | --backoff | --cron "<expr>" [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--backoff | Fire on a backoff ladder keyed on the target pane's idle epoch — resets on genuine activity, continues otherwise (60s→30m by default; refine with --min/--max) | ||
--catch-up | string | With --cron: fire once late after a gap (only: once) | |
--cron | string | Fire on a 5-field cron expression (daemon local time, validated at add time) | |
--deliver | string | Delivery policy: immediate|when-idle|skip-if-busy (default "immediate") | |
--every | duration | Fire on a fixed interval (Go duration, e.g. 1h, 90s) | |
--idle-every | duration | Fire every <dur> of agent quiet: <dur> after the target pane last went idle for a reason other than the clock, then every <dur> while it stays idle (a flat backoff ladder, min = max) | |
--if-absent | string | Absent-target policy: skip|notify|respawn (default "skip") | |
--json | Emit the machine-readable envelope (exactly one JSON document on stdout) | ||
--max | duration | Backoff ladder maximum gap (with --backoff) (default 30m0s) | |
--min | duration | Backoff ladder minimum gap (with --backoff) (default 1m0s) | |
--name | string | Display name (default: a prompt prefix) | |
--pane | string | Target a pane id (%N) | |
--pinned | Pin the entry (exempt from orphan expiry) | ||
--respawn | stringArray | With --if-absent respawn: one argv element of the respawn command per occurrence (repeatable; {server} resolves to the entry's server at fire time) | |
--role | string | Target a server role (the @rk_win_role value, e.g. operator) | |
--session | string | Target an agent session ref (e.g. 4fe2abc-…) | |
--wake-debounce | duration | Hold a --wake-on fire this long after the entry's own newest delivery (default 1m0s) | |
--wake-on | string | Also fire on an actionable agent-state edge (only: agent-state-change) | |
--wake-scope | string | Fingerprint scope for --wake-on (only: server) (default "server") | |
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (entry-file-scoped verbs: add/edit/list/rm/mute/pin; default: the caller's own server from $TMUX, else the default server) |
No flags match that filter.
examples
rk cron add "check PRs" --every 1h
rk cron add "wake up" --idle-every 3m
rk cron add "tick" --backoff --min 2m --max 30m
rk cron add "nightly" --cron "0 3 * * *" --role operator
rk cron add "morning digest" --cron "0 9 * * *" --deliver skip-if-busy
rk cron add "operator tick" --backoff --min 3m --max 24m --wake-on agent-state-change --deliver skip-if-busy --role operator --if-absent respawn --respawn rk --respawn operator --respawn -L --respawn '{server}' --pinned
rk cron add "follow up" --every 2h --session 4fe2abc-1c3b-4f7e-9a2d-8b5c4e1f0a37show raw -h output
Usage:
run-kit cron add <prompt> --every <dur> | --idle-every <dur> | --backoff | --cron "<expr>" [flags]
Examples:
rk cron add "check PRs" --every 1h
rk cron add "wake up" --idle-every 3m
rk cron add "tick" --backoff --min 2m --max 30m
rk cron add "nightly" --cron "0 3 * * *" --role operator
rk cron add "morning digest" --cron "0 9 * * *" --deliver skip-if-busy
rk cron add "operator tick" --backoff --min 3m --max 24m --wake-on agent-state-change --deliver skip-if-busy --role operator --if-absent respawn --respawn rk --respawn operator --respawn -L --respawn '{server}' --pinned
rk cron add "follow up" --every 2h --session 4fe2abc-1c3b-4f7e-9a2d-8b5c4e1f0a37
Flags:
--backoff Fire on a backoff ladder keyed on the target pane's idle epoch — resets on genuine activity, continues otherwise (60s→30m by default; refine with --min/--max)
--catch-up string With --cron: fire once late after a gap (only: once)
--cron string Fire on a 5-field cron expression (daemon local time, validated at add time)
--deliver string Delivery policy: immediate|when-idle|skip-if-busy (default "immediate")
--every duration Fire on a fixed interval (Go duration, e.g. 1h, 90s)
--idle-every duration Fire every <dur> of agent quiet: <dur> after the target pane last went idle for a reason other than the clock, then every <dur> while it stays idle (a flat backoff ladder, min = max)
--if-absent string Absent-target policy: skip|notify|respawn (default "skip")
--json Emit the machine-readable envelope (exactly one JSON document on stdout)
--max duration Backoff ladder maximum gap (with --backoff) (default 30m0s)
--min duration Backoff ladder minimum gap (with --backoff) (default 1m0s)
--name string Display name (default: a prompt prefix)
--pane string Target a pane id (%N)
--pinned Pin the entry (exempt from orphan expiry)
--respawn stringArray With --if-absent respawn: one argv element of the respawn command per occurrence (repeatable; {server} resolves to the entry's server at fire time)
--role string Target a server role (the @rk_win_role value, e.g. operator)
--session string Target an agent session ref (e.g. 4fe2abc-…)
--wake-debounce duration Hold a --wake-on fire this long after the entry's own newest delivery (default 1m0s)
--wake-on string Also fire on an actionable agent-state edge (only: agent-state-change)
--wake-scope string Fingerprint scope for --wake-on (only: server) (default "server")
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (entry-file-scoped verbs: add/edit/list/rm/mute/pin; default: the caller's own server from $TMUX, else the default server)
run-kit cron editEdit a cron entry's schedule or policies in place
usage
run-kit cron edit <id> [--every <dur> | --idle-every <dur> | --backoff [--min <dur>] [--max <dur>] | --cron "<expr>" [--catch-up once]] [--deliver <policy>] [--name <n>] [--if-absent <policy>] [--respawn <arg>…] [--wake-on <event>|none [--wake-scope <s>] [--wake-debounce <dur>]] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--backoff | Replace the schedule with a backoff ladder (60s→30m by default; refine with --min/--max) | ||
--catch-up | string | With --cron: fire once late after a gap (only: once) | |
--cron | string | Replace the schedule with a 5-field cron expression (daemon local time) | |
--deliver | string | Replace the delivery policy: immediate|when-idle|skip-if-busy | |
--every | duration | Replace the schedule with a fixed interval (Go duration, e.g. 1h, 90s) | |
--idle-every | duration | Replace the schedule with a flat backoff ladder, min = max (fire every <dur> of agent quiet) | |
--if-absent | string | Replace the absent-target policy: skip|notify|respawn (a non-respawn value clears the respawn argv) | |
--max | duration | Backoff ladder maximum gap (with --backoff) (default 30m0s) | |
--min | duration | Backoff ladder minimum gap (with --backoff) (default 1m0s) | |
--name | string | Replace the display name | |
--respawn | stringArray | Replace the whole respawn argv (repeatable; requires --if-absent respawn) | |
--wake-debounce | duration | Hold a --wake-on fire this long after the entry's own newest delivery (default 1m0s) | |
--wake-on | string | Replace the whole wake_on block (only: agent-state-change); none|off clears it | |
--wake-scope | string | Fingerprint scope for --wake-on (only: server) (default "server") | |
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (entry-file-scoped verbs: add/edit/list/rm/mute/pin; default: the caller's own server from $TMUX, else the default server) |
No flags match that filter.
examples
rk cron edit a3f9 --idle-every 3m rk cron edit a3f9 --deliver skip-if-busy rk cron edit a3f9 --backoff --min 2m --max 10m rk cron edit a3f9 --wake-on agent-state-change --wake-debounce 2m rk cron edit a3f9 --wake-on none rk cron edit a3f9 --name "morning digest"
show raw -h output
Usage:
run-kit cron edit <id> [--every <dur> | --idle-every <dur> | --backoff [--min <dur>] [--max <dur>] | --cron "<expr>" [--catch-up once]] [--deliver <policy>] [--name <n>] [--if-absent <policy>] [--respawn <arg>…] [--wake-on <event>|none [--wake-scope <s>] [--wake-debounce <dur>]] [flags]
Examples:
rk cron edit a3f9 --idle-every 3m
rk cron edit a3f9 --deliver skip-if-busy
rk cron edit a3f9 --backoff --min 2m --max 10m
rk cron edit a3f9 --wake-on agent-state-change --wake-debounce 2m
rk cron edit a3f9 --wake-on none
rk cron edit a3f9 --name "morning digest"
Flags:
--backoff Replace the schedule with a backoff ladder (60s→30m by default; refine with --min/--max)
--catch-up string With --cron: fire once late after a gap (only: once)
--cron string Replace the schedule with a 5-field cron expression (daemon local time)
--deliver string Replace the delivery policy: immediate|when-idle|skip-if-busy
--every duration Replace the schedule with a fixed interval (Go duration, e.g. 1h, 90s)
--idle-every duration Replace the schedule with a flat backoff ladder, min = max (fire every <dur> of agent quiet)
--if-absent string Replace the absent-target policy: skip|notify|respawn (a non-respawn value clears the respawn argv)
--max duration Backoff ladder maximum gap (with --backoff) (default 30m0s)
--min duration Backoff ladder minimum gap (with --backoff) (default 1m0s)
--name string Replace the display name
--respawn stringArray Replace the whole respawn argv (repeatable; requires --if-absent respawn)
--wake-debounce duration Hold a --wake-on fire this long after the entry's own newest delivery (default 1m0s)
--wake-on string Replace the whole wake_on block (only: agent-state-change); none|off clears it
--wake-scope string Fingerprint scope for --wake-on (only: server) (default "server")
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (entry-file-scoped verbs: add/edit/list/rm/mute/pin; default: the caller's own server from $TMUX, else the default server)
run-kit cron listList the server's cron entries (disk-derived; no tmux probes)
usage
run-kit cron list [--json] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--json | Output as JSON | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (entry-file-scoped verbs: add/edit/list/rm/mute/pin; default: the caller's own server from $TMUX, else the default server) |
No flags match that filter.
examples
rk cron list rk cron list -L work --json
show raw -h output
Usage:
run-kit cron list [--json] [flags]
Examples:
rk cron list
rk cron list -L work --json
Flags:
--json Output as JSON
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (entry-file-scoped verbs: add/edit/list/rm/mute/pin; default: the caller's own server from $TMUX, else the default server)
run-kit cron muteMute a cron entry (skip its fires) — --for leases the mute, --off unmutes
usage
run-kit cron mute <id> [--for <dur>] [--off] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--for | duration | Mute until now+<dur> (a self-expiring lease; positive Go duration; mutually exclusive with --off) | |
--json | Emit the machine-readable envelope (exactly one JSON document on stdout) | ||
--off | Unmute instead of mute | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (entry-file-scoped verbs: add/edit/list/rm/mute/pin; default: the caller's own server from $TMUX, else the default server) |
No flags match that filter.
examples
rk cron mute a3f9 rk cron mute a3f9 --for 30m rk cron mute a3f9 --off
show raw -h output
Usage:
run-kit cron mute <id> [--for <dur>] [--off] [flags]
Examples:
rk cron mute a3f9
rk cron mute a3f9 --for 30m
rk cron mute a3f9 --off
Flags:
--for duration Mute until now+<dur> (a self-expiring lease; positive Go duration; mutually exclusive with --off)
--json Emit the machine-readable envelope (exactly one JSON document on stdout)
--off Unmute instead of mute
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (entry-file-scoped verbs: add/edit/list/rm/mute/pin; default: the caller's own server from $TMUX, else the default server)
run-kit cron pinPin a cron entry (exempt from orphan expiry) — --off unpins
usage
run-kit cron pin <id> [--off] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--off | Unpin instead of pin | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (entry-file-scoped verbs: add/edit/list/rm/mute/pin; default: the caller's own server from $TMUX, else the default server) |
No flags match that filter.
examples
rk cron pin a3f9 rk cron pin a3f9 --off
show raw -h output
Usage:
run-kit cron pin <id> [--off] [flags]
Examples:
rk cron pin a3f9
rk cron pin a3f9 --off
Flags:
--off Unpin instead of pin
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (entry-file-scoped verbs: add/edit/list/rm/mute/pin; default: the caller's own server from $TMUX, else the default server)
run-kit cron rmRemove a cron entry by id
usage
run-kit cron rm <id> [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--json | Emit the machine-readable envelope (exactly one JSON document on stdout) | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (entry-file-scoped verbs: add/edit/list/rm/mute/pin; default: the caller's own server from $TMUX, else the default server) |
No flags match that filter.
examples
rk cron rm a3f9
show raw -h output
Usage:
run-kit cron rm <id> [flags]
Examples:
rk cron rm a3f9
Flags:
--json Emit the machine-readable envelope (exactly one JSON document on stdout)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (entry-file-scoped verbs: add/edit/list/rm/mute/pin; default: the caller's own server from $TMUX, else the default server)
run-kit cron tickRun one cron evaluation sweep across every live server
usage
run-kit cron tick [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (entry-file-scoped verbs: add/edit/list/rm/mute/pin; default: the caller's own server from $TMUX, else the default server) |
No flags match that filter.
show raw -h output
Usage:
run-kit cron tick [flags]
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (entry-file-scoped verbs: add/edit/list/rm/mute/pin; default: the caller's own server from $TMUX, else the default server)
run-kit daemonManage the background run-kit daemon (tmux-managed run-kit serve)
usage
run-kit daemon [command]
flags
| flag | type | description | copy |
|---|---|---|---|
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit daemon [command]
Available Commands:
restart Restart the run-kit daemon
run Run a command in a managed job window on the daemon's tmux server
start Start the run-kit daemon
status Show run-kit daemon state and current port owner
stop Stop the run-kit daemon
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
Use "run-kit daemon [command] --help" for more information about a command.
run-kit daemon restartRestart the run-kit daemon
usage
run-kit daemon restart [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
-f, --force | SIGTERM a non-daemon port holder between stop and start | ||
--full | Kill the whole rk-daemon tmux server (sibling sessions included) for a fresh server, reconnecting previously-up remote tunnels | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit daemon restart [flags]
Flags:
-f, --force SIGTERM a non-daemon port holder between stop and start
--full Kill the whole rk-daemon tmux server (sibling sessions included) for a fresh server, reconnecting previously-up remote tunnels
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit daemon runRun a command in a managed job window on the daemon's tmux server
usage
run-kit daemon run --window <name> -- <cmd> [args...] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--window | stringrequired | job window name in the rk-jobs session (required) | |
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit daemon run --window <name> -- <cmd> [args...] [flags]
Flags:
--window string job window name in the rk-jobs session (required)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit daemon startStart the run-kit daemon
usage
run-kit daemon start [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
-f, --force | SIGTERM a non-daemon port owner before starting | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit daemon start [flags]
Flags:
-f, --force SIGTERM a non-daemon port owner before starting
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit daemon statusShow run-kit daemon state and current port owner
usage
run-kit daemon status [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--json | Emit a machine-readable JSON object inside the {"ok","result"} envelope | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit daemon status [flags]
Flags:
--json Emit a machine-readable JSON object inside the {"ok","result"} envelope
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit daemon stopStop the run-kit daemon
usage
run-kit daemon stop [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
-f, --force | SIGTERM any non-daemon port holder after stopping | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit daemon stop [flags]
Flags:
-f, --force SIGTERM any non-daemon port holder after stopping
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit desktopInstall and update the Run Kit desktop app (macOS, Linux)
usage
run-kit desktop [command]
flags
| flag | type | description | copy |
|---|---|---|---|
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit desktop [command]
Available Commands:
install Download and install the Run Kit desktop app
status Show installed vs latest Run Kit desktop app version (read-only)
uninstall Remove the Run Kit desktop app and its desktop integration (Linux)
update Update the Run Kit desktop app when a newer release exists
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
Use "run-kit desktop [command] --help" for more information about a command.
run-kit desktop installDownload and install the Run Kit desktop app
usage
run-kit desktop install [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--force | reinstall even when the requested version is already installed | ||
--path | string | install directory (default: /Applications on macOS, ~/.rk/desktop on Linux) | |
--version | string | install a specific release tag instead of the latest (e.g. v3.13.0) | |
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit desktop install [flags]
Flags:
--force reinstall even when the requested version is already installed
--path string install directory (default: /Applications on macOS, ~/.rk/desktop on Linux)
--version string install a specific release tag instead of the latest (e.g. v3.13.0)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit desktop statusShow installed vs latest Run Kit desktop app version (read-only)
usage
run-kit desktop status [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--path | string | install directory (default: /Applications on macOS, ~/.rk/desktop on Linux) | |
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit desktop status [flags]
Flags:
--path string install directory (default: /Applications on macOS, ~/.rk/desktop on Linux)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit desktop uninstallRemove the Run Kit desktop app and its desktop integration (Linux)
usage
run-kit desktop uninstall [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--path | string | install directory (default: /Applications on macOS, ~/.rk/desktop on Linux) | |
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit desktop uninstall [flags]
Flags:
--path string install directory (default: /Applications on macOS, ~/.rk/desktop on Linux)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit desktop updateUpdate the Run Kit desktop app when a newer release exists
usage
run-kit desktop update [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--force | reinstall even when already current | ||
--path | string | install directory (default: /Applications on macOS, ~/.rk/desktop on Linux) | |
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit desktop update [flags]
Flags:
--force reinstall even when already current
--path string install directory (default: /Applications on macOS, ~/.rk/desktop on Linux)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit doctorCheck runtime dependencies
usage
run-kit doctor [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--json | Emit the dependency report as JSON to stdout, wrapped in the {"ok","result"} envelope | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit doctor [flags]
Flags:
--json Emit the dependency report as JSON to stdout, wrapped in the {"ok","result"} envelope
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit guiManage the host GUI surface (the rk-gui desktop session)
usage
run-kit gui [command]
flags
| flag | type | description | copy |
|---|---|---|---|
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit gui [command]
Available Commands:
click Click at display-pixel coordinates
clip Read or write the GUI display's clipboard
env Print DISPLAY/RK_GUI_SOCKET exports for eval
exec Run a command on the GUI display (DISPLAY set)
focus Raise and focus a window on the GUI display
key Press key chords (xdotool keysym spelling)
launch Open a terminal or browser on the GUI display
lock Pin the display resolution against viewer resizes
move Move the pointer to display-pixel coordinates
off Turn the GUI off and kill the rk-gui session
on Turn the GUI on and start the rk-gui session
open Open a URL or file on the GUI display
resize Resize the GUI desktop (gui.geometry)
restart Kill and respawn the rk-gui session
scroll Scroll at the pointer (or at --at x y first)
shot Screenshot the GUI display to a PNG and print its path
status Show the GUI state
type Type text into the focused window (unicode-safe)
unlock Clear the host display-resolution pin
wait Wait for a window to appear or the screen to go quiet
windows List the visible windows on the GUI display
wm Show or pin the window manager (gui.wm)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
Use "run-kit gui [command] --help" for more information about a command.
run-kit gui clickClick at display-pixel coordinates
usage
run-kit gui click <x> <y> [--right|--middle|--double] [--window <id>] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--double | Double-click | ||
--force | Act even when a human drove the display seconds ago | ||
--middle | Click the middle button | ||
--right | Click the right button | ||
--window | uint | Window id — x y become window-relative | |
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit gui click <x> <y> [--right|--middle|--double] [--window <id>] [flags]
Flags:
--double Double-click
--force Act even when a human drove the display seconds ago
--middle Click the middle button
--right Click the right button
--window uint Window id — x y become window-relative
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit gui clipRead or write the GUI display's clipboard
usage
run-kit gui clip <get|set> [<text> | --stdin] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--stdin | set reads the text from stdin | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit gui clip <get|set> [<text> | --stdin] [flags]
Flags:
--stdin set reads the text from stdin
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit gui envPrint DISPLAY/RK_GUI_SOCKET exports for eval
usage
run-kit gui env [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit gui env [flags]
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit gui execRun a command on the GUI display (DISPLAY set)
usage
run-kit gui exec <cmd> [args…] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
-d, --detach | Start the command as its own session and return immediately | ||
--json | Emit the machine-readable envelope (requires --detach; exactly one JSON document on stdout) | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit gui exec <cmd> [args…] [flags]
Flags:
-d, --detach Start the command as its own session and return immediately
--json Emit the machine-readable envelope (requires --detach; exactly one JSON document on stdout)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit gui focusRaise and focus a window on the GUI display
usage
run-kit gui focus <id|--title <substr>> [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--force | Act even when a human drove the display seconds ago | ||
--title | string | Match a window by title substring (case-sensitive) | |
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit gui focus <id|--title <substr>> [flags]
Flags:
--force Act even when a human drove the display seconds ago
--title string Match a window by title substring (case-sensitive)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit gui keyPress key chords (xdotool keysym spelling)
usage
run-kit gui key <chord> [<chord>…] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--force | Act even when a human drove the display seconds ago | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit gui key <chord> [<chord>…] [flags]
Flags:
--force Act even when a human drove the display seconds ago
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit gui launchOpen a terminal or browser on the GUI display
usage
run-kit gui launch <terminal|browser> [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--cdp | Browser only: open a CDP endpoint (Chromium-family) and print its URL | ||
--port | int | CDP port for --cdp (default 9222) | |
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit gui launch <terminal|browser> [flags]
Flags:
--cdp Browser only: open a CDP endpoint (Chromium-family) and print its URL
--port int CDP port for --cdp (default 9222)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit gui lockPin the display resolution against viewer resizes
usage
run-kit gui lock [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit gui lock [flags]
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit gui moveMove the pointer to display-pixel coordinates
usage
run-kit gui move <x> <y> [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--force | Act even when a human drove the display seconds ago | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit gui move <x> <y> [flags]
Flags:
--force Act even when a human drove the display seconds ago
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit gui offTurn the GUI off and kill the rk-gui session
usage
run-kit gui off [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--yes | Skip the running-apps confirmation | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit gui off [flags]
Flags:
--yes Skip the running-apps confirmation
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit gui onTurn the GUI on and start the rk-gui session
usage
run-kit gui on [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit gui on [flags]
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit gui openOpen a URL or file on the GUI display
usage
run-kit gui open <url|file> [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit gui open <url|file> [flags]
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit gui resizeResize the GUI desktop (gui.geometry)
usage
run-kit gui resize <WxH|auto> [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit gui resize <WxH|auto> [flags]
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit gui restartKill and respawn the rk-gui session
usage
run-kit gui restart [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit gui restart [flags]
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit gui scrollScroll at the pointer (or at --at x y first)
usage
run-kit gui scroll <up|down|left|right> [--n 3] [--at x y] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--at | ints | Move to x,y before scrolling | |
--force | Act even when a human drove the display seconds ago | ||
--n | int | Scroll notches (default 3) | |
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit gui scroll <up|down|left|right> [--n 3] [--at x y] [flags]
Flags:
--at ints Move to x,y before scrolling
--force Act even when a human drove the display seconds ago
--n int Scroll notches (default 3)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit gui shotScreenshot the GUI display to a PNG and print its path
usage
run-kit gui shot [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--json | Emit the capture receipt as a JSON envelope (path, width, height, scale, display) | ||
--max-width | int | Scale the capture down to at most this width in px (ImageMagick) | |
-o, --out | string | Write the PNG to this path (parent created, existing file overwritten) | |
--scale | float | Scale the capture by this factor, in (0, 1] (ImageMagick) | |
--window | uint | Capture this window id (from 'rk gui windows') instead of the root | |
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit gui shot [flags]
Flags:
--json Emit the capture receipt as a JSON envelope (path, width, height, scale, display)
--max-width int Scale the capture down to at most this width in px (ImageMagick)
-o, --out string Write the PNG to this path (parent created, existing file overwritten)
--scale float Scale the capture by this factor, in (0, 1] (ImageMagick)
--window uint Capture this window id (from 'rk gui windows') instead of the root
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit gui statusShow the GUI state
usage
run-kit gui status [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--json | Emit the status document as JSON | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit gui status [flags]
Flags:
--json Emit the status document as JSON
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit gui typeType text into the focused window (unicode-safe)
usage
run-kit gui type <text> | --stdin [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--force | Act even when a human drove the display seconds ago | ||
--stdin | Read the text from stdin | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit gui type <text> | --stdin [flags]
Flags:
--force Act even when a human drove the display seconds ago
--stdin Read the text from stdin
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit gui unlockClear the host display-resolution pin
usage
run-kit gui unlock [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit gui unlock [flags]
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit gui waitWait for a window to appear or the screen to go quiet
usage
run-kit gui wait (--window <substr> | --stable) [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--interval | duration | Capture cadence for --stable (default 500ms) | |
--stable | Wait for two pixel-identical captures | ||
--timeout | duration | Give up after this long (exit 1) (default 10s) | |
--window | string | Wait for a visible window with this title substring | |
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit gui wait (--window <substr> | --stable) [flags]
Flags:
--interval duration Capture cadence for --stable (default 500ms)
--stable Wait for two pixel-identical captures
--timeout duration Give up after this long (exit 1) (default 10s)
--window string Wait for a visible window with this title substring
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit gui windowsList the visible windows on the GUI display
usage
run-kit gui windows [--json] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--json | Emit the inventory as JSON | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit gui windows [--json] [flags]
Flags:
--json Emit the inventory as JSON
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit gui wmShow or pin the window manager (gui.wm)
usage
run-kit gui wm [auto|icewm|lxqt|xfce|plasma|lxde|mate|cinnamon|<binary>] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--force | Pin even when the binary is not on PATH | ||
--json | With --list, emit the wm_candidates array as JSON | ||
--list | Print the desktop candidate table (installed first, then known-but-missing with install hints) | ||
--restart | Restart the rk-gui session after pinning (kills apps on the display) | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit gui wm [auto|icewm|lxqt|xfce|plasma|lxde|mate|cinnamon|<binary>] [flags]
Flags:
--force Pin even when the binary is not on PATH
--json With --list, emit the wm_candidates array as JSON
--list Print the desktop candidate table (installed first, then known-but-missing with install hints)
--restart Restart the rk-gui session after pinning (kills apps on the display)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit mcpServe run-kit's MCP tools over stdio (connector command: ssh <box> rk mcp)
usage
run-kit mcp [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit mcp [flags]
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit muxTmux substrate operations (server create, messaging, pane capture/kill/process, pane/session enumeration, janitor, recovery, config scaffold, tmux guard)
Usage: run-kit mux [command] Messaging: await Block until an agent pane reaches a state (or a file appears) send Deliver a message into an agent's pane, gated on its agent state Pane mechanics: capture Capture a pane's scrollback with substrate context kill Kill a pane, gated on its agent state and server protection panes Enumerate every pane on the server with substrate facts process Show the process tree running in a pane sessions Enumerate the server's sessions with derived roles Server ops: adopt Adopt an external tmux server into run-kit management guard Front the real tmux binary, blocking bare kill-server init-conf Scaffold the rk-managed tmux.conf and tmux.d/ overrides under ~/.config/run-kit/ new Create a detached tmux server on socket <name> reap Reap leaked test tmux servers and stale sockets by prefix snapshot Inspect and restore tmux server layout snapshots
flags
| flag | type | description | copy |
|---|---|---|---|
-L, --server | string | tmux server name (pane-scoped verbs: send/await/capture/kill/process, and the panes/sessions enumerations; default: the caller's own server from $TMUX, else the default server) | |
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit mux [command]
Messaging:
await Block until an agent pane reaches a state (or a file appears)
send Deliver a message into an agent's pane, gated on its agent state
Pane mechanics:
capture Capture a pane's scrollback with substrate context
kill Kill a pane, gated on its agent state and server protection
panes Enumerate every pane on the server with substrate facts
process Show the process tree running in a pane
sessions Enumerate the server's sessions with derived roles
Server ops:
adopt Adopt an external tmux server into run-kit management
guard Front the real tmux binary, blocking bare kill-server
init-conf Scaffold the rk-managed tmux.conf and tmux.d/ overrides under ~/.config/run-kit/
new Create a detached tmux server on socket <name>
reap Reap leaked test tmux servers and stale sockets by prefix
snapshot Inspect and restore tmux server layout snapshots
Flags:
-L, --server string tmux server name (pane-scoped verbs: send/await/capture/kill/process, and the panes/sessions enumerations; default: the caller's own server from $TMUX, else the default server)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
Use "run-kit mux [command] --help" for more information about a command.
run-kit mux adoptAdopt an external tmux server into run-kit management
usage
run-kit mux adopt <server> [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (pane-scoped verbs: send/await/capture/kill/process, and the panes/sessions enumerations; default: the caller's own server from $TMUX, else the default server) |
No flags match that filter.
examples
rk mux adopt ext1
show raw -h output
Usage:
run-kit mux adopt <server> [flags]
Examples:
rk mux adopt ext1
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (pane-scoped verbs: send/await/capture/kill/process, and the panes/sessions enumerations; default: the caller's own server from $TMUX, else the default server)
run-kit mux awaitBlock until an agent pane reaches a state (or a file appears)
usage
run-kit mux await [--any] <target>... [--until <state>[,<state>]] [--file <path>] [--after-active] [--ready] [--timeout <secs>] [--notify[=msg]] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--after-active | Require observing the active state before an --until state counts | ||
--any | Accept one-or-more targets and wake on the FIRST to fire (report appends the firing pane) | ||
--file | string | Also wake when this path appears (OR-composed with the state signal) | |
--json | Emit exactly one JSON document on stdout (the report word inside result; the human report line is suppressed) | ||
--notifystring[=" | auto"] Send a Web Push when the signal fires (optional message; default "agent <target> is <report>") | ||
--ready | gone | Wait until the pane is boot-ready for typed input (agent state present, else a sentinel echo probe gated on the 80x20 floor: echo = ready, no echo = parked, below floor = narrow %N (WxH); all exit 0, except a pane death mid-wait which reports gone with exit 1) | |
--timeout | running | Seconds before reporting running (0 = wait indefinitely) (default 300) | |
--until | string | Comma-separated agent states to wake on (active|waiting|idle) (default "idle") | |
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (pane-scoped verbs: send/await/capture/kill/process, and the panes/sessions enumerations; default: the caller's own server from $TMUX, else the default server) |
No flags match that filter.
show raw -h output
Usage:
run-kit mux await [--any] <target>... [--until <state>[,<state>]] [--file <path>] [--after-active] [--ready] [--timeout <secs>] [--notify[=msg]] [flags]
Flags:
--after-active Require observing the active state before an --until state counts
--any Accept one-or-more targets and wake on the FIRST to fire (report appends the firing pane)
--file string Also wake when this path appears (OR-composed with the state signal)
--json Emit exactly one JSON document on stdout (the report word inside result; the human report line is suppressed)
--notify string[=" auto"] Send a Web Push when the signal fires (optional message; default "agent <target> is <report>")
--ready gone Wait until the pane is boot-ready for typed input (agent state present, else a sentinel echo probe gated on the 80x20 floor: echo = ready, no echo = parked, below floor = narrow %N (WxH); all exit 0, except a pane death mid-wait which reports gone with exit 1)
--timeout running Seconds before reporting running (0 = wait indefinitely) (default 300)
--until string Comma-separated agent states to wake on (active|waiting|idle) (default "idle")
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (pane-scoped verbs: send/await/capture/kill/process, and the panes/sessions enumerations; default: the caller's own server from $TMUX, else the default server)
run-kit mux captureCapture a pane's scrollback with substrate context
usage
run-kit mux capture <target> [-l <lines>] [--json | --raw] [--classify] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--classify | Classify the captured text for a pending prompt | ||
--json | Output as JSON with metadata | ||
-l, --lines | int | Number of scrollback lines to capture (default 50) | |
--raw | Output the captured text only, byte-identical to tmux's output | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (pane-scoped verbs: send/await/capture/kill/process, and the panes/sessions enumerations; default: the caller's own server from $TMUX, else the default server) |
No flags match that filter.
examples
rk mux capture %5 rk mux capture @3 --lines 200 rk mux capture %5 --raw rk mux capture %5 --json rk mux capture %5 --lines 20 --classify --json
show raw -h output
Usage:
run-kit mux capture <target> [-l <lines>] [--json | --raw] [--classify] [flags]
Examples:
rk mux capture %5
rk mux capture @3 --lines 200
rk mux capture %5 --raw
rk mux capture %5 --json
rk mux capture %5 --lines 20 --classify --json
Flags:
--classify Classify the captured text for a pending prompt
--json Output as JSON with metadata
-l, --lines int Number of scrollback lines to capture (default 50)
--raw Output the captured text only, byte-identical to tmux's output
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (pane-scoped verbs: send/await/capture/kill/process, and the panes/sessions enumerations; default: the caller's own server from $TMUX, else the default server)
run-kit mux guardFront the real tmux binary, blocking bare kill-server
usage
run-kit mux guard [tmux args...] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (pane-scoped verbs: send/await/capture/kill/process, and the panes/sessions enumerations; default: the caller's own server from $TMUX, else the default server) |
No flags match that filter.
show raw -h output
Usage:
run-kit mux guard [tmux args...] [flags]
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (pane-scoped verbs: send/await/capture/kill/process, and the panes/sessions enumerations; default: the caller's own server from $TMUX, else the default server)
run-kit mux init-confScaffold the rk-managed tmux.conf and tmux.d/ overrides under ~/.config/run-kit/
usage
run-kit mux init-conf [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--force | Overwrite the rk-managed tmux.conf; overrides in tmux.d/ are untouched | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (pane-scoped verbs: send/await/capture/kill/process, and the panes/sessions enumerations; default: the caller's own server from $TMUX, else the default server) |
No flags match that filter.
show raw -h output
Usage:
run-kit mux init-conf [flags]
Flags:
--force Overwrite the rk-managed tmux.conf; overrides in tmux.d/ are untouched
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (pane-scoped verbs: send/await/capture/kill/process, and the panes/sessions enumerations; default: the caller's own server from $TMUX, else the default server)
run-kit mux killKill a pane, gated on its agent state and server protection
usage
run-kit mux kill <target> [--force] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--force | Skip the agent-state and protected-server gates (the target must still exist) | ||
--json | Emit the machine-readable envelope (exactly one JSON document on stdout) | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (pane-scoped verbs: send/await/capture/kill/process, and the panes/sessions enumerations; default: the caller's own server from $TMUX, else the default server) |
No flags match that filter.
examples
rk mux kill %12 rk mux kill %12 --force rk mux kill @3
show raw -h output
Usage:
run-kit mux kill <target> [--force] [flags]
Examples:
rk mux kill %12
rk mux kill %12 --force
rk mux kill @3
Flags:
--force Skip the agent-state and protected-server gates (the target must still exist)
--json Emit the machine-readable envelope (exactly one JSON document on stdout)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (pane-scoped verbs: send/await/capture/kill/process, and the panes/sessions enumerations; default: the caller's own server from $TMUX, else the default server)
run-kit mux newCreate a detached tmux server on socket <name>
usage
run-kit mux new <name> [--ephemeral] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--ephemeral | Mark the new server @rk_srv_ephemeral 1 (creator opt-out: reaped by rk mux reap --ephemeral, skipped by layout snapshots) | ||
--json | Emit the machine-readable envelope (exactly one JSON document on stdout) | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (pane-scoped verbs: send/await/capture/kill/process, and the panes/sessions enumerations; default: the caller's own server from $TMUX, else the default server) |
No flags match that filter.
examples
rk mux new scratch1 rk mux new scratch2 --ephemeral
show raw -h output
Usage:
run-kit mux new <name> [--ephemeral] [flags]
Examples:
rk mux new scratch1
rk mux new scratch2 --ephemeral
Flags:
--ephemeral Mark the new server @rk_srv_ephemeral 1 (creator opt-out: reaped by rk mux reap --ephemeral, skipped by layout snapshots)
--json Emit the machine-readable envelope (exactly one JSON document on stdout)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (pane-scoped verbs: send/await/capture/kill/process, and the panes/sessions enumerations; default: the caller's own server from $TMUX, else the default server)
run-kit mux panesEnumerate every pane on the server with substrate facts
usage
run-kit mux panes [--json] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--json | Output as JSON | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (pane-scoped verbs: send/await/capture/kill/process, and the panes/sessions enumerations; default: the caller's own server from $TMUX, else the default server) |
No flags match that filter.
examples
rk mux panes rk mux panes --json rk mux panes -L foo
show raw -h output
Usage:
run-kit mux panes [--json] [flags]
Examples:
rk mux panes
rk mux panes --json
rk mux panes -L foo
Flags:
--json Output as JSON
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (pane-scoped verbs: send/await/capture/kill/process, and the panes/sessions enumerations; default: the caller's own server from $TMUX, else the default server)
run-kit mux processShow the process tree running in a pane
usage
run-kit mux process <target> [--json] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--json | Output as JSON | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (pane-scoped verbs: send/await/capture/kill/process, and the panes/sessions enumerations; default: the caller's own server from $TMUX, else the default server) |
No flags match that filter.
examples
rk mux process %5 rk mux process %5 --json
show raw -h output
Usage:
run-kit mux process <target> [--json] [flags]
Examples:
rk mux process %5
rk mux process %5 --json
Flags:
--json Output as JSON
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (pane-scoped verbs: send/await/capture/kill/process, and the panes/sessions enumerations; default: the caller's own server from $TMUX, else the default server)
run-kit mux reapReap leaked test tmux servers and stale sockets by prefix
usage
run-kit mux reap [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--all | print the full list instead of the default 10-entry-per-list cap (display-only) | ||
--dry-run | explicit alias for the default preview-only behavior | ||
--ephemeral | also match live servers carrying the @rk_srv_ephemeral creator opt-out mark (union with the prefix match) | ||
--force | act, and bypass the dangerous-prefix guard (empty or ≤3-char prefix) | ||
--prefix | string | socket-name prefix to match (bare reap ≡ --prefix rk-test) (default "rk-test") | |
--yes | actually reap matched servers/sockets (default is dry-run preview) | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (pane-scoped verbs: send/await/capture/kill/process, and the panes/sessions enumerations; default: the caller's own server from $TMUX, else the default server) |
No flags match that filter.
show raw -h output
Usage:
run-kit mux reap [flags]
Flags:
--all print the full list instead of the default 10-entry-per-list cap (display-only)
--dry-run explicit alias for the default preview-only behavior
--ephemeral also match live servers carrying the @rk_srv_ephemeral creator opt-out mark (union with the prefix match)
--force act, and bypass the dangerous-prefix guard (empty or ≤3-char prefix)
--prefix string socket-name prefix to match (bare reap ≡ --prefix rk-test) (default "rk-test")
--yes actually reap matched servers/sockets (default is dry-run preview)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (pane-scoped verbs: send/await/capture/kill/process, and the panes/sessions enumerations; default: the caller's own server from $TMUX, else the default server)
run-kit mux sendDeliver a message into an agent's pane, gated on its agent state
usage
run-kit mux send <target> [<message> | -] [--key <key>]... [--answer | --force] [--no-enter] [--await[=<states>]] [--timeout <secs>] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--answer | This send answers the target's pending question (a waiting pane accepts it) | ||
--awaitstring[=" | auto"] After submitting, block until the peer reaches one of these states (optional set; default idle,waiting) | ||
--force | Skip the agent-state gate (the target must still exist) | ||
--json | Emit exactly one JSON document on stdout (the delivery receipt; the human report line is suppressed) | ||
--key | stringArray | Send a tmux key name instead of text (repeatable; e.g. --key Enter, --key C-c) | |
--no-enter | Stage the text in the input box without submitting (no Enter) | ||
--timeout | running | Seconds the --await phase may run before reporting running (0 = indefinite) (default 300) | |
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (pane-scoped verbs: send/await/capture/kill/process, and the panes/sessions enumerations; default: the caller's own server from $TMUX, else the default server) |
No flags match that filter.
examples
rk mux send %5 "keep going" rk mux send @3 - < prompt.txt rk mux send =work:agent --key Enter
show raw -h output
Usage:
run-kit mux send <target> [<message> | -] [--key <key>]... [--answer | --force] [--no-enter] [--await[=<states>]] [--timeout <secs>] [flags]
Examples:
rk mux send %5 "keep going"
rk mux send @3 - < prompt.txt
rk mux send =work:agent --key Enter
Flags:
--answer This send answers the target's pending question (a waiting pane accepts it)
--await string[=" auto"] After submitting, block until the peer reaches one of these states (optional set; default idle,waiting)
--force Skip the agent-state gate (the target must still exist)
--json Emit exactly one JSON document on stdout (the delivery receipt; the human report line is suppressed)
--key stringArray Send a tmux key name instead of text (repeatable; e.g. --key Enter, --key C-c)
--no-enter Stage the text in the input box without submitting (no Enter)
--timeout running Seconds the --await phase may run before reporting running (0 = indefinite) (default 300)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (pane-scoped verbs: send/await/capture/kill/process, and the panes/sessions enumerations; default: the caller's own server from $TMUX, else the default server)
run-kit mux sessionsEnumerate the server's sessions with derived roles
usage
run-kit mux sessions [--json] [--all] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--all | Include infrastructure sessions (pin/control/operator/reserved roles) | ||
--json | Output as JSON | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (pane-scoped verbs: send/await/capture/kill/process, and the panes/sessions enumerations; default: the caller's own server from $TMUX, else the default server) |
No flags match that filter.
examples
rk mux sessions rk mux sessions --all rk mux sessions --json rk mux sessions -L foo --all --json
show raw -h output
Usage:
run-kit mux sessions [--json] [--all] [flags]
Examples:
rk mux sessions
rk mux sessions --all
rk mux sessions --json
rk mux sessions -L foo --all --json
Flags:
--all Include infrastructure sessions (pin/control/operator/reserved roles)
--json Output as JSON
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (pane-scoped verbs: send/await/capture/kill/process, and the panes/sessions enumerations; default: the caller's own server from $TMUX, else the default server)
run-kit mux snapshotInspect and restore tmux server layout snapshots
usage
run-kit mux snapshot [command]
flags
| flag | type | description | copy |
|---|---|---|---|
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (pane-scoped verbs: send/await/capture/kill/process, and the panes/sessions enumerations; default: the caller's own server from $TMUX, else the default server) |
No flags match that filter.
show raw -h output
Usage:
run-kit mux snapshot [command]
Available Commands:
list List available layout snapshots (live + died)
restore Recreate a dead server's layout from its snapshot
show Print a stored layout (sessions → windows → pane cwds) without acting
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (pane-scoped verbs: send/await/capture/kill/process, and the panes/sessions enumerations; default: the caller's own server from $TMUX, else the default server)
Use "run-kit mux snapshot [command] --help" for more information about a command.
run-kit mux snapshot listList available layout snapshots (live + died)
usage
run-kit mux snapshot list [<server>] [--json] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--all | print the full list instead of the default 10-row cap (display-only) | ||
--json | emit the snapshot list as a JSON envelope (every row; the cap and --all are display-only) | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (pane-scoped verbs: send/await/capture/kill/process, and the panes/sessions enumerations; default: the caller's own server from $TMUX, else the default server) |
No flags match that filter.
show raw -h output
Usage:
run-kit mux snapshot list [<server>] [--json] [flags]
Flags:
--all print the full list instead of the default 10-row cap (display-only)
--json emit the snapshot list as a JSON envelope (every row; the cap and --all are display-only)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (pane-scoped verbs: send/await/capture/kill/process, and the panes/sessions enumerations; default: the caller's own server from $TMUX, else the default server)
run-kit mux snapshot restoreRecreate a dead server's layout from its snapshot
usage
run-kit mux snapshot restore <server> [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--at | int | restore a history/tombstone entry by its unix timestamp (default: latest) | |
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (pane-scoped verbs: send/await/capture/kill/process, and the panes/sessions enumerations; default: the caller's own server from $TMUX, else the default server) |
No flags match that filter.
show raw -h output
Usage:
run-kit mux snapshot restore <server> [flags]
Flags:
--at int restore a history/tombstone entry by its unix timestamp (default: latest)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (pane-scoped verbs: send/await/capture/kill/process, and the panes/sessions enumerations; default: the caller's own server from $TMUX, else the default server)
run-kit mux snapshot showPrint a stored layout (sessions → windows → pane cwds) without acting
usage
run-kit mux snapshot show <server> [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--at | int | select a history/tombstone entry by its unix timestamp (default: latest) | |
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (pane-scoped verbs: send/await/capture/kill/process, and the panes/sessions enumerations; default: the caller's own server from $TMUX, else the default server) |
No flags match that filter.
show raw -h output
Usage:
run-kit mux snapshot show <server> [flags]
Flags:
--at int select a history/tombstone entry by its unix timestamp (default: latest)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (pane-scoped verbs: send/await/capture/kill/process, and the panes/sessions enumerations; default: the caller's own server from $TMUX, else the default server)
run-kit notifySend a Web Push notification to subscribed devices
usage
run-kit notify <message> [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--json | Emit the machine-readable envelope (exactly one JSON document on stdout) | ||
--title | string | Optional notification title | |
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit notify <message> [flags]
Flags:
--json Emit the machine-readable envelope (exactly one JSON document on stdout)
--title string Optional notification title
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit operatorOpen the operator — the server-wide orchestrator agent tab (singleton)
usage
run-kit operator [--workers <provider>] [-L <server>] [--dir <path>] [flags]run-kit operator [command]
flags
| flag | type | description | copy |
|---|---|---|---|
--dir | string | pin the operator window's working directory (absolute path to an existing directory; also drives agent resolution) | |
--json | emit the machine-readable envelope (exactly one JSON document on stdout) | ||
-L, --server | string | address the named tmux server (no $TMUX required; the window opens in a derived project root, falling back to the home directory; an existing operator tab is reported, not switched to) | |
--workers | string | set FAB_AGENT_WORKERS for the launched operator agent (letters, digits, '_' and '-' only) | |
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit operator [--workers <provider>] [-L <server>] [--dir <path>] [flags]
run-kit operator [command]
Available Commands:
request Hand the server's operator agent a templated work item
Flags:
--dir string pin the operator window's working directory (absolute path to an existing directory; also drives agent resolution)
--json emit the machine-readable envelope (exactly one JSON document on stdout)
-L, --server string address the named tmux server (no $TMUX required; the window opens in a derived project root, falling back to the home directory; an existing operator tab is reported, not switched to)
--workers string set FAB_AGENT_WORKERS for the launched operator agent (letters, digits, '_' and '-' only)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
Use "run-kit operator [command] --help" for more information about a command.
run-kit operator requestHand the server's operator agent a templated work item
usage
run-kit operator request <template> [--window @N] [--text <t>] [--session <s>] [-L <server>] [--json] | --list [--json] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--json | emit the machine-readable envelope (exactly one JSON document on stdout) | ||
--list | print the closed template registry and exit (no daemon call) | ||
-L, --server | string | tmux server to address (default: the caller's own server from $TMUX, else default) | |
--session | string | scope a server-scoped template's facts to one session (acceptsSession templates only) | |
--text | string | client text carried into the rendered prompt (acceptsText templates only) | |
--window | string | subject window id @N (required by window-scoped templates, rejected by server-scoped ones) | |
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit operator request <template> [--window @N] [--text <t>] [--session <s>] [-L <server>] [--json] | --list [--json] [flags]
Flags:
--json emit the machine-readable envelope (exactly one JSON document on stdout)
--list print the closed template registry and exit (no daemon call)
-L, --server string tmux server to address (default: the caller's own server from $TMUX, else default)
--session string scope a server-scoped template's facts to one session (acceptsSession templates only)
--text string client text carried into the rendered prompt (acceptsText templates only)
--window string subject window id @N (required by window-scoped templates, rejected by server-scoped ones)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit presentShow a file, directory, port, or URL to the user as a web tile
usage
run-kit present <target> [--window[=name]] [--notify[=msg]] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--notifystring[=" | auto"] Send a Web Push after attaching (optional message; defaults to "presenting <basename>") | ||
--windowstring[=" | auto"] Spawn a standalone iframe window instead of attaching to this window (optional name; defaults from the target) | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit present <target> [--window[=name]] [--notify[=msg]] [flags]
Flags:
--notify string[=" auto"] Send a Web Push after attaching (optional message; defaults to "presenting <basename>")
--window string[=" auto"] Spawn a standalone iframe window instead of attaching to this window (optional name; defaults from the target)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit remoteUse SSH-only machines as run-kit hosts (bootstrap, tunnel, connect)
usage
run-kit remote [command]
flags
| flag | type | description | copy |
|---|---|---|---|
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit remote [command]
Available Commands:
add Register a remote and assign its stable local port
connect Bootstrap if needed, start the remote daemon, open the tunnel
disconnect Close the tunnel window (the remote daemon keeps running)
list All remotes with derived tunnel + remote daemon state
remove Disconnect and drop the registration (remote install untouched)
status Single-remote detail, including version skew
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
Use "run-kit remote [command] --help" for more information about a command.
run-kit remote addRegister a remote and assign its stable local port
usage
run-kit remote add <target> [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--local-port | int | local tunnel port from the reserved 3100-3199 range (default: lowest free) | |
--name | string | remote name (default: derived from the target's host token) | |
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit remote add <target> [flags]
Flags:
--local-port int local tunnel port from the reserved 3100-3199 range (default: lowest free)
--name string remote name (default: derived from the target's host token)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit remote connectBootstrap if needed, start the remote daemon, open the tunnel
usage
run-kit remote connect <name|target> [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit remote connect <name|target> [flags]
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit remote disconnectClose the tunnel window (the remote daemon keeps running)
usage
run-kit remote disconnect <name> [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit remote disconnect <name> [flags]
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit remote listAll remotes with derived tunnel + remote daemon state
usage
run-kit remote list [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit remote list [flags]
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit remote removeDisconnect and drop the registration (remote install untouched)
usage
run-kit remote remove <name> [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit remote remove <name> [flags]
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit remote statusSingle-remote detail, including version skew
usage
run-kit remote status <name> [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit remote status <name> [flags]
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit riffCreate a worktree, tmux window, and Claude Code session
usage
run-kit riff [preset] [--skill <skill>...] [--cmd <cmd>...] [--layout <name>] [--count <N>] [--preset <name>] [--list-presets] [-- <wt-flags>...] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--cmdcmd[=__rk_riff_pane_bare__] | Shell command for a pane (repeatable; bare form drops into $SHELL) | ||
-N, --count | int | Spawn N worktree/window pairs in parallel (N >= 1) (default 1) | |
--json | Emit the machine-readable envelope (exactly one JSON document on stdout) | ||
--layout | string | Pane layout (default "auto"). layout name (canonical + shortform): a, auto — pane-count-based: 1 pane = no layout 2 panes = even-horizontal 3+ panes = tiled t, tiled — grid ┌───┬───┐ │ 0 │ 1 │ ├───┼───┤ │ 2 │ 3 │ └───┴───┘ h, even-horizontal — side-by-side ┌───┬───┬───┐ │ 0 │ 1 │ 2 │ └───┴───┴───┘ v, even-vertical — stacked ┌───────────┐ │ 0 │ ├───────────┤ │ 1 │ ├───────────┤ │ 2 │ └───────────┘ deck-h, main-horizontal — main on top, deck below ┌───────────┐ │ 0 │ ├───┬───┬───┤ │ 1 │ 2 │ 3 │ └───┴───┴───┘ deck-v, main-vertical — main on left, deck right ┌───────┬───┐ │ │ 1 │ │ 0 ├───┤ │ │ 2 │ │ ├───┤ │ │ 3 │ └───────┴───┘ (default "auto") | |
--list-presets | List defined presets and exit | ||
--preset | string | Named preset from run-kit's riff_presets (built-ins: discuss, incognito, blank) | |
--repo | string | Repo to spawn from (absolute or cwd-relative; must be the git toplevel; default: the process cwd's repo) | |
-L, --server | string | Address the named tmux server (no $TMUX required; with --session unset and no $TMUX the window lands in the server's current session) | |
--session | string | Session the window is created in (=S exact form, e.g. --session =work) | |
--skillskill[=__rk_riff_pane_bare__] | Claude Code skill/slash-command for a pane (repeatable; bare form launches a blank Claude session) | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit riff [preset] [--skill <skill>...] [--cmd <cmd>...] [--layout <name>] [--count <N>] [--preset <name>] [--list-presets] [-- <wt-flags>...] [flags]
Flags:
--cmd cmd[=__rk_riff_pane_bare__] Shell command for a pane (repeatable; bare form drops into $SHELL)
-N, --count int Spawn N worktree/window pairs in parallel (N >= 1) (default 1)
--json Emit the machine-readable envelope (exactly one JSON document on stdout)
--layout string Pane layout (default "auto"). layout name (canonical + shortform):
a, auto — pane-count-based:
1 pane = no layout
2 panes = even-horizontal
3+ panes = tiled
t, tiled — grid
┌───┬───┐
│ 0 │ 1 │
├───┼───┤
│ 2 │ 3 │
└───┴───┘
h, even-horizontal — side-by-side
┌───┬───┬───┐
│ 0 │ 1 │ 2 │
└───┴───┴───┘
v, even-vertical — stacked
┌───────────┐
│ 0 │
├───────────┤
│ 1 │
├───────────┤
│ 2 │
└───────────┘
deck-h, main-horizontal — main on top, deck below
┌───────────┐
│ 0 │
├───┬───┬───┤
│ 1 │ 2 │ 3 │
└───┴───┴───┘
deck-v, main-vertical — main on left, deck right
┌───────┬───┐
│ │ 1 │
│ 0 ├───┤
│ │ 2 │
│ ├───┤
│ │ 3 │
└───────┴───┘
(default "auto")
--list-presets List defined presets and exit
--preset string Named preset from run-kit's riff_presets (built-ins: discuss, incognito, blank)
--repo string Repo to spawn from (absolute or cwd-relative; must be the git toplevel; default: the process cwd's repo)
-L, --server string Address the named tmux server (no $TMUX required; with --session unset and no $TMUX the window lands in the server's current session)
--session string Session the window is created in (=S exact form, e.g. --session =work)
--skill skill[=__rk_riff_pane_bare__] Claude Code skill/slash-command for a pane (repeatable; bare form launches a blank Claude session)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit roleMark or unmark the current window as the server's operator
usage
run-kit role <operator|clear> [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit role <operator|clear> [flags]
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit serveStart the HTTP server (foreground)
usage
run-kit serve [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit serve [flags]
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit skillPrint run-kit's agent skill bundle (static usage briefing)
usage
run-kit skill [topic] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit skill [topic] [flags]
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit statusShow tmux session summary
usage
run-kit status [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--json | Emit the session summary as JSON to stdout, wrapped in the {"ok","result"} envelope | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit status [flags]
Flags:
--json Emit the session summary as JSON to stdout, wrapped in the {"ok","result"} envelope
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit tabDrive a tab's UI state — layout, web tabs, code root, signals — from the shell
usage
run-kit tab [command]
flags
| flag | type | description | copy |
|---|---|---|---|
-L, --server | string | tmux server name (default: the caller's own server from $TMUX, else the default server); requires an explicit @N | |
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit tab [command]
Available Commands:
code Set the code surface's folder
color Set or clear the tab's color
flair Set or clear the tab's per-row flair
layout Read or mutate a tab's surface layout
mark Set or clear the tab's left-gutter marker
new Create a window, optionally born with a layout and/or running a command
note Set or clear the tab's one-line status note
owner Set or clear the tab's operator-ownership trail
show Dump every @rk_win_* option of a tab
web Add, remove, move, select, or list a tab's web tabs
Flags:
-L, --server string tmux server name (default: the caller's own server from $TMUX, else the default server); requires an explicit @N
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
Use "run-kit tab [command] --help" for more information about a command.
run-kit tab codeSet the code surface's folder
usage
run-kit tab code [command]
flags
| flag | type | description | copy |
|---|---|---|---|
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (default: the caller's own server from $TMUX, else the default server); requires an explicit @N |
No flags match that filter.
show raw -h output
Usage:
run-kit tab code [command]
Available Commands:
set Point the tab's code surface at a folder
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (default: the caller's own server from $TMUX, else the default server); requires an explicit @N
Use "run-kit tab code [command] --help" for more information about a command.
run-kit tab code setPoint the tab's code surface at a folder
usage
run-kit tab code set [@N] <folder> [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--json | Emit the machine-readable envelope (exactly one JSON document on stdout) | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (default: the caller's own server from $TMUX, else the default server); requires an explicit @N |
No flags match that filter.
show raw -h output
Usage:
run-kit tab code set [@N] <folder> [flags]
Flags:
--json Emit the machine-readable envelope (exactly one JSON document on stdout)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (default: the caller's own server from $TMUX, else the default server); requires an explicit @N
run-kit tab colorSet or clear the tab's color
usage
run-kit tab color [@N] <value> | --off [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--off | Clear the color (unset @rk_win_color) | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (default: the caller's own server from $TMUX, else the default server); requires an explicit @N |
No flags match that filter.
show raw -h output
Usage:
run-kit tab color [@N] <value> | --off [flags]
Flags:
--off Clear the color (unset @rk_win_color)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (default: the caller's own server from $TMUX, else the default server); requires an explicit @N
run-kit tab flairSet or clear the tab's per-row flair
usage
run-kit tab flair [@N] <name> | --off [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--off | Clear the flair (unset @rk_win_flair) | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (default: the caller's own server from $TMUX, else the default server); requires an explicit @N |
No flags match that filter.
show raw -h output
Usage:
run-kit tab flair [@N] <name> | --off [flags]
Flags:
--off Clear the flair (unset @rk_win_flair)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (default: the caller's own server from $TMUX, else the default server); requires an explicit @N
run-kit tab layoutRead or mutate a tab's surface layout
usage
run-kit tab layout [@N] [L | --add S | --rm S | --promote S | --cycle] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--add | string | Append a surface to the layout (grows the shape) | |
--cycle | Cycle to the next same-arity shape preset | ||
--json | Emit the machine-readable envelope (exactly one JSON document on stdout) | ||
--promote | string | Move a surface to slot A | |
--rm | string | Remove a surface from the layout (collapses the shape) | |
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (default: the caller's own server from $TMUX, else the default server); requires an explicit @N |
No flags match that filter.
show raw -h output
Usage:
run-kit tab layout [@N] [L | --add S | --rm S | --promote S | --cycle] [flags]
Flags:
--add string Append a surface to the layout (grows the shape)
--cycle Cycle to the next same-arity shape preset
--json Emit the machine-readable envelope (exactly one JSON document on stdout)
--promote string Move a surface to slot A
--rm string Remove a surface from the layout (collapses the shape)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (default: the caller's own server from $TMUX, else the default server); requires an explicit @N
run-kit tab markSet or clear the tab's left-gutter marker
usage
run-kit tab mark [@N] <mode>[:<stage>] | --off [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--off | Clear the marker (unset @rk_win_marker) | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (default: the caller's own server from $TMUX, else the default server); requires an explicit @N |
No flags match that filter.
show raw -h output
Usage:
run-kit tab mark [@N] <mode>[:<stage>] | --off [flags]
Flags:
--off Clear the marker (unset @rk_win_marker)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (default: the caller's own server from $TMUX, else the default server); requires an explicit @N
run-kit tab newCreate a window, optionally born with a layout and/or running a command
usage
run-kit tab new [--session =S] [--cwd DIR] [--name N] [--layout L] [--json] [--ready [--timeout SECS]] [--no-shell-fallback] [-- CMD [ARG…]] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--cwd | string | Start directory for the window (default: the caller's cwd) | |
--json | Print {session, session_rung, window_id, pane_id} as JSON inside the {"ok","result"} envelope instead of the bare @N | ||
--layout | string | Layout the window is born with, e.g. split-h:tty,web (validated before creation) | |
--name | string | Window name (default: tmux's own) | |
--no-shell-fallback; exec "${SHELL:-/bin/sh}" | Omit the ; exec "${SHELL:-/bin/sh}" tail so the pane dies with the command | ||
--ready-- | Wait for the new pane's boot readiness (the rk mux await --ready classification) and add the verdict as the JSON "ready" key; requires --json and a -- command | ||
--session | string | Session to create the window in, in the =S exact form (default: the caller's current session; when the caller sits in a run-kit infrastructure session (_rk-*), the sole user session, else the user session rooted at --cwd's main worktree, else the most-attached user session; outside tmux the server's current session) | |
--timeout | running | Seconds --ready waits before reporting running (0 = indefinite); requires --ready (default 300) | |
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (default: the caller's own server from $TMUX, else the default server); requires an explicit @N |
No flags match that filter.
show raw -h output
Usage:
run-kit tab new [--session =S] [--cwd DIR] [--name N] [--layout L] [--json] [--ready [--timeout SECS]] [--no-shell-fallback] [-- CMD [ARG…]] [flags]
Flags:
--cwd string Start directory for the window (default: the caller's cwd)
--json Print {session, session_rung, window_id, pane_id} as JSON inside the {"ok","result"} envelope instead of the bare @N
--layout string Layout the window is born with, e.g. split-h:tty,web (validated before creation)
--name string Window name (default: tmux's own)
--no-shell-fallback ; exec "${SHELL:-/bin/sh}" Omit the ; exec "${SHELL:-/bin/sh}" tail so the pane dies with the command
--ready -- Wait for the new pane's boot readiness (the rk mux await --ready classification) and add the verdict as the JSON "ready" key; requires --json and a -- command
--session string Session to create the window in, in the =S exact form (default: the caller's current session; when the caller sits in a run-kit infrastructure session (_rk-*), the sole user session, else the user session rooted at --cwd's main worktree, else the most-attached user session; outside tmux the server's current session)
--timeout running Seconds --ready waits before reporting running (0 = indefinite); requires --ready (default 300)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (default: the caller's own server from $TMUX, else the default server); requires an explicit @N
run-kit tab noteSet or clear the tab's one-line status note
usage
run-kit tab note [@N] <text> | - | --off [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--off | Clear the note (unset @rk_win_note) | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (default: the caller's own server from $TMUX, else the default server); requires an explicit @N |
No flags match that filter.
show raw -h output
Usage:
run-kit tab note [@N] <text> | - | --off [flags]
Flags:
--off Clear the note (unset @rk_win_note)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (default: the caller's own server from $TMUX, else the default server); requires an explicit @N
run-kit tab ownerSet or clear the tab's operator-ownership trail
usage
run-kit tab owner [@N] operator | --off [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--off | Clear the owner trail (unset @rk_win_owner) | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (default: the caller's own server from $TMUX, else the default server); requires an explicit @N |
No flags match that filter.
show raw -h output
Usage:
run-kit tab owner [@N] operator | --off [flags]
Flags:
--off Clear the owner trail (unset @rk_win_owner)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (default: the caller's own server from $TMUX, else the default server); requires an explicit @N
run-kit tab showDump every @rk_win_* option of a tab
usage
run-kit tab show [@N] [--json] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--json | Print the options as a flat JSON object inside the {"ok","result"} envelope | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (default: the caller's own server from $TMUX, else the default server); requires an explicit @N |
No flags match that filter.
show raw -h output
Usage:
run-kit tab show [@N] [--json] [flags]
Flags:
--json Print the options as a flat JSON object inside the {"ok","result"} envelope
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (default: the caller's own server from $TMUX, else the default server); requires an explicit @N
run-kit tab webAdd, remove, move, select, or list a tab's web tabs
usage
run-kit tab web [command]
flags
| flag | type | description | copy |
|---|---|---|---|
--json | Emit the machine-readable envelope (exactly one JSON document on stdout) | ||
--show | Ensure web is in the tab's layout after adding, then select the tab (add only) | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (default: the caller's own server from $TMUX, else the default server); requires an explicit @N |
No flags match that filter.
show raw -h output
Usage:
run-kit tab web [command]
Available Commands:
add Attach a file, directory, port, or URL to a tab's web-tab strip
ls List a tab's web tabs
mv Move a web tab to a new slot position
rm Remove a web tab from a tab's strip
select Select the active web tab of a tab's strip
Flags:
--json Emit the machine-readable envelope (exactly one JSON document on stdout)
--show Ensure web is in the tab's layout after adding, then select the tab (add only)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (default: the caller's own server from $TMUX, else the default server); requires an explicit @N
Use "run-kit tab web [command] --help" for more information about a command.
run-kit tab web addAttach a file, directory, port, or URL to a tab's web-tab strip
usage
run-kit tab web add [@N] <target> [--show] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--jsonglobal | Emit the machine-readable envelope (exactly one JSON document on stdout) | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (default: the caller's own server from $TMUX, else the default server); requires an explicit @N | |
--showglobal | Ensure web is in the tab's layout after adding, then select the tab (add only) |
No flags match that filter.
show raw -h output
Usage:
run-kit tab web add [@N] <target> [--show] [flags]
Global Flags:
--json Emit the machine-readable envelope (exactly one JSON document on stdout)
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (default: the caller's own server from $TMUX, else the default server); requires an explicit @N
--show Ensure web is in the tab's layout after adding, then select the tab (add only)
run-kit tab web lsList a tab's web tabs
usage
run-kit tab web ls [@N] [--json] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--json | Print the family as a JSON object inside the {"ok","result"} envelope | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (default: the caller's own server from $TMUX, else the default server); requires an explicit @N | |
--showglobal | Ensure web is in the tab's layout after adding, then select the tab (add only) |
No flags match that filter.
show raw -h output
Usage:
run-kit tab web ls [@N] [--json] [flags]
Flags:
--json Print the family as a JSON object inside the {"ok","result"} envelope
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (default: the caller's own server from $TMUX, else the default server); requires an explicit @N
--show Ensure web is in the tab's layout after adding, then select the tab (add only)
run-kit tab web mvMove a web tab to a new slot position
usage
run-kit tab web mv [@N/]web/<n> <m> [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--jsonglobal | Emit the machine-readable envelope (exactly one JSON document on stdout) | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (default: the caller's own server from $TMUX, else the default server); requires an explicit @N | |
--showglobal | Ensure web is in the tab's layout after adding, then select the tab (add only) |
No flags match that filter.
show raw -h output
Usage:
run-kit tab web mv [@N/]web/<n> <m> [flags]
Global Flags:
--json Emit the machine-readable envelope (exactly one JSON document on stdout)
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (default: the caller's own server from $TMUX, else the default server); requires an explicit @N
--show Ensure web is in the tab's layout after adding, then select the tab (add only)
run-kit tab web rmRemove a web tab from a tab's strip
usage
run-kit tab web rm [@N/]web/<n> [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--jsonglobal | Emit the machine-readable envelope (exactly one JSON document on stdout) | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (default: the caller's own server from $TMUX, else the default server); requires an explicit @N | |
--showglobal | Ensure web is in the tab's layout after adding, then select the tab (add only) |
No flags match that filter.
show raw -h output
Usage:
run-kit tab web rm [@N/]web/<n> [flags]
Global Flags:
--json Emit the machine-readable envelope (exactly one JSON document on stdout)
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (default: the caller's own server from $TMUX, else the default server); requires an explicit @N
--show Ensure web is in the tab's layout after adding, then select the tab (add only)
run-kit tab web selectSelect the active web tab of a tab's strip
usage
run-kit tab web select [@N/]web/<n> [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--jsonglobal | Emit the machine-readable envelope (exactly one JSON document on stdout) | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) | ||
-L, --serverglobal | string | tmux server name (default: the caller's own server from $TMUX, else the default server); requires an explicit @N | |
--showglobal | Ensure web is in the tab's layout after adding, then select the tab (add only) |
No flags match that filter.
show raw -h output
Usage:
run-kit tab web select [@N/]web/<n> [flags]
Global Flags:
--json Emit the machine-readable envelope (exactly one JSON document on stdout)
--quiet Suppress progress/decoration/chatter (data and errors still print)
-L, --server string tmux server name (default: the caller's own server from $TMUX, else the default server); requires an explicit @N
--show Ensure web is in the tab's layout after adding, then select the tab (add only)
run-kit tutorialOpen the guided tour — an agent-run tutorial tab in this session
usage
run-kit tutorial [--tier <role>] [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--tier | string | fab role tier the tour agent's launcher resolves from (default "fast") | |
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit tutorial [--tier <role>] [flags]
Flags:
--tier string fab role tier the tour agent's launcher resolves from (default "fast")
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit updateUpdate the run-kit CLI and desktop app to the latest version
usage
run-kit update [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--skip-brew-update | Skip the internal 'brew update' tap-metadata refresh (still runs brew info/upgrade and restarts the daemon) | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit update [flags]
Aliases:
update, upgrade
Flags:
--skip-brew-update Skip the internal 'brew update' tap-metadata refresh (still runs brew info/upgrade and restarts the daemon)
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)
run-kit urlPrint the run-kit server URL (env → tmux option → default)
usage
run-kit url [flags]
flags
| flag | type | description | copy |
|---|---|---|---|
--mcp | Print the MCP streamable-HTTP endpoint (<url>/mcp) instead of the server root | ||
--quietglobal | Suppress progress/decoration/chatter (data and errors still print) |
No flags match that filter.
show raw -h output
Usage:
run-kit url [flags]
Flags:
--mcp Print the MCP streamable-HTTP endpoint (<url>/mcp) instead of the server root
Global Flags:
--quiet Suppress progress/decoration/chatter (data and errors still print)