CLI reference
Every top-level oktapod command, grouped by what you want to do.
This page lists every top-level command in oktapod help. Run
oktapod <command> --help for the exact options in your version. For an
introduction, see Using the CLI.
#Set up
| Command | What it does |
|---|
onboard | Guided first run or repair: AI account, service, web app, and checks. --manual asks every question. |
setup | Change the AI provider or repair setup. setup email, setup calendar, setup documents, and setup media-generation add one thing. |
bootstrap | Install and start the service and web app before any AI account is connected. Used by the setup apps. |
auth | Sign in to, check, or sign out of providers: auth status, auth login, auth logout, auth providers. |
models | See connected models and routing: models status, models list, models routing automatic or pinned, and models data-use to see which models may receive Google data. |
config | Read and change settings: show, get, set, unset, validate, journal, rollback, repair. |
settings | Import provider settings from another agent: settings import --from openclaw or hermes. |
token | Manage access tokens for the gateway: list, create, revoke, rotate. |
prompt-logging | Turn full prompt logging on or off for debugging. Off by default. |
#Run and check
| Command | What it does |
|---|
start | Start Oktapod. |
up | Start and verify. |
restart | Restart. |
stop, down | Stop. |
status | Processes and basic health. |
checkup | One-shot health and readiness check with the next fix. --repair tries fixes. |
doctor | Full diagnostic report. |
readiness | Summary of setup readiness and personalization. |
reliability:status | Last failure, repair path, queue depth, and latency. |
logs tail | Recent log lines from all parts of Oktapod. |
service | service audit and service repair check or fix the auto-start service. |
runtime repair | Clear stale process state; names any other program holding Oktapod's port. |
web-search | web-search status and web-search doctor check web search. |
smoke | Run a named start-up smoke test. |
#Talk and follow work
| Command | What it does |
|---|
chat "<text>" | Send a message and print the reply. |
ui | Print the web app address and access key. --open opens a browser and hands it the key. |
brief | Show the daily brief. --refresh builds a new one now. |
approvals | pending, list, approve <id>, deny <id>. |
authority | Scoped grants, fuses, and holds. See Approvals and safety. |
runs tail | Recent actions and their outcomes. |
timeline <run> | Read one run's canonical timeline, step by step. --json returns the full record. |
decision <run> | Why a run was allowed: plan, policy, and approval. |
inspect <run> | Full context for a run. |
run | Start, list, show, or cancel autonomous runs. |
watches | Notify-on-completion triggers: list, add, pause, resume. |
usage | Token and cost summary. |
#Memory and awareness
| Command | What it does |
|---|
memory | search, list, review, correct, revoke, feedback, export, status, and contact graph tools. |
proactive | Inspect or refresh what Oktapod is watching for. |
ambient | Inspect noticed signals, work contexts, decisions, and replays. |
meetings | Import a transcript, or check, allow, and stop private summaries. See Meeting transcripts. |
observations | Import external observations from a file, or report on observation quality. |
research | Status, budgets, and controls for cited paper ingestion. |
#Apps and channels
| Command | What it does |
|---|
channels | Messaging channels: list, status, add, login, logout, remove, verify, capabilities, pairing, onboarding. |
integrations | Home Assistant and other home integrations: status and control. |
connector | Add and authorize MCP connector servers. For advanced users. |
observer | Enroll or revoke lightweight observer machines. See Browser, devices, and other machines. |
interceptor | Install, update, check, or remove the private traffic interceptor. |
#Coding and agents
| Command | What it does |
|---|
coding | Scan projects, prepare tasks, and run coding handoffs. See Coding. |
workspaces | Open or clone repositories and create worktrees. |
acp | Coding harness setup, status, doctor, and pool control. |
loop | Coding loops: start, list, show, tail, pause, resume, cancel, approve. |
terminal | Start, read, write, and stop terminal sessions run by Oktapod. |
hosts | SSH and Tailscale machines Oktapod may run commands on, with audited remote exec. |
agents | Named agents and their routing. |
subagents | Helper agents: list, spawn, steer, and more. See Agent teams. |
skills | Installed skills, trust review, and provenance. |
plugins | Install, refresh, or scaffold plugins. For advanced users. |
recall-hooks | Install, update, or remove Recall hook adapters for coding harnesses. |
#Backups and updates
| Command | What it does |
|---|
backup | Save settings and data to an archive. --output <file>. |
restore | Restore from a backup. --snapshots and --prune-snapshots manage restore snapshots. |
update | Check for, install, or roll back a release. --check is read-only. |
upgrade | Back up, pull, build, restart, and verify a source install. |
updater | Scheduled update checks: status, check, enable, disable, configure, rollback. |
reset-instance | Archive history and start with a clean database, keeping your setup. Needs --confirm RESET. |
recover-core-db | Swap in a verified recovered database, keeping the old one. |
repair <id> | Run a named repair. Supports --dry-run and --apply. |
See Backups and operations and Updates before using
these on an install you care about.
#Low-level
These pass their arguments to the running agent. They are for advanced
debugging and may not be enabled on every install.
| Command | What it controls |
|---|
browser | Browser automation (status, doctor, setup). |
nodes | Paired runtime nodes. |
devices | Experimental device pairing. |
cron | Schedules as raw records. |
system | Presence and heartbeat. |
#For maintainers
pilot, evidence, and release-gates produce release evidence. They are not
needed to use Oktapod.
#Help and version
oktapod help lists all commands. oktapod version prints the installed
version.
