Skip to content

Commands

run-kit v3.7.0 · captured 2026-07-16

-h/--help work on every command; -v/--version at the tool root.

run-kitrun-kit — tmux session manager with web UI
usage
  • run-kit
  • run-kit [command]
show raw -h output
Usage:
  run-kit
  run-kit [command]

Available Commands:
  agent-hook  Report an agent's lifecycle state to run-kit (invoked by installed hooks)
  agent-setup Install agent-harness hooks that report agent state to run-kit
  completion  Generate the autocompletion script for the specified shell
  context     Show agent-optimized environment info
  daemon      Manage the background run-kit daemon (tmux-managed run-kit serve)
  doctor      Check runtime dependencies
  help        Help about any command
  init-conf   Scaffold default tmux.conf and tmux.d/ drop-in directory to ~/.rk/
  notify      Send a Web Push notification to subscribed devices
  reaper      Reap leaked test tmux servers and stale sockets by prefix
  riff        Create a worktree, tmux window, and Claude Code session
  serve       Start the HTTP server (foreground)
  shell-init  emit shell integration (completion) for zsh or bash
  status      Show tmux session summary
  update      Update run-kit to the latest version

Use "run-kit [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
flagtypedescriptioncopy
--agentstringAgent harness whose comm literal drives pid resolution (v1: claude) (default "claude")
show raw -h output
Usage:
  run-kit agent-hook <state> [flags]

Flags:
      --agent string   Agent harness whose comm literal drives pid resolution (v1: claude) (default "claude")
run-kit agent-setupInstall agent-harness hooks that report agent state to run-kit
usage
  • run-kit agent-setup [flags]
flags
flagtypedescriptioncopy
--uninstallRemove the rk-owned hook entries instead of installing them
show raw -h output
Usage:
  run-kit agent-setup [flags]

Flags:
      --uninstall   Remove the rk-owned hook entries instead of installing them
run-kit contextShow agent-optimized environment info
usage
  • run-kit context
show raw -h output
Usage:
  run-kit context
run-kit daemonManage the background run-kit daemon (tmux-managed run-kit serve)
usage
  • run-kit daemon [command]
show raw -h output
Usage:
  run-kit daemon [command]

Available Commands:
  restart     Restart the run-kit daemon
  start       Start the run-kit daemon
  status      Show run-kit daemon state and current port owner
  stop        Stop the run-kit daemon

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
flagtypedescriptioncopy
-f, --forceSIGTERM a non-daemon port holder between stop and start
show raw -h output
Usage:
  run-kit daemon restart [flags]

Flags:
  -f, --force   SIGTERM a non-daemon port holder between stop and start
run-kit daemon startStart the run-kit daemon
usage
  • run-kit daemon start [flags]
flags
flagtypedescriptioncopy
-f, --forceSIGTERM a non-daemon port owner before starting
show raw -h output
Usage:
  run-kit daemon start [flags]

Flags:
  -f, --force   SIGTERM a non-daemon port owner before starting
run-kit daemon statusShow run-kit daemon state and current port owner
usage
  • run-kit daemon status [flags]
flags
flagtypedescriptioncopy
--jsonEmit a machine-readable JSON object
show raw -h output
Usage:
  run-kit daemon status [flags]

Flags:
      --json   Emit a machine-readable JSON object
run-kit daemon stopStop the run-kit daemon
usage
  • run-kit daemon stop [flags]
flags
flagtypedescriptioncopy
-f, --forceSIGTERM any non-daemon port holder after stopping
show raw -h output
Usage:
  run-kit daemon stop [flags]

Flags:
  -f, --force   SIGTERM any non-daemon port holder after stopping
run-kit doctorCheck runtime dependencies
usage
  • run-kit doctor
show raw -h output
Usage:
  run-kit doctor
run-kit init-confScaffold default tmux.conf and tmux.d/ drop-in directory to ~/.rk/
usage
  • run-kit init-conf [flags]
flags
flagtypedescriptioncopy
--forceOverwrite existing config
show raw -h output
Usage:
  run-kit init-conf [flags]

Flags:
      --force   Overwrite existing config
run-kit notifySend a Web Push notification to subscribed devices
usage
  • run-kit notify <message> [flags]
flags
flagtypedescriptioncopy
--titlestringOptional notification title
show raw -h output
Usage:
  run-kit notify <message> [flags]

Flags:
      --title string   Optional notification title
run-kit reaperReap leaked test tmux servers and stale sockets by prefix
usage
  • run-kit reaper [flags]
flags
flagtypedescriptioncopy
--dry-runexplicit alias for the default preview-only behavior
--forceact, and bypass the dangerous-prefix guard (empty or ≤3-char prefix)
--prefixstringsocket-name prefix to match (bare reaper ≡ --prefix rk-test) (default "rk-test")
--yesactually reap matched servers/sockets (default is dry-run preview)
show raw -h output
Usage:
  run-kit reaper [flags]

Flags:
      --dry-run         explicit alias for the default preview-only behavior
      --force           act, and bypass the dangerous-prefix guard (empty or ≤3-char prefix)
      --prefix string   socket-name prefix to match (bare reaper ≡ --prefix rk-test) (default "rk-test")
      --yes             actually reap matched servers/sockets (default is dry-run preview)
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
flagtypedescriptioncopy
--cmdcmd[=__rk_riff_pane_bare__]Shell command for a pane (repeatable; bare form drops into $SHELL)
-N, --countintSpawn N worktree/window pairs in parallel (N >= 1) (default 1)
--layoutstringPane 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-presetsList defined presets and exit
--presetstringNamed preset from fab/project/config.yaml (riff.presets.<name>)
--skillskill[=__rk_riff_pane_bare__]Claude Code skill/slash-command for a pane (repeatable; bare form launches a blank Claude session)
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)
      --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 fab/project/config.yaml (riff.presets.<name>)
      --skill skill[=__rk_riff_pane_bare__]   Claude Code skill/slash-command for a pane (repeatable; bare form launches a blank Claude session)
run-kit serveStart the HTTP server (foreground)
usage
  • run-kit serve
show raw -h output
Usage:
  run-kit serve
run-kit shell-initemit shell integration (completion) for zsh or bash
usage
  • run-kit shell-init <shell>
show raw -h output
Usage:
  run-kit shell-init <shell>
run-kit statusShow tmux session summary
usage
  • run-kit status
show raw -h output
Usage:
  run-kit status
run-kit updateUpdate run-kit to the latest version
usage
  • run-kit update [flags]
flags
flagtypedescriptioncopy
--skip-brew-updateSkip the internal 'brew update' tap-metadata refresh (still runs brew info/upgrade and restarts the daemon)
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)