Skip to content

CLI reference

Copy page

This page lists the commands in workrex --help, in the same groups. For a command’s full options, run workrex <command> --help. “Window” means a Rex tab within a session. A terminal pane is a Rex block. In session mode, which is the default under Rex, each worktree gets a session instead. Configuration lives in .workrex.yaml and the Workrex global directory. See Configuration.

CommandDescription
addCreate a worktree and its window
removeRemove a worktree, its window, and its branch without merging
renameRename a worktree, its window or session, and its branch
mergeMerge a branch, then remove its worktree and window
rebaseRebase a worktree branch onto its base branch
openOpen a window for an existing worktree
closeClose a worktree’s window and keep the worktree and branch
resurrectRestore worktree windows after a crash
CommandDescription
dashboardShow a TUI dashboard of every active agent
sidebarControl the live agent status sidebar in Rex
listList all worktrees
pathPrint the filesystem path of a worktree
statusQuery agent status for worktrees
CommandDescription
initWrite an example .workrex.yaml
setupSet up agent status tracking hooks and install skills
configEdit, locate, or print the global configuration
sandboxManage sandbox settings
remoteManage SSH remotes that run agents
sync-filesCopy and symlink configured files into worktrees again
claudeClaude Code commands, such as claude prune
CommandDescription
sendSend a prompt or instruction to a running agent
captureCapture terminal output from a running agent
waitWait for agents to reach a target status
runRun a command in a worktree’s window
reap-agentsExit tracked agent processes older than a set age
CommandDescription
docsShow the README in the terminal
changelogShow the changelog (what’s new in each version)
updateUpdate workrex to the latest release
completionsPrint shell completions

workrex --help does not list these commands.

CommandDescription
last-doneSwitch to the agent that finished or asked for input most recently
last-agentSwitch to the last visited agent (toggle between two)
shellOpen a shell in a remote workspace
uninstallRemove status hooks, skills, and workrex’s state and update cache