Reference
CLI reference
Everything the dashboard does is on the CLI. This is also the surface an agent uses to drive octomux.
octomux [options] [command]
-V, --version output the version number
-s, --server-url <url> server URL (default: http://localhost:7777)
--json output as JSON (auto-enabled when piped)
Tasks
| Command | What it does |
|---|
create-task | Create a new agent task. --harness picks claude-code or cursor. |
list-tasks, ls | List all tasks. |
get-task, info <id> | Task details. |
close-task <id> | Close a running task. |
resume-task <id> | Resume a closed or errored task. |
delete-task <id> | Remove the worktree, branch and tmux session. |
Agents
| Command | What it does |
|---|
add-agent | Add another agent to a running task, sharing its worktree. |
stop-agent <agent-id> | Stop one agent on a task. |
send-message <message> | Message a running agent. |
Board & tracking
| Command | What it does |
|---|
task-move <id> <status> | backlog | planned | in_progress | human_review | pr | done |
task-summary <id> <text> | Update the current summary. |
task-note <id> <note> | Append to the activity log. |
task-ref-add <id> <integration> <external-id> | Link a Jira or Linear ticket. |
task-updates <id> | List activity log entries. |
Review
| Command | What it does |
|---|
post-review | Post an inline review comment on a file and line in a task worktree. |
Setup & plugins
| Command | What it does |
|---|
init | Interactive setup. --non-interactive for scripted installs. |
doctor | Report which plugins loaded, and why any failed. |
list-integrations | Configured integrations with tracker defaults, secrets masked. |
list-skills, get-skill, create-skill | Manage installed skills. |
hooks-install <template> | Install a hook template, e.g. jira-status. |
recent-repos, default-branch | Repo helpers. |
Run octomux help <command> for flags on any of these.
octomux