本页内容

本页内容

CLI 命令

CLI 参考

openclaw 是主要的 CLI 入口点。每个核心命令都有专门的 参考页面,或与其所别名的命令一起记录;本索引列出了 适用于整个 CLI 的命令、全局标志和输出样式规则。

按用途划分的设置命令:

  • openclaw setup 和 openclaw onboard 首先验证推理,然后启动 OpenClaw,以设置 Gateway 网关、工作区、渠道、Skills 和健康状态。
  • openclaw setup --baseline 创建基础配置和工作区,而不进入引导式新手引导流程。
  • openclaw configure 更改现有设置的特定部分:模型身份验证、Gateway 网关、渠道、插件或 Skills。
  • openclaw channels add 在基础配置就绪后配置渠道账户;仅选择渠道时使用引导式设置,而账户、凭据或渠道配置标志则使用适合脚本的直接路径。

命令页面

区域 命令
设置和新手引导 openclaw · setup · onboard · configure · config · completion · doctor · dashboard
重置、备份和迁移 backup · migrate · reset · uninstall · update
消息和智能体 message · agent · agents · attach · acp · mcp
健康状态和会话 status · health · sessions · audit
Gateway 网关和日志 gateway · logs · system
模型和推理 models · promos · infer · capability(infer 的别名)· memory · commitments · wiki
网络和节点 directory · nodes · devices · node · worker
运行时和沙箱 approvals · exec-policy(参见 approvals)· sandbox · tui · chat/terminal(tui --local 的别名)· browser
自动化 cron · tasks · hooks · webhooks · transcripts
设备发现和文档 dns · docs
配对和渠道 pairing · qr · channels
安全和插件 security · secrets · skills · plugins · proxy
旧版别名 daemon(Gateway 网关服务)· clawbot(命名空间)
插件(可选) path · policy · voicecall · workboard(如果已安装)

全局标志

标志 用途
--dev 将状态隔离在 ~/.openclaw-dev 下,将默认 Gateway 网关端口设为 19001,并偏移派生端口
--profile <name> 将状态隔离在 ~/.openclaw-<name>(OPENCLAW_STATE_DIR/OPENCLAW_CONFIG_PATH)下
--container <name> 在名为 <name> 的运行中 Podman/Docker 容器内运行 CLI(默认值:环境变量 OPENCLAW_CONTAINER)
--log-level <level> 覆盖文件和控制台输出的全局日志级别
--no-color 禁用 ANSI 颜色(也会遵循 NO_COLOR=1)
--update openclaw update 的简写;适用于源代码检出和软件包安装
-V, --version, -v 打印版本并退出

输出模式

  • ANSI 颜色和进度指示器仅在 TTY 会话中呈现。
  • 在支持的环境中,OSC-8 超链接会呈现为可点击链接;否则 CLI 会回退到纯 URL。
  • --json(以及支持时的 --plain)会禁用样式,以获得整洁输出。
  • 长时间运行的命令会显示进度指示器(支持时使用 OSC 9;4)。

调色板

OpenClaw 的 CLI 输出使用龙虾主题调色板:

令牌 十六进制 用途
accent #FF5A2D 标题、标签、主要高亮
accentBright #FF7A3D 命令名称、强调
accentDim #D14A22 次要高亮文本
info #FF8A5B 信息值
success #2FBF71 成功状态
warn #FFB020 警告、选项标志、回退
error #E23D2D 错误、失败
muted #8B7F77 弱化显示、元数据

调色板的唯一事实来源:packages/terminal-core/src/palette.ts。

命令树

完整命令树

此映射涵盖核心命令及其主要子命令。插件添加的 子命令(例如 skills、plugins 和 wiki 下的子命令)独立演进; 运行 <command> --help 可获取权威的最新列表。

Code
openclaw [--dev] [--profile <name>] <command>  openclaw  setup  onboard  configure  config    get    set    unset    file    schema    validate  completion  doctor  dashboard  backup    create    verify  migrate    list    plan <provider>    apply <provider>  security    audit  secrets    reload    audit    configure    apply  reset  uninstall  update    wizard    status    repair  channels    list    status    capabilities    resolve    logs    add    remove    login    logout  directory    self    peers list    groups list|members  skills    search    install    update    verify    workshop list|inspect|propose-create|propose-update|revise|apply|reject|quarantine    list    info    check  plugins    list    search    inspect    install    uninstall    update    enable    disable    doctor    build    validate    init    registry    marketplace list|entries|refresh  workboard    list    create    show    dispatch  memory    status    index    search  transcripts    list    show    path  path    resolve    find    set    validate    emit  commitments    list    dismiss  wiki    status    doctor    init    compile    lint    ingest    okf import    search    get    apply synthesis|metadata    bridge import    unsafe-local import    chatgpt import|rollback    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  attach  acp  mcp    serve    list    show    set    unset  status  health  sessions    cleanup  audit  tasks    list    audit    maintenance    show    notify    cancel    flow list|show|cancel  gateway    call    usage-cost    health    stability    diagnostics export    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    auth list|add|login|setup-token|paste-token|paste-api-key|login-github-copilot    auth order get|set|clear  promos    list    claim <slug>  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|personas|providers|status|enable|disable|set-provider|set-persona    video generate|describe|providers    web search|fetch|providers    embedding create|providers  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  worker  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)

插件可以添加其他顶级命令,例如 openclaw workboard 或 openclaw voicecall。

聊天斜杠命令

聊天消息支持 /... 命令。请参阅斜杠命令。

重点功能:

  • /status - 快速诊断。
  • /trace - 会话范围的插件跟踪/调试行。
  • /config - 持久化配置更改。
  • /debug - 仅运行时配置覆盖(存储在内存而非磁盘中;需要 commands.debug: true)。

用量跟踪

当 OAuth/API 凭据可用时,openclaw status --usage 和 Control UI 会显示提供商用量/配额。数据直接来自提供商用量端点,并被规范化为 X% left。目前提供用量周期数据的提供商包括:Anthropic、Gemini CLI、GitHub Copilot、MiniMax、OpenAI Codex、Xiaomi 和 z.ai。

有关详细信息,请参阅用量跟踪。

相关内容

Was this useful?