mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-28 03:43:54 +00:00
f91de52f0d
* refactor: remove stale file-backed shims * fix: harden sqlite state ci boundaries * refactor: store matrix idb snapshots in sqlite * fix: satisfy rebased CI guardrails * refactor: store current conversation bindings in sqlite table * refactor: store tui last sessions in sqlite table * refactor: reset sqlite schema history * refactor: drop unshipped sqlite table migration * refactor: remove plugin index file rollback * refactor: drop unshipped sqlite sidecar migrations * refactor: remove runtime commitments kv migration * refactor: preserve kysely sync result types * refactor: drop unshipped sqlite schema migration table * test: keep session usage coverage sqlite-backed * refactor: keep sqlite migration doctor-only * refactor: isolate device legacy imports * refactor: isolate push voicewake legacy imports * refactor: isolate remaining runtime legacy imports * refactor: tighten sqlite migration guardrails * test: cover sqlite persisted enum parsing * refactor: isolate legacy update and tui imports * refactor: tighten sqlite state ownership * refactor: move legacy imports behind doctor * refactor: remove legacy session row lookup * refactor: canonicalize memory transcript locators * refactor: drop transcript path scope fallbacks * refactor: drop runtime legacy session delivery pruning * refactor: store tts prefs only in sqlite * refactor: remove cron store path runtime * refactor: use cron sqlite store keys * refactor: rename telegram message cache scope * refactor: read memory dreaming status from sqlite * refactor: rename cron status store key * refactor: stop remembering transcript file paths * test: use sqlite locators in agent fixtures * refactor: remove file-shaped commitments and cron store surfaces * refactor: keep compaction transcript handles out of session rows * refactor: derive transcript handles from session identity * refactor: derive runtime transcript handles * refactor: remove gateway session locator reads * refactor: remove transcript locator from session rows * refactor: store raw stream diagnostics in sqlite * refactor: remove file-shaped transcript rotation * refactor: hide legacy trajectory paths from runtime * refactor: remove runtime transcript file bridges * refactor: repair database-first rebase fallout * refactor: align tests with database-first state * refactor: remove transcript file handoffs * refactor: sync post-compaction memory by transcript scope * refactor: run codex app-server sessions by id * refactor: bind codex runtime state by session id * refactor: pass memory transcripts by sqlite scope * refactor: remove transcript locator cleanup leftovers * test: remove stale transcript file fixtures * refactor: remove transcript locator test helper * test: make cron sqlite keys explicit * test: remove cron runtime store paths * test: remove stale session file fixtures * test: use sqlite cron keys in diagnostics * refactor: remove runtime delivery queue backfill * test: drop fake export session file mocks * refactor: rename acp session read failure flag * refactor: rename acp row session key * refactor: remove session store test seams * refactor: move legacy session parser tests to doctor * refactor: reindex managed memory in place * refactor: drop stale session store wording * refactor: rename session row helpers * refactor: rename sqlite session entry modules * refactor: remove transcript locator leftovers * refactor: trim file-era audit wording * refactor: clean managed media through sqlite * fix: prefer explicit agent for exports * fix: use prepared agent for session resets * fix: canonicalize legacy codex binding import * test: rename state cleanup helper * docs: align backup docs with sqlite state * refactor: drop legacy Pi usage auth fallback * refactor: move legacy auth profile imports to doctor * refactor: keep Pi model discovery auth in memory * refactor: remove MSTeams legacy learning key fallback * refactor: store model catalog config in sqlite * refactor: use sqlite model catalog at runtime * refactor: remove model json compatibility aliases * refactor: store auth profiles in sqlite * refactor: seed copied auth profiles in sqlite * refactor: make auth profile runtime sqlite-addressed * refactor: migrate hermes secrets into sqlite auth store * refactor: move plugin install config migration to doctor * refactor: rename plugin index audit checks * test: drop auth file assumptions * test: remove legacy transcript file assertions * refactor: drop legacy cli session aliases * refactor: store skill uploads in sqlite * refactor: keep subagent attachments in sqlite vfs * refactor: drop subagent attachment cleanup state * refactor: move legacy session aliases to doctor * refactor: require node 24 for sqlite state runtime * refactor: move provider caches into sqlite state * fix: harden virtual agent filesystem * refactor: enforce database-first runtime state * refactor: rename compaction transcript rotation setting * test: clean sqlite refactor test types * refactor: consolidate sqlite runtime state * refactor: model session conversations in sqlite * refactor: stop deriving cron delivery from session keys * refactor: stop classifying sessions from key shape * refactor: hydrate announce targets from typed delivery * refactor: route heartbeat delivery from typed sqlite context * refactor: tighten typed sqlite session routing * refactor: remove session origin routing shadow * refactor: drop session origin shadow fixtures * perf: query sqlite vfs paths by prefix * refactor: use typed conversation metadata for sessions * refactor: prefer typed session routing metadata * refactor: require typed session routing metadata * refactor: resolve group tool policy from typed sessions * refactor: delete dead session thread info bridge * Show Codex subscription reset times in channel errors (#80456) * feat(plugin-sdk): consolidate session workflow APIs * fix(agents): allow read-only agent mount reads * [codex] refresh plugin regression fixtures * fix(agents): restore compaction gateway logs * test: tighten gateway startup assertions * Redact persisted secret-shaped payloads [AI] (#79006) * test: tighten device pair notify assertions * test: tighten hermes secret assertions * test: assert matrix client error shapes * test: assert config compat warnings * fix(heartbeat): remap cron-run exec events to session keys (#80214) * fix(codex): route btw through native side threads * fix(auth): accept friendly OpenAI order for Codex profiles * fix(codex): rotate auth profiles inside harness * fix: keep browser status page probe within timeout * test: assert agents add outputs * test: pin cron read status * fix(agents): avoid Pi resource discovery stalls Co-authored-by: dataCenter430 <titan032000@gmail.com> * fix: retire timed-out codex app-server clients * test: tighten qa lab runtime assertions * test: check security fix outputs * test: verify extension runtime messages * feat(wake): expose typed sessionKey on wake protocol + system event CLI * fix(gateway): await session_end during shutdown drain and track channel + compaction lifecycle paths (#57790) * test: guard talk consult call helper * fix(codex): scale context engine projection (#80761) * fix(codex): scale context engine projection * fix: document Codex context projection scaling * fix: document Codex context projection scaling * fix: document Codex context projection scaling * fix: document Codex context projection scaling * chore: align Codex projection changelog * chore: realign Codex projection changelog * fix: isolate Codex projection patch --------- Co-authored-by: Eva (agent) <eva+agent-78055@100yen.org> Co-authored-by: Josh Lehman <josh@martian.engineering> * refactor: move agent runtime state toward piless * refactor: remove cron session reaper * refactor: move session management to sqlite * refactor: finish database-first state migration * chore: refresh generated sqlite db types * refactor: remove stale file-backed shims * test: harden kysely type coverage # Conflicts: # .agents/skills/kysely-database-access/SKILL.md # src/infra/kysely-sync.types.test.ts # src/proxy-capture/store.sqlite.test.ts # src/state/openclaw-agent-db.test.ts # src/state/openclaw-state-db.test.ts * refactor: remove cron store path runtime * refactor: keep compaction transcript handles out of session rows * refactor: derive embedded transcripts from sqlite identity * refactor: remove embedded transcript locator handoff * refactor: remove runtime transcript file bridges * refactor: remove transcript file handoffs * refactor: remove MSTeams legacy learning key fallback * refactor: store model catalog config in sqlite * refactor: use sqlite model catalog at runtime # Conflicts: # docs/cli/secrets.md # docs/gateway/authentication.md # docs/gateway/secrets.md * fix: keep oauth sibling sync sqlite-local # Conflicts: # src/commands/onboard-auth.test.ts * refactor: remove task session store maintenance # Conflicts: # src/commands/tasks.ts * refactor: keep diagnostics in state sqlite * refactor: enforce database-first runtime state * refactor: consolidate sqlite runtime state * Show Codex subscription reset times in channel errors (#80456) * fix(codex): refresh subscription limit resets * fix(codex): format reset times for channels * Update CHANGELOG with latest changes and fixes Updated CHANGELOG with recent fixes and improvements. * fix(codex): keep command load failures on codex surface * fix(codex): format account rate limits as rows * fix(codex): summarize account limits as usage status * fix(codex): simplify account limit status * test: tighten subagent announce queue assertion * test: tighten session delete lifecycle assertions * test: tighten cron ops assertions * fix: track cron execution milestones * test: tighten hermes secret assertions * test: assert matrix sync store payloads * test: assert config compat warnings * fix(codex): align btw side thread semantics * fix(codex): honor codex fallback blocking * fix(agents): avoid Pi resource discovery stalls * test: tighten codex event assertions * test: tighten cron assertions * Fix Codex app-server OAuth harness auth * refactor: move agent runtime state toward piless * refactor: move device and push state to sqlite * refactor: move runtime json state imports to doctor * refactor: finish database-first state migration * chore: refresh generated sqlite db types * refactor: clarify cron sqlite store keys * refactor: remove stale file-backed shims * refactor: bind codex runtime state by session id * test: expect sqlite trajectory branch export * refactor: rename session row helpers * fix: keep legacy device identity import in doctor * refactor: enforce database-first runtime state * refactor: consolidate sqlite runtime state * build: align pi contract wrappers * chore: repair database-first rebase * refactor: remove session file test contracts * test: update gateway session expectations * refactor: stop routing from session compatibility shadows * refactor: stop persisting session route shadows * refactor: use typed delivery context in clients * refactor: stop echoing session route shadows * refactor: repair embedded runner rebase imports # Conflicts: # src/agents/pi-embedded-runner/run/attempt.tool-call-argument-repair.ts * refactor: align pi contract imports * refactor: satisfy kysely sync helper guard * refactor: remove file transcript bridge remnants * refactor: remove session locator compatibility * refactor: remove session file test contracts * refactor: keep rebase database-first clean * refactor: remove session file assumptions from e2e * docs: clarify database-first goal state * test: remove legacy store markers from sqlite runtime tests * refactor: remove legacy store assumptions from runtime seams * refactor: align sqlite runtime helper seams * test: update memory recall sqlite audit mock * refactor: align database-first runtime type seams * test: clarify doctor cron legacy store names * fix: preserve sqlite session route projections * test: fix copilot token cache test syntax * docs: update database-first proof status * test: align database-first test fixtures * docs: update database-first proof status * refactor: clean extension database-first drift * test: align agent session route proof * test: clarify doctor legacy path fixtures * chore: clean database-first changed checks * chore: repair database-first rebase markers * build: allow baileys git subdependency * chore: repair exp-vfs rebase drift * chore: finish exp-vfs rebase cleanup * chore: satisfy rebase lint drift * chore: fix qqbot rebase type seam * chore: fix rebase drift leftovers * fix: keep auth profile oauth secrets out of sqlite * fix: repair rebase drift tests * test: stabilize pairing request ordering * test: use source manifests in plugin contract checks * fix: restore gateway session metadata after rebase * fix: repair database-first rebase drift * fix: clean up database-first rebase fallout * test: stabilize line quick reply receipt time * fix: repair extension rebase drift * test: keep transcript redaction tests sqlite-backed * fix: carry injected transcript redaction through sqlite * chore: clean database branch rebase residue * fix: repair database branch CI drift * fix: repair database branch CI guard drift * fix: stabilize oauth tls preflight test * test: align database branch fast guards * test: repair build artifact boundary guards * chore: clean changelog rebase markers --------- Co-authored-by: pashpashpash <nik@vault77.ai> Co-authored-by: Eva <eva@100yen.org> Co-authored-by: stainlu <stainlu@newtype-ai.org> Co-authored-by: Jason Zhou <jason.zhou.design@gmail.com> Co-authored-by: Ruben Cuevas <hi@rubencu.com> Co-authored-by: Pavan Kumar Gondhi <pavangondhi@gmail.com> Co-authored-by: Shakker <shakkerdroid@gmail.com> Co-authored-by: Kaspre <36520309+Kaspre@users.noreply.github.com> Co-authored-by: dataCenter430 <titan032000@gmail.com> Co-authored-by: Kaspre <kaspre@gmail.com> Co-authored-by: pandadev66 <nova.full.stack@outlook.com> Co-authored-by: Eva <admin@100yen.org> Co-authored-by: Eva (agent) <eva+agent-78055@100yen.org> Co-authored-by: Josh Lehman <josh@martian.engineering> Co-authored-by: jeffjhunter <support@aipersonamethod.com>
396 lines
11 KiB
Markdown
396 lines
11 KiB
Markdown
---
|
|
summary: "OpenClaw CLI index: command list, global flags, and links to per-command pages"
|
|
read_when:
|
|
- Finding the right `openclaw` subcommand
|
|
- Looking up global flags or output styling rules
|
|
title: "CLI reference"
|
|
---
|
|
|
|
`openclaw` is the main CLI entry point. Each core command has either a
|
|
dedicated reference page or is documented with the command it aliases; this
|
|
index lists the commands, the global flags, and the output styling rules that
|
|
apply across the CLI.
|
|
|
|
Use the setup commands by intent:
|
|
|
|
- `openclaw setup` creates the baseline config and workspace without walking the full guided onboarding flow.
|
|
- `openclaw onboard` is the full guided first-run path for gateway, model auth, workspace, channels, skills, and health.
|
|
- `openclaw configure` changes targeted parts of an existing setup, such as model auth, gateway, channels, plugins, or skills.
|
|
- `openclaw channels add` configures channel accounts after the baseline exists; run it without flags for guided channel setup or with channel-specific flags for scripts.
|
|
|
|
## Command pages
|
|
|
|
| Area | Commands |
|
|
| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| Setup and onboarding | [`crestodian`](/cli/crestodian) · [`setup`](/cli/setup) · [`onboard`](/cli/onboard) · [`configure`](/cli/configure) · [`config`](/cli/config) · [`completion`](/cli/completion) · [`doctor`](/cli/doctor) · [`dashboard`](/cli/dashboard) |
|
|
| Reset and uninstall | [`backup`](/cli/backup) · [`reset`](/cli/reset) · [`uninstall`](/cli/uninstall) · [`update`](/cli/update) |
|
|
| Messaging and agents | [`message`](/cli/message) · [`agent`](/cli/agent) · [`agents`](/cli/agents) · [`acp`](/cli/acp) · [`mcp`](/cli/mcp) |
|
|
| Health and sessions | [`status`](/cli/status) · [`health`](/cli/health) · [`sessions`](/cli/sessions) |
|
|
| Gateway and logs | [`gateway`](/cli/gateway) · [`logs`](/cli/logs) · [`system`](/cli/system) |
|
|
| Models and inference | [`models`](/cli/models) · [`infer`](/cli/infer) · `capability` (alias for [`infer`](/cli/infer)) · [`memory`](/cli/memory) · [`commitments`](/cli/commitments) · [`wiki`](/cli/wiki) |
|
|
| Network and nodes | [`directory`](/cli/directory) · [`nodes`](/cli/nodes) · [`devices`](/cli/devices) · [`node`](/cli/node) |
|
|
| Runtime and sandbox | [`approvals`](/cli/approvals) · `exec-policy` (see [`approvals`](/cli/approvals)) · [`sandbox`](/cli/sandbox) · [`tui`](/cli/tui) · `chat`/`terminal` (aliases for [`tui --local`](/cli/tui)) · [`browser`](/cli/browser) |
|
|
| Automation | [`cron`](/cli/cron) · [`tasks`](/cli/tasks) · [`hooks`](/cli/hooks) · [`webhooks`](/cli/webhooks) |
|
|
| Discovery and docs | [`dns`](/cli/dns) · [`docs`](/cli/docs) |
|
|
| Pairing and channels | [`pairing`](/cli/pairing) · [`qr`](/cli/qr) · [`channels`](/cli/channels) |
|
|
| Security and plugins | [`security`](/cli/security) · [`secrets`](/cli/secrets) · [`skills`](/cli/skills) · [`plugins`](/cli/plugins) · [`proxy`](/cli/proxy) |
|
|
| Legacy aliases | [`daemon`](/cli/daemon) (gateway service) · [`clawbot`](/cli/clawbot) (namespace) |
|
|
| Plugins (optional) | [`path`](/cli/path) · [`voicecall`](/cli/voicecall) (if installed) |
|
|
|
|
## Global flags
|
|
|
|
| Flag | Purpose |
|
|
| ----------------------- | --------------------------------------------------------------------- |
|
|
| `--dev` | Isolate state under `~/.openclaw-dev` and shift default ports |
|
|
| `--profile <name>` | Isolate state under `~/.openclaw-<name>` |
|
|
| `--container <name>` | Target a named container for execution |
|
|
| `--no-color` | Disable ANSI colors (`NO_COLOR=1` is also respected) |
|
|
| `--update` | Shorthand for [`openclaw update`](/cli/update) (source installs only) |
|
|
| `-V`, `--version`, `-v` | Print version and exit |
|
|
|
|
## Output modes
|
|
|
|
- ANSI colors and progress indicators render only in TTY sessions.
|
|
- OSC-8 hyperlinks render as clickable links where supported; otherwise the
|
|
CLI falls back to plain URLs.
|
|
- `--json` (and `--plain` where supported) disables styling for clean output.
|
|
- Long-running commands show a progress indicator (OSC 9;4 when supported).
|
|
|
|
Palette source of truth: `src/terminal/palette.ts`.
|
|
|
|
## Command tree
|
|
|
|
<Accordion title="Full command tree">
|
|
|
|
```
|
|
openclaw [--dev] [--profile <name>] <command>
|
|
crestodian
|
|
setup
|
|
onboard
|
|
configure
|
|
config
|
|
get
|
|
set
|
|
unset
|
|
file
|
|
schema
|
|
validate
|
|
completion
|
|
doctor
|
|
dashboard
|
|
backup
|
|
create
|
|
verify
|
|
security
|
|
audit
|
|
secrets
|
|
reload
|
|
audit
|
|
configure
|
|
apply
|
|
reset
|
|
uninstall
|
|
update
|
|
wizard
|
|
status
|
|
channels
|
|
list
|
|
status
|
|
capabilities
|
|
resolve
|
|
logs
|
|
add
|
|
remove
|
|
login
|
|
logout
|
|
directory
|
|
self
|
|
peers list
|
|
groups list|members
|
|
skills
|
|
search
|
|
install
|
|
update
|
|
list
|
|
info
|
|
check
|
|
plugins
|
|
list
|
|
inspect
|
|
install
|
|
uninstall
|
|
update
|
|
enable
|
|
disable
|
|
doctor
|
|
marketplace list
|
|
memory
|
|
status
|
|
index
|
|
search
|
|
path
|
|
resolve
|
|
find
|
|
set
|
|
validate
|
|
emit
|
|
commitments
|
|
list
|
|
dismiss
|
|
wiki
|
|
status
|
|
doctor
|
|
init
|
|
ingest
|
|
compile
|
|
lint
|
|
search
|
|
get
|
|
apply
|
|
bridge import
|
|
unsafe-local import
|
|
obsidian status|search|open|command|daily
|
|
message
|
|
send
|
|
broadcast
|
|
poll
|
|
react
|
|
reactions
|
|
read
|
|
edit
|
|
delete
|
|
pin
|
|
unpin
|
|
pins
|
|
permissions
|
|
search
|
|
thread create|list|reply
|
|
emoji list|upload
|
|
sticker send|upload
|
|
role info|add|remove
|
|
channel info|list
|
|
member info
|
|
voice status
|
|
event list|create
|
|
timeout
|
|
kick
|
|
ban
|
|
agent
|
|
agents
|
|
list
|
|
add
|
|
delete
|
|
bindings
|
|
bind
|
|
unbind
|
|
set-identity
|
|
acp
|
|
mcp
|
|
serve
|
|
list
|
|
show
|
|
set
|
|
unset
|
|
status
|
|
health
|
|
sessions
|
|
tasks
|
|
list
|
|
audit
|
|
maintenance
|
|
show
|
|
notify
|
|
cancel
|
|
flow list|show|cancel
|
|
gateway
|
|
call
|
|
usage-cost
|
|
health
|
|
status
|
|
probe
|
|
discover
|
|
install
|
|
uninstall
|
|
start
|
|
stop
|
|
restart
|
|
run
|
|
daemon
|
|
status
|
|
install
|
|
uninstall
|
|
start
|
|
stop
|
|
restart
|
|
logs
|
|
system
|
|
event
|
|
heartbeat last|enable|disable
|
|
presence
|
|
models
|
|
list
|
|
status
|
|
set
|
|
set-image
|
|
aliases list|add|remove
|
|
fallbacks list|add|remove|clear
|
|
image-fallbacks list|add|remove|clear
|
|
scan
|
|
infer (alias: capability)
|
|
list
|
|
inspect
|
|
model run|list|inspect|providers|auth login|logout|status
|
|
image generate|edit|describe|describe-many|providers
|
|
audio transcribe|providers
|
|
tts convert|voices|providers|status|enable|disable|set-provider
|
|
video generate|describe|providers
|
|
web search|fetch|providers
|
|
embedding create|providers
|
|
auth add|login|login-github-copilot|setup-token|paste-token
|
|
auth order get|set|clear
|
|
sandbox
|
|
list
|
|
recreate
|
|
explain
|
|
cron
|
|
status
|
|
list
|
|
get
|
|
add
|
|
edit
|
|
rm
|
|
enable
|
|
disable
|
|
runs
|
|
run
|
|
nodes
|
|
status
|
|
describe
|
|
list
|
|
pending
|
|
approve
|
|
reject
|
|
rename
|
|
invoke
|
|
notify
|
|
push
|
|
canvas snapshot|present|hide|navigate|eval
|
|
canvas a2ui push|reset
|
|
camera list|snap|clip
|
|
screen record
|
|
location get
|
|
devices
|
|
list
|
|
remove
|
|
clear
|
|
approve
|
|
reject
|
|
rotate
|
|
revoke
|
|
node
|
|
run
|
|
status
|
|
install
|
|
uninstall
|
|
stop
|
|
restart
|
|
approvals
|
|
get
|
|
set
|
|
allowlist add|remove
|
|
exec-policy
|
|
show
|
|
preset
|
|
set
|
|
browser
|
|
status
|
|
start
|
|
stop
|
|
reset-profile
|
|
tabs
|
|
open
|
|
focus
|
|
close
|
|
profiles
|
|
create-profile
|
|
delete-profile
|
|
screenshot
|
|
snapshot
|
|
navigate
|
|
resize
|
|
click
|
|
type
|
|
press
|
|
hover
|
|
drag
|
|
select
|
|
upload
|
|
fill
|
|
dialog
|
|
wait
|
|
evaluate
|
|
console
|
|
pdf
|
|
hooks
|
|
list
|
|
info
|
|
check
|
|
enable
|
|
disable
|
|
install
|
|
update
|
|
webhooks
|
|
gmail setup|run
|
|
proxy
|
|
start
|
|
run
|
|
coverage
|
|
sessions
|
|
query
|
|
blob
|
|
purge
|
|
pairing
|
|
list
|
|
approve
|
|
qr
|
|
clawbot
|
|
qr
|
|
docs
|
|
dns
|
|
setup
|
|
tui
|
|
chat (alias: tui --local)
|
|
terminal (alias: tui --local)
|
|
```
|
|
|
|
Plugins can add additional top-level commands (for example `openclaw voicecall`).
|
|
|
|
</Accordion>
|
|
|
|
## Chat slash commands
|
|
|
|
Chat messages support `/...` commands. See [slash commands](/tools/slash-commands).
|
|
|
|
Highlights:
|
|
|
|
- `/status` — quick diagnostics.
|
|
- `/trace` — session-scoped plugin trace/debug lines.
|
|
- `/config` — persisted config changes.
|
|
- `/debug` — runtime-only config overrides (memory, not disk; requires `commands.debug: true`).
|
|
|
|
## Usage tracking
|
|
|
|
`openclaw status --usage` and the Control UI surface provider usage/quota when
|
|
OAuth/API credentials are available. Data comes directly from provider usage
|
|
endpoints and is normalized to `X% left`. Providers with current usage
|
|
windows: Anthropic, GitHub Copilot, Gemini CLI, OpenAI Codex, MiniMax,
|
|
Xiaomi, and z.ai.
|
|
|
|
See [Usage tracking](/concepts/usage-tracking) for details.
|
|
|
|
## Related
|
|
|
|
- [Slash commands](/tools/slash-commands)
|
|
- [Configuration](/gateway/configuration)
|
|
- [Environment](/help/environment)
|