Skip to content

Commands

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

rkrk — tmux session manager with web UI
usage
  • rk
  • rk [command]
show raw -h output
Usage:
  rk
  rk [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  context     Show agent-optimized environment info
  daemon      Manage the background rk daemon (tmux-managed rk serve)
  doctor      Check runtime dependencies
  help        Help about any command
  init-conf   Scaffold default tmux.conf and tmux.d/ drop-in directory to ~/.rk/
  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 rk to the latest version

Use "rk [command] --help" for more information about a command.
rk contextShow agent-optimized environment info
usage
  • rk context
show raw -h output
Usage:
  rk context
rk daemonManage the background rk daemon (tmux-managed rk serve)
usage
  • rk daemon [command]
show raw -h output
Usage:
  rk daemon [command]

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

Use "rk daemon [command] --help" for more information about a command.
rk daemon restartRestart the rk daemon
usage
  • rk daemon restart [flags]
flags
flagtypedescriptioncopy
-f, --forceSIGTERM a non-daemon port holder between stop and start
show raw -h output
Usage:
  rk daemon restart [flags]

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

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

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

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

Flags:
      --force   Overwrite existing config
rk reaperReap leaked test tmux servers and stale sockets by prefix
usage
  • rk 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:
  rk 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)
rk riffCreate a worktree, tmux window, and Claude Code session
usage
  • rk 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:
  rk 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)
rk serveStart the HTTP server (foreground)
usage
  • rk serve
show raw -h output
Usage:
  rk serve
rk shell-initemit shell integration (completion) for zsh or bash
usage
  • rk shell-init <shell>
show raw -h output
Usage:
  rk shell-init <shell>
rk statusShow tmux session summary
usage
  • rk status
show raw -h output
Usage:
  rk status
rk updateUpdate rk to the latest version
usage
  • rk 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:
  rk 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)