Keyboard shortcuts

Press or to navigate between chapters

Press ? to show this help

Press Esc to hide this help

zeroclaw 的命令行帮助

此文档包含 zeroclaw 命令行程序的帮助内容。

命令概览:

zeroclaw

最快、最小的 AI 助手。

用法: zeroclaw [OPTIONS] <COMMAND>

子命令:

  • quickstart — 快速入门 — 端到端创建一个可工作的代理。用单一路径替代逐节引导流程,该路径由预设驱动。交互式:下面的标志会预先填充清单选择器,但不会跳过它们;需要终端
  • onboard — 已弃用。使用 zeroclaw quickstart。任何参数都会报错
  • agent — 启动 AI 代理循环
  • gateway — 启动/管理网关服务器(webhooks、websockets)
  • acp — 通过 stdio 启动 ACP (Agent Control Protocol) 服务器
  • daemon — 启动长期运行的自主运行时(gateway + channels + heartbeat + scheduler)
  • service — 管理 OS 服务生命周期(launchd/systemd 用户服务)
  • doctor — 运行 daemon/scheduler/channel 新鲜度诊断
  • status — 显示系统状态(完整详情)
  • estop
  • cron — 配置和管理计划任务
  • models — 管理 model_provider 模型目录
  • providers — 提供方的别名增删改查([providers.<category>.<family>.<alias>])。categorymodelsttstranscription 之一
  • channel — 管理频道(telegram、discord、slack)
  • agents — 管理 agent 别名(创建/列出/重命名/删除)。与 agent 不同,后者用于运行一个 agent
  • channels — 管理 channel 别名(创建/列出/重命名/删除)
  • integrations — 浏览 50+ 个集成
  • skills — 管理技能(用户定义的能力)
  • browse — 一次浏览共享工作区中的一个目录
  • sop — 管理标准操作程序(SOP)
  • migrate — 从其他代理运行时迁移数据
  • auth — 管理 model_provider 订阅认证配置文件
  • hardware — 发现并检查 USB 硬件
  • peripheral — 管理硬件外设(STM32、RPi GPIO 等)
  • memory — 管理代理内存(list、get、stats、clear)
  • config — 管理配置
  • update — 检查并应用更新
  • self-test — 运行诊断自检
  • completions — 将 shell 补全脚本生成到 stdout
  • desktop — 启动配套桌面应用,或打开其下载页面
  • locales — 从上游获取已翻译的区域设置文件 (FTL)

选项:

  • --config-dir <CONFIG_DIR>

  • --log-level <LOG_LEVEL> — 记录到运行时跟踪(以及捕获层)的最低严重级别。对该进程不可变。优先级:此标志 > RUST_LOG 环境变量 > 每个命令的默认值

    可能的值:errorwarninfodebugtrace

  • -v, --verbose — 在终端显示已记录的日志。默认关闭:日志仅写入 trace 文件,终端只显示命令输出。开启后,终端会显示一直到记录下限的事件。对进程而言不可变。

zeroclaw quickstart

快速入门 — 端到端创建一个可工作的代理。用一条预设驱动的路径替代按部分分步的入门流程。交互式:下面的标志会预先填充清单选择项,但不会跳过它们;需要终端

用法: zeroclaw quickstart [OPTIONS]

选项:

  • --model-provider <MODEL_PROVIDER> — 提供方类型(anthropic / openai / openrouter / ollama)
  • --model <MODEL> — 新提供程序条目的模型 ID
  • --api-key <API_KEY> — 新提供方条目的 API 密钥(ollama / local 可省略)
  • --agent <AGENT> — 新代理的别名。默认使用已清理的提供程序名称

zeroclaw onboard

已弃用。改用 zeroclaw quickstart。任何标志错误

用法: zeroclaw onboard [COMMAND]

子命令:

  • providers.models — 选择要配置的模型提供方(Anthropic、OpenAI、OpenRouter、Ollama、兼容 OpenAI 的自定义网关等)。每个提供方支持多个别名——例如 anthropic.production 和 anthropic.dev 可以共存
  • model_routes — 命名模型路由提示(例如 reasoning、fast、code)。每个路由将一个提示映射到特定的 provider + model 组合。使用 hint:<name> 作为模型参数,通过路由进行分发
  • embedding_routes — 命名的 embedding 路由提示(例如 semantic、archive、faq)。每条路由将一个提示映射到一个支持 embedding 的 provider + model 组合。将 hint:<name> 作为 embedding_model 参数使用
  • risk_profiles — 命名风险配置文件,绑定允许列表、拒绝列表和审批阈值。Agent 通过 agents.<alias>.risk_profile 引用其中一个
  • runtime_profiles — 命名的运行时调优配置文件(令牌限制、重试策略、超时)。代理通过 agents.<alias>.runtime_profile 引用其中一个
  • storage — SQLite 是单节点安装的安全默认选择(基于文件、零配置、无需额外服务)。共享或多实例部署请选择 Postgres,向量搜索请选择 Qdrant,可读文件请选择 Markdown 或 Lucid。每个后端都支持多个别名实例;代理通过 memory.storage_ref 引用它们
  • memory — 持久化内存后端。SQLite 是默认值;选择 none 可完全禁用长期记忆
  • skills — Skills 工具设置 — skill markdown 在磁盘上的存放位置(默认在 data dir),以及 skills loader 如何处理 community repositories。在下面的 skill-bundles 下添加 skill BUNDLES
  • skill_bundles — 命名的技能文件集合。代理在启动时引用一个捆绑包以加载一组能力
  • mcp — Model Context Protocol 设置。切换 enabled 并选择延迟或即时加载。各个 MCP 服务器位于 mcp.servers[]
  • mcp.servers — 单个 Model Context Protocol 服务器。每个条目会绑定一个传输方式(stdio、http、sse)、用于连接它的命令或 URL、可选请求头,以及 tool_timeout_secs 上限(≤ 600)。每个服务器的 name 是其可寻址键——请通过该分节页面重命名,而不是直接编辑该字段。将服务器分组到下面的 mcp_bundles 中。
  • mcp_bundles — MCP 服务器的命名捆绑包,授予在其 mcp_bundles 中列出该捆绑包的代理。默认安全:代理只会获得其捆绑包所授予的服务器;如果没有捆绑包,则不会获得任何 MCP 服务器
  • knowledge_bundles — 知识源(RAG 索引、文档文件夹)的命名集合。Agent 在推理时引用某个集合以呈现相关片段
  • providers.tts — 文本转语音提供程序(OpenAI、ElevenLabs、Google、Edge、Piper)。每个语音/语言配置一个;agent 通过别名引用它们
  • providers.transcription — 语音转文本提供方(OpenAI Whisper、Groq、Deepgram、AssemblyAI、Google、本地 Whisper)。每个 pipeline 配置一个;agents 通过别名引用它们
  • channels — 选择 ZeroClaw 应监听哪些聊天平台。全局频道设置位于 [channels];每个已配置的平台仍然会有自己的别名
  • hardware — 可选:硬件外设(Arduino、STM32、GPIO 等)。如果不需要,请跳过
  • agents — 代理将模型提供方、配置文件、捆绑包和通道绑定为一个可调度单元。每个 persona 添加一个;在各通道间复用同一别名以共享状态
  • peer_groups — 将通道、成员代理和外部对等方绑定在一起的命名组。双向同意:只有当两个代理都出现在同一组的 agents 列表中时,它们才会成为对等方
  • cron — 定时任务。每个 cron 条目将一个调度表达式绑定到一个 prompt、channel 和 target
  • tunnel — 可选:通过 Cloudflare 或 ngrok 将你的网关暴露到公共互联网。选择 none 可保持仅限本地主机访问
  • onboard_state — 快速入门生命周期状态。quickstart_completed 在 Quickstart 成功运行完成后变为 true;在为 false 时,web gateway 和 TUI 会在启动时自动启动 Quickstart。completed_sections 是为向后兼容先前数据而保留的按 section 记录的旧版账本

zeroclaw onboard providers.models

选择一个模型提供方进行配置(Anthropic、OpenAI、OpenRouter、Ollama、自定义 OpenAI 兼容网关等)。每个提供方支持多个别名——例如,anthropic.production 和 anthropic.dev 可以共存

用法: zeroclaw onboard providers.models

zeroclaw onboard model_routes

命名模型路由提示(例如 reasoning、fast、code)。每条路由将一个提示映射到特定的提供方 + 模型组合。将 hint:<name> 作为模型参数,以通过路由进行分发

用法: zeroclaw onboard model_routes

zeroclaw onboard embedding_routes

命名嵌入路由提示(例如 semantic、archive、faq)。每条路由将一个提示映射到一个支持嵌入的提供方 + 模型组合。使用 hint:<name> 作为 embedding_model 参数

用法: zeroclaw onboard embedding_routes

zeroclaw onboard risk_profiles

命名风险配置文件将允许列表、拒绝列表和审批阈值绑定在一起。Agents 通过 agents.<alias>.risk_profile 引用其中一个

用法: zeroclaw onboard risk_profiles

zeroclaw onboard runtime_profiles

命名的运行时调优配置文件(令牌限制、重试策略、超时)。代理通过 agents.<alias>.runtime_profile 引用其中一个

用法: zeroclaw onboard runtime_profiles

zeroclaw onboard storage

SQLite 是单节点安装的安全默认选择(基于文件、零配置、无需额外服务)。对于共享或多实例部署请选择 Postgres,对于向量搜索请选择 Qdrant,对于可读文件请选择 Markdown 或 Lucid。每个后端都支持多个别名实例;代理通过 memory.storage_ref 引用它们

用法: zeroclaw onboard storage

zeroclaw onboard memory

持久内存后端。SQLite 是默认值;选择 none 可完全禁用长期记忆

用法: zeroclaw onboard memory

zeroclaw onboard skills

Skills 工具设置 — skill markdown 在磁盘上的存放位置(默认为数据目录),以及 skills 加载器如何处理社区仓库。请在下面的 skill-bundles 下添加 skill BUNDLES

用法: zeroclaw onboard skills

zeroclaw onboard skill_bundles

技能文件的命名集合。代理在启动时引用一个 bundle 来加载一组能力

用法: zeroclaw onboard skill_bundles

zeroclaw onboard mcp

Model Context Protocol 设置。切换 enabled 并选择延迟或即时加载。各个 MCP 服务器位于 mcp.servers[]

用法: zeroclaw onboard mcp

zeroclaw onboard mcp.servers

单独的 Model Context Protocol 服务器。每个条目都会绑定一种传输方式(stdio、http、sse)、用于访问它的命令或 URL、可选的标头,以及一个 tool_timeout_secs 上限(≤ 600)。每个服务器的 name 都是其可寻址的键 — 请通过该部分页面重命名,而不是直接编辑该字段。将服务器分组到下面的 mcp_bundles 中。

用法: zeroclaw onboard mcp.servers

zeroclaw onboard mcp_bundles

MCP 服务器的命名捆绑包,授予那些在其 mcp_bundles 中列出该捆绑包的代理。默认安全:代理只能获得其捆绑包所授予的服务器;没有捆绑包时,它不会获得任何 MCP 服务器

用法: zeroclaw onboard mcp_bundles

zeroclaw onboard knowledge_bundles

命名的知识源集合(RAG 索引、文档文件夹)。代理引用一个 bundle,以便在推理时呈现相关片段

用法: zeroclaw onboard knowledge_bundles

zeroclaw onboard providers.tts

文本转语音提供商(OpenAI、ElevenLabs、Google、Edge、Piper)。按每个语音/语言配置一个;代理通过别名引用它们

用法: zeroclaw onboard providers.tts

zeroclaw onboard providers.transcription

语音转文本提供方(OpenAI Whisper、Groq、Deepgram、AssemblyAI、Google、本地 Whisper)。每个流水线配置一个;代理通过别名引用它们

用法: zeroclaw onboard providers.transcription

zeroclaw onboard channels

选择 ZeroClaw 应监听的聊天平台。全局频道设置位于 [channels];每个已配置的平台仍然有自己的别名

用法: zeroclaw onboard channels

zeroclaw onboard hardware

可选:硬件外设(Arduino、STM32、GPIO 等)。如果不需要它们,请跳过

用法: zeroclaw onboard hardware

zeroclaw onboard agents

代理将模型提供程序、配置文件、bundle 和 channel 绑定为一个可分发单元。每个 persona 添加一个;在各个 channel 中复用同一个别名以共享状态

用法: zeroclaw onboard agents

zeroclaw onboard peer_groups

将通道、成员代理和外部对等方绑定在一起的命名组。互相自愿加入:只有当两个代理都出现在同一组的 agents 列表中时,它们才会成为对等方

用法: zeroclaw onboard peer_groups

zeroclaw onboard cron

计划任务。每个 cron 条目将一个调度表达式绑定到一个提示、频道和目标

用法: zeroclaw onboard cron

zeroclaw onboard tunnel

可选:通过 Cloudflare 或 ngrok 将你的网关暴露到公共互联网。选择 none 可保持仅限本地主机。

用法: zeroclaw onboard tunnel

zeroclaw onboard onboard_state

快速入门生命周期状态。quickstart_completed 在 Quickstart 成功运行完成后会变为 true;在其为 false 时,Web 网关和 TUI 会在启动时自动启动 Quickstart。completed_sections 是为向后兼容历史数据而保留的按章节记录的旧版清单

用法: zeroclaw onboard onboard_state

zeroclaw agent

启动 AI 代理循环。

启动与已配置的 AI model_provider 的交互式聊天会话。使用 –message 进行单次查询,而不进入交互模式。

示例:zeroclaw agent -a assistant # 交互式会话 zeroclaw agent -a assistant -m “Summarize today’s logs” # 单条消息 zeroclaw agent -a assistant -p anthropic –model claude-sonnet-4-20250514 zeroclaw agent -a assistant –peripheral nucleo-f401re:/dev/ttyACM0

用法: zeroclaw agent [OPTIONS] --agent <AGENT>

选项:

  • -a, --agent <AGENT> — 配置要运行的 agent 别名(必须匹配 [agents.<alias>])。必需——没有默认 agent
  • -m, --message <MESSAGE> — 单消息模式(不要进入交互模式)
  • --session-state-file <SESSION_STATE_FILE> — 在此 JSON 文件中加载并保存交互会话状态
  • -p, --model-provider <MODEL_PROVIDER> — 要使用的模型提供商(openrouter、anthropic、openai、openai-codex)
  • --model <MODEL> — 要使用的模型
  • -t, --temperature <TEMPERATURE> — 温度(0.0 - 2.0,默认为 providers.models.<type>.<alias>.temperature
  • --peripheral <PERIPHERAL> — 连接一个外设(board:path,例如 nucleo-f401re:/dev/ttyACM0)

zeroclaw gateway

管理网关服务器(webhooks、websockets)。

启动、重启或检查接受传入 webhook 事件和 WebSocket 连接的 HTTP/WebSocket 网关。

示例:zeroclaw gateway start # 启动网关 zeroclaw gateway restart # 重启网关 zeroclaw gateway get-paircode # 显示配对码

用法: zeroclaw gateway [COMMAND]

子命令:

  • start — 启动网关服务器(如果未指定子命令,则为默认值)
  • restart — 重启网关服务器
  • get-paircode — 显示或生成配对代码,而无需重启

zeroclaw gateway start

启动网关服务器(webhooks、websockets)。

运行接受传入 webhook 事件和 WebSocket 连接的 HTTP/WebSocket 网关。绑定地址默认使用配置文件中的值(gateway.host / gateway.port)。

示例:zeroclaw gateway start # 使用配置默认值 zeroclaw gateway start -p 8080 # 监听 8080 端口 zeroclaw gateway start –host 0.0.0.0 # 需要 [gateway].allow_public_bind=true 或隧道 zeroclaw gateway start -p 0 # 随机可用端口

用法: zeroclaw gateway start [OPTIONS]

选项:

  • -p, --port <PORT> — 监听端口(使用 0 表示随机可用端口);默认值为配置项 gateway.port
  • --host <HOST> — 绑定到的主机;默认使用配置中的 gateway.host 注意:绑定到 0.0.0.0 需要在配置中设置 gateway.allow_public_bind = true
  • --allow-degraded-security — 即使在加载期间安全关键配置段被恢复为默认值(安全姿态降低)时也启动。默认关闭

zeroclaw gateway restart

重启网关服务器。

如果存在正在运行的网关,则停止它,然后使用当前配置启动一个新实例。

示例:zeroclaw gateway restart # 使用配置默认值重新启动 zeroclaw gateway restart -p 8080 # 在端口 8080 上重新启动

用法: zeroclaw gateway restart [OPTIONS]

选项:

  • -p, --port <PORT> — 监听端口(使用 0 表示随机可用端口);默认值为配置项 gateway.port
  • --host <HOST> — 绑定到的主机;默认使用配置中的 gateway.host 注意:绑定到 0.0.0.0 需要在配置中设置 gateway.allow_public_bind = true
  • --allow-degraded-security — 即使在加载期间安全关键配置段被恢复为默认值(安全姿态降低)时也启动。默认关闭

zeroclaw gateway get-paircode

显示或生成网关配对代码。

显示用于连接新客户端的配对代码,而无需重启网关。要求网关正在运行。

使用 –new,即使网关之前已配对,也会生成一个新的配对码(用于添加其他客户端时很有用)。这不会撤销现有令牌。

使用 –rotate 时,会撤销所有已配对的 bearer 令牌,清除设备注册表,并签发一个新代码。当你怀疑令牌泄露但不知道是哪个令牌被泄露时,请在此之后使用;所有客户端都必须重新配对。

使用 --rotate-device ID 时,只会撤销该设备的 bearer token,并为重新配对该设备发放一个新 code。

示例:zeroclaw gateway get-paircode # 显示当前配对码 zeroclaw gateway get-paircode –new # 添加另一个客户端(不撤销) zeroclaw gateway get-paircode –rotate # 撤销所有令牌,然后颁发一个代码 zeroclaw gateway get-paircode –rotate-device dash-1 # 撤销一个设备的令牌 zeroclaw gateway get-paircode –new –port 3001 # 目标备用端口网关

用法: zeroclaw gateway get-paircode [OPTIONS]

选项:

  • --new — 生成用于添加客户端的新配对代码(不会撤销现有令牌)
  • --rotate — 撤销所有已配对令牌并清除设备注册表,然后发放一个新代码
  • --rotate-device <DEVICE_ID> — 按 id 撤销单个设备的 bearer token,然后签发新的 code
  • -p, --port <PORT> — 要查询的运行中网关的端口;默认为配置项 gateway.port
  • --host <HOST> — 要查询的运行中网关的主机;默认为配置项 gateway.host

zeroclaw acp

启动 ACP 服务器(通过 stdio 传输的 JSON-RPC 2.0)。

在 stdin/stdout 上启动一个 JSON-RPC 2.0 服务器,用于 IDE 和工具集成。支持会话管理以及将代理响应作为通知进行流式传输。

方法:initialize、session/new、session/prompt、session/stop。

示例:zeroclaw acp # 启动 ACP 服务器 zeroclaw acp –max-sessions 5 # 限制并发会话

用法: zeroclaw acp [OPTIONS]

选项:

  • --max-sessions <MAX_SESSIONS> — 最大并发会话数(默认值:10)
  • --session-timeout <SESSION_TIMEOUT> — 会话不活动超时时间,单位为秒(默认值:3600)

zeroclaw daemon

启动长时间运行的自治守护进程。

启动完整的 ZeroClaw 运行时:网关服务器、所有已配置的渠道(Telegram、Discord、Slack 等)、心跳监控器,以及 cron 调度器。这是在生产环境中或作为始终在线助手运行 ZeroClaw 的推荐方式。

使用 zeroclaw service install 将守护进程注册为 OS 服务(systemd/launchd),以便在启动时自动启动。

示例:zeroclaw daemon # 使用配置默认值 zeroclaw daemon -p 9090 # 9090 端口上的网关 zeroclaw daemon –host 127.0.0.1 # 仅限本地主机

用法: zeroclaw daemon [OPTIONS]

选项:

  • -p, --port <PORT> — 监听端口(使用 0 表示随机可用端口);默认值为配置项 gateway.port
  • --host <HOST> — 要绑定的主机;默认使用 config gateway.host
  • --ephemeral — 在所有 socket 客户端断开连接后自我终止(带宽限期)
  • --allow-degraded-security — 即使在加载过程中安全关键配置段被降级为默认值,也继续启动。否则,守护进程会因安全态势被削弱而拒绝启动;启用后,守护进程会启动,以便操作员可以进入修复界面,并持续发出重复警告

zeroclaw service

管理 OS 服务生命周期(launchd/systemd 用户服务)

用法: zeroclaw service [OPTIONS] <COMMAND>

子命令:

  • install — 安装守护进程服务单元以实现自动启动和重启
  • start — 启动守护进程服务
  • stop — 停止守护进程服务
  • restart — 重启守护进程服务以应用最新配置
  • status — 检查守护进程服务状态
  • uninstall — 卸载守护进程服务单元
  • logs — 跟踪守护进程服务日志

选项:

  • --service-init <SERVICE_INIT> — 要使用的初始化系统:auto(检测)、systemd 或 openrc

    默认值:auto

    可能的值:autosystemdopenrc

zeroclaw service install

安装守护进程服务单元以实现自动启动和重启

用法: zeroclaw service install

zeroclaw service start

启动守护进程服务

用法: zeroclaw service start

zeroclaw service stop

停止守护进程服务

用法: zeroclaw service stop

zeroclaw service restart

重启守护进程服务以应用最新配置

用法: zeroclaw service restart

zeroclaw service status

检查守护进程服务状态

用法: zeroclaw service status

zeroclaw service uninstall

卸载守护进程服务单元

用法: zeroclaw service uninstall

zeroclaw service logs

尾随守护进程服务日志

用法: zeroclaw service logs [OPTIONS]

选项:

  • -n, --lines <LINES> — 要显示的行数(默认:50)

    默认值:50

  • -f, --follow — 跟踪日志输出(如 tail -f)

zeroclaw doctor

运行 daemon/scheduler/channel 新鲜度的诊断

用法: zeroclaw doctor [COMMAND]

子命令:

  • models — 探测各个 model_providers 中的模型目录并报告可用性
  • traces — 查询运行时 trace 事件(工具诊断和模型回复)
  • update-context-windows — 从提供方 /models 端点更新 config.toml 中的 context_window

zeroclaw doctor models

探测 model_providers 中的模型目录并报告可用性

用法: zeroclaw doctor models [OPTIONS]

选项:

  • --model-provider <MODEL_PROVIDER> — 仅探测特定的 model_provider(默认:所有已知的 model_provider)
  • --use-cache — 优先使用可用的缓存目录(跳过强制的实时刷新)

zeroclaw doctor traces

查询运行时跟踪事件(工具诊断和模型回复)

用法: zeroclaw doctor traces [OPTIONS]

选项:

  • --id <ID> — 按 id 显示特定的跟踪事件

  • --event <EVENT> — 按事件类型筛选列表输出

  • --contains <CONTAINS> — 跨消息/载荷的不区分大小写文本匹配

  • --limit <LIMIT> — 要显示的事件最大数量

    默认值:20

zeroclaw doctor update-context-windows

从 provider /models 端点更新 config.toml 中的 context_window

用法: zeroclaw doctor update-context-windows [OPTIONS]

选项:

  • --model-provider <MODEL_PROVIDER> — 仅更新特定的 model_provider(默认:所有已知的 model_provider)
  • --dry-run — 显示将要更新的内容,但不写入配置

zeroclaw status

显示系统状态(完整详情)

用法: zeroclaw status [OPTIONS]

选项:

  • --format <FORMAT> — 输出格式:“exit-code” 在健康时返回 0,否则返回 1(用于 Docker HEALTHCHECK)

zeroclaw estop

用法: zeroclaw estop [OPTIONS] [COMMAND]

子命令:

  • status — 打印当前急停状态
  • resume — 从已触发的 estop 级别恢复

选项:

  • --level <LEVEL> — 在使用 zeroclaw estop 启用 estop 时使用的级别

    可能的值:kill-allnetwork-killdomain-blocktool-freeze

  • --domain <DOMAINS>domain-block 的域名模式(可重复)

  • --tool <TOOLS>tool-freeze 的工具名称(可重复)

zeroclaw estop status

打印当前 estop 状态

用法: zeroclaw estop status

zeroclaw estop resume

从已触发的 estop 级别恢复

用法: zeroclaw estop resume [OPTIONS]

选项:

  • --network — 仅恢复网络终止
  • --domain <DOMAINS> — 恢复一个或多个被阻止的域模式
  • --tool <TOOLS> — 恢复一个或多个已冻结的工具
  • --otp <OTP> — OTP 代码。如果省略且需要 OTP,将显示提示

zeroclaw cron

配置和管理计划任务。

使用 cron 表达式、带有显式 Z 或偏移量的 RFC3339 时间戳、持续时间或固定间隔来安排周期性、一次性或基于间隔的任务。

Cron 表达式使用标准的 5 字段格式:‘min hour day month weekday’。当省略 –tz 时,cron 调度使用运行时的本地时区。对于面向用户的调度,请传入 –tz 并指定明确的 IANA 时区。

示例: zeroclaw cron list zeroclaw cron add ‘0 9 * * 1-5’ ‘Good morning’ –agent sentinel –prompt –tz America/New_York zeroclaw cron add ‘*/30 * * * ’ ‘Check system health’ –agent sentinel –prompt zeroclaw cron add ‘/5 * * * *’ ‘echo ok’ –agent sentinel zeroclaw cron add-at 2099-01-15T14:00:00Z ‘Send reminder’ –agent sentinel –prompt zeroclaw cron add-every 60000 ‘Ping heartbeat’ –agent sentinel –prompt zeroclaw cron once 30m ‘Run backup in 30 minutes’ –agent sentinel –prompt zeroclaw cron pause TASK_ID zeroclaw cron update TASK_ID –expression ‘0 8 * * *’ –tz Europe/London

用法: zeroclaw cron <COMMAND>

子命令:

  • list — 列出所有计划任务
  • add — 添加新的计划任务
  • add-at — 在带有显式 Z 或偏移量的 RFC3339 时间戳处添加一次性计划任务
  • add-every — 添加固定间隔计划任务
  • once — 添加一个一次性延迟任务(例如 “30m”、“2h”、“1d”)
  • remove — 移除计划任务
  • update — 更新计划任务
  • pause — 暂停已计划的任务
  • resume — 恢复暂停的任务

zeroclaw cron list

列出所有计划任务

用法: zeroclaw cron list

zeroclaw cron add

添加一个新的重复计划任务。

使用标准的 5 字段 cron 语法:‘min hour day month weekday’。当省略 –tz 时,cron 计划使用运行时的本地时区。对于面向用户的计划,请传入带有明确 IANA 时区的 –tz。

示例:zeroclaw cron add ‘0 9 * * 1-5’ ‘Good morning’ –agent sentinel –prompt –tz America/New_York zeroclaw cron add ‘*/30 * * * ’ ‘Check system health’ –agent sentinel –prompt zeroclaw cron add ‘/5 * * * *’ ‘echo ok’ –agent sentinel

用法: zeroclaw cron add [OPTIONS] --agent <AGENT_ALIAS> <EXPRESSION> <COMMAND>

参数:

  • <EXPRESSION> — Cron 表达式
  • <COMMAND> — 要运行的命令(shell)或提示词(当使用 –prompt 时)

选项:

  • -a, --agent <AGENT_ALIAS> — 已配置的 cron 作业运行所使用的代理别名。必填——没有默认代理

  • --tz <TZ> — 可选的 IANA 时区(例如 America/Los_Angeles)

  • --prompt — 将参数视为代理提示词,而不是 shell 命令

  • --allowed-tool <ALLOWED_TOOLS> — 将 agent cron jobs 限制为指定的工具名称(可重复,仅提示)

  • --uses-memory <USES_MEMORY> — 如果为 false,则为此代理 cron 作业禁用内存回忆(默认值:true)。对于不应累积或消耗内存的无状态摘要/报告作业,请将其设为 false

    可能的值:truefalse

  • --channel <DELIVERY_CHANNEL> — 将作业输出发布到此频道(例如 telegram、discord、slack)

  • --to <DELIVERY_TO> — 频道的目标聊天/收件人 ID(例如 Telegram 聊天 ID)。

    之所以需要 allow_hyphen_values,是因为受支持的接收者以连字符开头:Telegram 群组和频道 ID 为负数(-100…),而论坛主题目标的格式为 chat:thread-100…:42),它以连字符开头,但不是数字。如果没有此选项,clap 会将该值视为标志,并在执行任何投递验证之前退出,导致只有未记录的 --to=<value> 形式可用。

    仅设置 allow_negative_numbers 还不够:它接受 -100…,但仍会拒绝 chat:thread 形式。单独使用这个更宽泛的设置会让遗漏的值吞掉后续标志,因此 parse_delivery_recipient 会拒绝以 --- 开头的值,并指出有问题的令牌。

  • --thread <DELIVERY_THREAD> — 可选的线程/会话 ID,适用于根据该 ID 进行路由的频道(webhook)

  • --no-best-effort — 如果交付失败,则作业失败(默认:交付错误不会导致作业失败)

  • --best-effort — 在交付失败时仍使作业成功。恢复之前使用 --no-best-effort 后的默认行为

zeroclaw cron add-at

添加一个在指定的 RFC3339 时间戳(带明确的 Z 或偏移)触发的一次性任务。

时间戳必须包含显式的 Z 或数字偏移量(例如 2099-01-15T14:00:00Z 或 2099-01-15T09:00:00-05:00)。

示例:zeroclaw cron add-at –agent morning-shift –prompt 2099-01-15T14:00:00Z ‘Send reminder’ zeroclaw cron add-at –agent morning-shift –prompt 2099-12-31T23:59:00Z ‘Happy New Year!’

用法: zeroclaw cron add-at [OPTIONS] --agent <AGENT_ALIAS> <AT> <COMMAND>

参数:

  • <AT> — 带显式 Z 或偏移量的一次性 RFC3339 时间戳
  • <COMMAND> — 要运行的命令(shell)或提示词(当使用 –prompt 时)

选项:

  • -a, --agent <AGENT_ALIAS> — 配置的代理别名,cron 作业以此身份运行

  • --prompt — 将参数视为代理提示词,而不是 shell 命令

  • --allowed-tool <ALLOWED_TOOLS> — 将 agent cron jobs 限制为指定的工具名称(可重复,仅提示)

  • --uses-memory <USES_MEMORY> — 如果为 false,则为此代理 cron 作业禁用记忆召回(默认值:true)

    可能的值:truefalse

  • --channel <DELIVERY_CHANNEL> — 将作业输出发布到此频道(例如 telegram、discord、slack)

  • --to <DELIVERY_TO> — 频道的目标聊天/收件人 ID(例如 Telegram 聊天 ID)。

    之所以需要 allow_hyphen_values,是因为受支持的接收者以连字符开头:Telegram 群组和频道 ID 为负数(-100…),而论坛主题目标的格式为 chat:thread-100…:42),它以连字符开头,但不是数字。如果没有此选项,clap 会将该值视为标志,并在执行任何投递验证之前退出,导致只有未记录的 --to=<value> 形式可用。

    仅设置 allow_negative_numbers 还不够:它接受 -100…,但仍会拒绝 chat:thread 形式。单独使用这个更宽泛的设置会让遗漏的值吞掉后续标志,因此 parse_delivery_recipient 会拒绝以 --- 开头的值,并指出有问题的令牌。

  • --thread <DELIVERY_THREAD> — 可选的线程/会话 ID,适用于根据该 ID 进行路由的频道(webhook)

  • --no-best-effort — 如果交付失败,则作业失败(默认:交付错误不会导致作业失败)

  • --best-effort — 在交付失败时仍使作业成功。恢复之前使用 --no-best-effort 后的默认行为

zeroclaw cron add-every

添加一个以固定间隔重复的任务。

间隔以毫秒为单位指定。例如,60000 = 1 分钟。

示例: zeroclaw cron add-every –agent triage –prompt 60000 ‘Ping heartbeat’ zeroclaw cron add-every –agent triage –prompt 3600000 ‘Hourly report’

用法: zeroclaw cron add-every [OPTIONS] --agent <AGENT_ALIAS> <EVERY_MS> <COMMAND>

参数:

  • <EVERY_MS> — 间隔(毫秒)
  • <COMMAND> — 要运行的命令(shell)或提示词(当使用 –prompt 时)

选项:

  • -a, --agent <AGENT_ALIAS> — 配置的代理别名,cron 作业以此身份运行

  • --prompt — 将参数视为代理提示词,而不是 shell 命令

  • --allowed-tool <ALLOWED_TOOLS> — 将 agent cron jobs 限制为指定的工具名称(可重复,仅提示)

  • --uses-memory <USES_MEMORY> — 如果为 false,则为此代理 cron 作业禁用记忆召回(默认值:true)

    可能的值:truefalse

  • --channel <DELIVERY_CHANNEL> — 将作业输出发布到此频道(例如 telegram、discord、slack)

  • --to <DELIVERY_TO> — 频道的目标聊天/收件人 ID(例如 Telegram 聊天 ID)。

    之所以需要 allow_hyphen_values,是因为受支持的接收者以连字符开头:Telegram 群组和频道 ID 为负数(-100…),而论坛主题目标的格式为 chat:thread-100…:42),它以连字符开头,但不是数字。如果没有此选项,clap 会将该值视为标志,并在执行任何投递验证之前退出,导致只有未记录的 --to=<value> 形式可用。

    仅设置 allow_negative_numbers 还不够:它接受 -100…,但仍会拒绝 chat:thread 形式。单独使用这个更宽泛的设置会让遗漏的值吞掉后续标志,因此 parse_delivery_recipient 会拒绝以 --- 开头的值,并指出有问题的令牌。

  • --thread <DELIVERY_THREAD> — 可选的线程/会话 ID,适用于根据该 ID 进行路由的频道(webhook)

  • --no-best-effort — 如果交付失败,则作业失败(默认:交付错误不会导致作业失败)

  • --best-effort — 在交付失败时仍使作业成功。恢复之前使用 --no-best-effort 后的默认行为

zeroclaw cron once

添加一个一次性任务,在从现在起延迟一段时间后触发。

接受人类可读的时长:s(秒)、m(分钟)、h(小时)、d(天)。

示例:zeroclaw cron once –agent ops-bot –prompt 30m ‘在 30 分钟后运行备份’ zeroclaw cron once –agent researcher –prompt 2h ‘跟进部署’

用法: zeroclaw cron once [OPTIONS] --agent <AGENT_ALIAS> <DELAY> <COMMAND>

参数:

  • <DELAY> — 延迟时长
  • <COMMAND> — 要运行的命令(shell)或提示词(当使用 –prompt 时)

选项:

  • -a, --agent <AGENT_ALIAS> — 配置的代理别名,cron 作业以此身份运行

  • --prompt — 将参数视为代理提示词,而不是 shell 命令

  • --allowed-tool <ALLOWED_TOOLS> — 将 agent cron jobs 限制为指定的工具名称(可重复,仅提示)

  • --uses-memory <USES_MEMORY> — 如果为 false,则为此代理 cron 作业禁用记忆召回(默认值:true)

    可能的值:truefalse

  • --channel <DELIVERY_CHANNEL> — 将作业输出发布到此频道(例如 telegram、discord、slack)

  • --to <DELIVERY_TO> — 频道的目标聊天/收件人 ID(例如 Telegram 聊天 ID)。

    之所以需要 allow_hyphen_values,是因为受支持的接收者以连字符开头:Telegram 群组和频道 ID 为负数(-100…),而论坛主题目标的格式为 chat:thread-100…:42),它以连字符开头,但不是数字。如果没有此选项,clap 会将该值视为标志,并在执行任何投递验证之前退出,导致只有未记录的 --to=<value> 形式可用。

    仅设置 allow_negative_numbers 还不够:它接受 -100…,但仍会拒绝 chat:thread 形式。单独使用这个更宽泛的设置会让遗漏的值吞掉后续标志,因此 parse_delivery_recipient 会拒绝以 --- 开头的值,并指出有问题的令牌。

  • --thread <DELIVERY_THREAD> — 可选的线程/会话 ID,适用于根据该 ID 进行路由的频道(webhook)

  • --no-best-effort — 如果交付失败,则作业失败(默认:交付错误不会导致作业失败)

  • --best-effort — 在交付失败时仍使作业成功。恢复之前使用 --no-best-effort 后的默认行为

zeroclaw cron remove

移除计划任务

用法: zeroclaw cron remove <ID>

参数:

  • <ID> — 任务 ID

zeroclaw cron update

更新一个或多个现有计划任务的字段。

仅会更改你指定的字段;其他字段保持不变。

示例:zeroclaw cron update TASK_ID –expression ‘0 8 * * *’ zeroclaw cron update TASK_ID –tz Europe/London –name ‘Morning check’ zeroclaw cron update TASK_ID –command ‘Updated message’

用法: zeroclaw cron update [OPTIONS] --agent <AGENT_ALIAS> <ID>

参数:

  • <ID> — 任务 ID

选项:

  • -a--agent <AGENT_ALIAS> — 已配置的代理别名。必填。该别名的风险配置文件会限制 shell 作业中的 shell 命令

  • --expression <EXPRESSION> — 新的 cron 表达式

  • --tz <TZ> — 新的 IANA 时区

  • --command <COMMAND> — 新的 shell 命令;如果作业是 agent 作业,则为新的 agent 提示词

  • --name <NAME> — 新的作业名称

  • --allowed-tool <ALLOWED_TOOLS> — 将代理作业允许列表替换为指定的工具名称(可重复)

  • --uses-memory <USES_MEMORY> — 如果为 false,则为此代理 cron 作业禁用记忆召回(默认值:true)

    可能的值:truefalse

  • --channel <DELIVERY_CHANNEL> — 将作业输出发布到此频道(例如 telegram、discord、slack)

  • --to <DELIVERY_TO> — 频道的目标聊天/收件人 ID(例如 Telegram 聊天 ID)。

    之所以需要 allow_hyphen_values,是因为受支持的接收者以连字符开头:Telegram 群组和频道 ID 为负数(-100…),而论坛主题目标的格式为 chat:thread-100…:42),它以连字符开头,但不是数字。如果没有此选项,clap 会将该值视为标志,并在执行任何投递验证之前退出,导致只有未记录的 --to=<value> 形式可用。

    仅设置 allow_negative_numbers 还不够:它接受 -100…,但仍会拒绝 chat:thread 形式。单独使用这个更宽泛的设置会让遗漏的值吞掉后续标志,因此 parse_delivery_recipient 会拒绝以 --- 开头的值,并指出有问题的令牌。

  • --thread <DELIVERY_THREAD> — 可选的线程/会话 ID,适用于根据该 ID 进行路由的频道(webhook)

  • --no-best-effort — 如果交付失败,则作业失败(默认:交付错误不会导致作业失败)

  • --best-effort — 在交付失败时仍使作业成功。恢复之前使用 --no-best-effort 后的默认行为

zeroclaw cron pause

暂停计划任务

用法: zeroclaw cron pause <ID>

参数:

  • <ID> — 任务 ID

zeroclaw cron resume

恢复暂停的任务

用法: zeroclaw cron resume <ID>

参数:

  • <ID> — 任务 ID

zeroclaw models

管理 model_provider 模型目录

用法: zeroclaw models <COMMAND>

子命令:

  • refresh — 刷新并缓存 model_provider 模型
  • list — 列出在 config.toml 中配置的模型
  • set — 在配置中设置默认模型
  • status — 显示当前模型配置和缓存状态

zeroclaw models refresh

刷新并缓存 model_provider 模型

用法: zeroclaw models refresh [OPTIONS]

选项:

  • --model-provider <MODEL_PROVIDER> — ModelProvider 名称(默认为已配置的默认 model_provider)
  • --all — 刷新所有支持实时模型发现的 model_providers
  • --force — 强制实时刷新并忽略新鲜缓存

zeroclaw models list

列出在 config.toml 中配置的模型

用法: zeroclaw models list [OPTIONS]

选项:

  • --model-provider <MODEL_PROVIDER> — ModelProvider 名称(默认为所有已配置条目)
  • --check — 验证每个已配置模型与提供商的实时目录是否一致

zeroclaw models set

在配置中设置默认模型

用法: zeroclaw models set <MODEL>

参数:

  • <MODEL> — 要设置为默认值的模型名称

zeroclaw models status

显示当前模型配置和缓存状态

用法: zeroclaw models status

zeroclaw providers

提供商的别名 CRUD([providers.<category>.<family>.<alias>])。categorymodelsttstranscription 之一

用法: zeroclaw providers [COMMAND]

子命令:

  • list — 列出提供程序别名(可按类别筛选)
  • create — 使用默认配置创建新的 provider 别名
  • rename — 重命名提供程序别名,重写每个引用
  • delete — 删除提供者别名,并清理引用

zeroclaw providers list

列出提供程序别名(可按类别筛选)

用法: zeroclaw providers list [OPTIONS]

选项:

  • --category <CATEGORY> — 类别:models | tts | transcription

zeroclaw providers create

创建一个带默认配置的新 provider 别名

用法: zeroclaw providers create <CATEGORY> <FAMILY> <ALIAS>

参数:

  • <CATEGORY> — 分类:models | tts | transcription
  • <FAMILY> — 提供商系列(例如 anthropic、openai、elevenlabs)
  • <ALIAS> — 新别名

zeroclaw providers rename

重命名 provider 别名,重写每个引用

用法: zeroclaw providers rename <CATEGORY> <FAMILY> <FROM> <TO>

参数:

  • <CATEGORY>
  • <FAMILY>
  • <FROM>
  • <TO>

zeroclaw providers delete

删除 provider 别名,清理引用

用法: zeroclaw providers delete [OPTIONS] <CATEGORY> <FAMILY> <ALIAS>

参数:

  • <CATEGORY>
  • <FAMILY>
  • <ALIAS>

选项:

  • --dry-run
  • --yes

zeroclaw channel

管理通信渠道。

添加、移除、列出、发送和健康检查将 ZeroClaw 连接到消息平台的频道。支持的频道类型:telegram、discord、slack、whatsapp、matrix、imessage、email。

示例:zeroclaw channel list zeroclaw channel doctor zeroclaw channel add telegram ‘{“bot_token”:“…”,“name”:“my-bot”}’ zeroclaw channel remove my-bot zeroclaw channel bind-telegram zeroclaw_user zeroclaw channel send ‘Alert!’ –channel-id telegram –recipient 123456789

用法: zeroclaw channel <COMMAND>

子命令:

  • list — 列出所有已配置的频道
  • start — 启动所有已配置的 channels(异步情况下由 main.rs 处理)
  • doctor — 对已配置的 channels 运行健康检查(在 main.rs 中由 async 处理)
  • add — 添加新的频道配置
  • remove — 移除频道配置
  • bind-telegram — 将 Telegram 身份(用户名或数字用户 ID)绑定到允许列表
  • send — 向已配置的频道发送消息

zeroclaw channel list

列出所有已配置的频道

用法: zeroclaw channel list

zeroclaw channel start

启动所有已配置的通道(异步由 main.rs 处理)

用法: zeroclaw channel start

zeroclaw channel doctor

为配置的通道运行健康检查(异步在 main.rs 中处理)

用法: zeroclaw channel doctor

zeroclaw channel add

添加新的频道配置。

提供该 channel type 以及该 channel type 所需配置键的一个 JSON object。

支持的类型:telegram、discord、slack、whatsapp、matrix、imessage、email。

示例:zeroclaw channel add telegram ‘{“bot_token”:“…”,“name”:“my-bot”}’ zeroclaw channel add discord ‘{“bot_token”:“…”,“name”:“my-discord”}’

用法: zeroclaw channel add <CHANNEL_TYPE> <CONFIG>

参数:

  • <CHANNEL_TYPE> — 频道类型(telegram, discord, slack, whatsapp, matrix, imessage, email)
  • <CONFIG> — 可选的 JSON 配置

zeroclaw channel remove

移除频道配置

用法: zeroclaw channel remove <NAME>

参数:

  • <NAME> — 要移除的频道名称

zeroclaw channel bind-telegram

将一个 Telegram 身份绑定到允许列表中。

将 Telegram 用户名(不带“@”前缀)或数字用户 ID 添加到频道允许列表中,以便代理会对来自该身份的消息作出响应。

使用 –alias 指定非默认 Telegram 频道 — 它必须与代理使用的 channels.telegram.<alias> 节中的别名匹配。如果不使用它,身份会绑定到 default 别名,非默认代理会不断请求批准。

示例:zeroclaw channel bind-telegram zeroclaw_user zeroclaw channel bind-telegram 123456789 zeroclaw channel bind-telegram 123456789 –alias alerts

用法: zeroclaw channel bind-telegram [OPTIONS] <IDENTITY>

参数:

  • <IDENTITY> — 允许的 Telegram 身份(不含 ‘@’ 的用户名或数字用户 ID)

选项:

  • --alias <ALIAS> — 要绑定到的 Telegram 频道别名(channels.telegram.<alias> 中的 <alias>)。默认为 default

    默认值:default

zeroclaw channel send

向已配置的频道发送一次性消息。

通过指定通道发送文本消息,而不启动完整的代理循环。适用于脚本化通知、硬件传感器告警和自动化流水线。

--channel-id 通过其配置节名称选择频道(例如 ‘telegram’、‘discord’、‘slack’)。--recipient 是平台特定的目标(例如 Telegram 聊天 ID)。

示例:zeroclaw channel send ‘Someone is near your device.’ –channel-id telegram –recipient 123456789 zeroclaw channel send ‘Build succeeded!’ –channel-id discord –recipient 987654321

用法: zeroclaw channel send --channel-id <CHANNEL_ID> --recipient <RECIPIENT> <MESSAGE>

参数:

  • <MESSAGE> — 要发送的消息文本

选项:

  • --channel-id <CHANNEL_ID> — 频道配置名称(例如 telegram、discord、slack)
  • --recipient <RECIPIENT> — 收件人标识符(特定于平台,例如 Telegram 聊天 ID)

zeroclaw agents

管理 agent 别名(创建/列出/重命名/删除)。与 agent 不同,后者用于运行 agent

用法: zeroclaw agents <COMMAND>

子命令:

  • list — 列出已配置的代理别名
  • create — 使用默认配置创建新的代理别名
  • rename — 重命名一个 agent 别名,并重写对它的所有引用
  • delete — 删除代理别名,清除引用并级联删除其拥有的状态

zeroclaw agents list

列出已配置的代理别名

用法: zeroclaw agents list

zeroclaw agents create

创建一个新的 agent 别名并使用默认配置

用法: zeroclaw agents create <ALIAS>

参数:

  • <ALIAS> — 新代理别名(小写字母数字 + 单个下划线)

zeroclaw agents rename

重命名代理别名,重写对它的每个引用

用法: zeroclaw agents rename <FROM> <TO>

参数:

  • <FROM> — 当前别名
  • <TO> — 新别名

zeroclaw agents delete

删除代理别名,清除引用并级联删除其拥有的状态

用法: zeroclaw agents delete [OPTIONS] <ALIAS>

参数:

  • <ALIAS> — 要删除的别名

选项:

  • --dry-run — 显示影响(将被清除的引用),但不删除
  • --yes — 跳过确认提示

zeroclaw channels

管理频道别名(创建/列出/重命名/删除)

用法: zeroclaw channels <COMMAND>

子命令:

  • list — 列出通道别名(可按类型筛选)
  • create — 使用默认配置创建新的 channel 别名
  • rename — 重命名频道别名,并重写每个引用
  • delete — 删除频道别名,清除引用

zeroclaw channels list

列出频道别名(可按类型筛选)

用法: zeroclaw channels list [OPTIONS]

选项:

  • --channel-type <CHANNEL_TYPE> — 频道类型,例如 discord、telegram

zeroclaw channels create

创建一个带默认配置的新 channel 别名

用法: zeroclaw channels create <CHANNEL_TYPE> <ALIAS>

参数:

  • <CHANNEL_TYPE> — 频道类型(discord、telegram、slack,…)
  • <ALIAS> — 新别名

zeroclaw channels rename

重命名频道别名,重写每个引用

用法: zeroclaw channels rename <CHANNEL_TYPE> <FROM> <TO>

参数:

  • <CHANNEL_TYPE>
  • <FROM>
  • <TO>

zeroclaw channels delete

删除频道别名,并清除引用

用法: zeroclaw channels delete [OPTIONS] <CHANNEL_TYPE> <ALIAS>

参数:

  • <CHANNEL_TYPE>
  • <ALIAS>

选项:

  • --dry-run
  • --yes

zeroclaw integrations

浏览 50+ 个集成

用法: zeroclaw integrations <COMMAND>

子命令:

  • info — 显示有关特定集成的详细信息

zeroclaw integrations info

显示有关特定集成的详细信息

用法: zeroclaw integrations info <NAME>

参数:

  • <NAME> — 集成名称

zeroclaw skills

管理技能(用户定义的能力)

用法: zeroclaw skills <COMMAND>

子命令:

  • list — 列出所有已安装的技能
  • add — 从零开始搭建一个新技能(规范的 SKILL.md + 可选子目录)
  • edit — 在 $EDITOR 中打开技能的 SKILL.md(或同级文件)
  • bundle — 管理技能包(技能所在的命名目录)
  • audit — 审计技能源目录或已安装的技能名称
  • install — 从 URL 或本地路径安装新的 skill
  • remove — 移除已安装的技能
  • test — 为某个技能(或所有技能)运行 TEST.sh 验证

zeroclaw skills list

列出所有已安装的技能

用法: zeroclaw skills list [OPTIONS]

选项:

  • --agent <AGENT> — 精确显示此 agent 在运行时加载的内容(其 workspace + open-skills + plugins + assigned bundles)。当同时传入时,–bundle 优先。
  • --bundle <BUNDLE> — 限制为单个 bundle。省略则列出所有 bundles

zeroclaw skills add

在 skill bundle 下搭建一个新 skill。会写入 <bundle.directory>/<name>/SKILL.md,以及规范的可选子目录(scripts/、references/、assets/)。名称必须为小写加连字符;description 为必填项(若省略,会在 TTY 中提示输入)。

示例:zeroclaw skills add code-review –bundle official –description “Review PRs.” zeroclaw skills add ops-runbook –description “Triage prod incidents.” –edit

用法: zeroclaw skills add [OPTIONS] <NAME>

参数:

  • <NAME> — 技能名称(仅小写 + 连字符)

选项:

  • --bundle <BUNDLE> — 目标 bundle 别名。仅在配置了且只有一个 bundle 时可选
  • --description <DESCRIPTION> — 技能的作用以及何时使用它(frontmatter description)。必填;在 TTY 上缺失时会提示输入
  • --license <LICENSE> — SPDX 许可证标识符(例如 MIT)
  • --author <AUTHOR> — 技能作者句柄
  • --version <VERSION> — SemVer 版本(默认为 0.1.0)
  • --category <CATEGORY> — 注册表分组的技能类别
  • --no-scaffold — 跳过 scaffolding scripts/、references/、assets/
  • --edit — 在 scaffold 后用 $EDITOR 打开 SKILL.md

zeroclaw skills edit

在 $EDITOR 中打开某个技能的 SKILL.md(或同级文件)

用法: zeroclaw skills edit [OPTIONS] <NAME>

参数:

  • <NAME> — 技能名称

选项:

  • --bundle <BUNDLE> — 目标 bundle 别名。若名称在所有 bundles 中唯一,则可选
  • --file <FILE> — 编辑兄弟文件而不是 SKILL.md(例如 scripts/runner.sh)

zeroclaw skills bundle

管理技能包(技能所在的命名目录)

用法: zeroclaw skills bundle <COMMAND>

子命令:

  • list — 列出已配置的技能包及其解析后的目录
  • add — 添加新的技能包。目录默认为 shared/skills/<alias>/
  • remove — 移除已配置的技能包(归档其目录 + 将其从每个代理的 skill_bundles 列表中移除)
  • rename — 重命名技能包(移动其目录 + 重写 agent 引用)
  • show — 显示 bundle 的元数据 + 技能列表

zeroclaw skills bundle list

列出已配置的技能包及其解析后的目录

用法: zeroclaw skills bundle list

zeroclaw skills bundle add

添加一个新的 skill bundle。目录默认为 shared/skills/<alias>/

用法: zeroclaw skills bundle add [OPTIONS] <ALIAS>

参数:

  • <ALIAS> — Bundle 别名(小写 + 连字符;与 agents/channels 相同的约定)

选项:

  • --directory <DIRECTORY> — 覆盖目录(相对于安装根目录或绝对路径)。必须解析到 <install>/shared/ 内部

zeroclaw skills bundle remove

移除已配置的 skill bundle(归档其目录 + 将其从每个 agent 的 skill_bundles 列表中移除)

用法: zeroclaw skills bundle remove [OPTIONS] <ALIAS>

参数:

  • <ALIAS> — 包 alias

选项:

  • --yes — 跳过确认提示

zeroclaw skills bundle rename

重命名一个技能包(移动其目录 + 重写 agent 引用)

用法: zeroclaw skills bundle rename <FROM> <TO>

参数:

  • <FROM> — 当前别名
  • <TO> — 新别名

zeroclaw skills bundle show

显示捆绑包的元数据 + 技能列表

用法: zeroclaw skills bundle show <ALIAS>

参数:

  • <ALIAS> — 包 alias

zeroclaw skills audit

审核技能源目录或已安装的技能名称

用法: zeroclaw skills audit <SOURCE>

参数:

  • <SOURCE> — 技能路径或已安装的技能名称

zeroclaw skills install

从 URL 或本地路径安装新技能

用法: zeroclaw skills install [OPTIONS] <SOURCE>

参数:

  • <SOURCE> — 源 URL 或本地路径

选项:

  • --agent <AGENT> — 安装到此 agent 的分配捆绑包中(默认使用当前活动 agent)。当该 agent 没有捆绑包时,回退到全局目录
  • --bundle <BUNDLE> — 直接安装到此 bundle 中。优先于 –agent
  • --no-tier-banner — 仅抑制安装时的层级横幅;其他安装进度输出(resolving、installed、audited)不受影响
  • --skill <SKILL> — 从 git 目录仓库安装单个指定技能(其 skills/<name>/ 目录)

zeroclaw skills remove

移除已安装的技能

用法: zeroclaw skills remove [OPTIONS] <NAME>

参数:

  • <NAME> — 要移除的技能名称

选项:

  • --agent <AGENT> — 将搜索限制为该代理分配的 bundle
  • --bundle <BUNDLE> — 直接从此捆绑中移除(消除重复项的歧义)

zeroclaw skills test

为一个技能(或所有技能)运行 TEST.sh 验证

用法: zeroclaw skills test [OPTIONS] [NAME]

参数:

  • <NAME> — 要测试的技能名称;留空则测试所有技能

选项:

  • --verbose — 显示详细输出

zeroclaw browse

列出 <install>/shared/ 下一个目录的子项。路径相对于 shared 工作区根;会拒绝会逃逸出根目录的 .. 目录穿越。供仪表板的技能包目录选择器以及想查看已安装内容的操作员使用。

示例: zeroclaw browse # 列出 shared/ 根目录 zeroclaw browse skills # 列出 shared/skills/ zeroclaw browse skills/coding # 列出 shared/skills/coding/

用法: zeroclaw browse [PATH]

参数:

  • <PATH> — 相对于 <install>/shared/ 的路径。为空 = 根目录

    默认值:``

zeroclaw sop

管理标准操作程序(SOPs)

用法: zeroclaw sop <COMMAND>

子命令:

  • list — 列出已加载的 SOPs
  • validate — 验证 SOP 定义
  • show — 显示 SOP 的详细信息
  • approve — 批准一个等待带外审批的 SOP 运行(与正在运行的守护进程通信)
  • deny — 拒绝(取消)一个正在等待批准的 SOP 运行(与正在运行的守护进程通信)
  • pending — 列出当前等待批准的 SOP 运行(与正在运行的守护进程通信)
  • graph — 将 SOP 的节点图渲染为文本
  • delete — 从磁盘删除一个 SOP 定义

zeroclaw sop list

列出已加载的 SOPs

用法: zeroclaw sop list

zeroclaw sop validate

验证 SOP 定义

用法: zeroclaw sop validate [NAME]

参数:

  • <NAME> — 要验证的 SOP 名称(如果省略,则为全部)

zeroclaw sop show

显示 SOP 的详细信息

用法: zeroclaw sop show <NAME>

参数:

  • <NAME> — 要显示的 SOP 名称

zeroclaw sop approve

批准一个等待带外审批的 SOP 运行(与正在运行的守护进程通信)

用法: zeroclaw sop approve <RUN_ID>

参数:

  • <RUN_ID> — 要批准的运行 ID

zeroclaw sop deny

拒绝(取消)一个等待批准的 SOP 运行(与正在运行的守护进程通信)

用法: zeroclaw sop deny <RUN_ID> [REASON]

参数:

  • <RUN_ID> — 要拒绝的运行 ID
  • <REASON> — approval ledger 中记录的可选原因

zeroclaw sop pending

列出当前等待批准的 SOP 运行(与正在运行的守护进程通信)

用法: zeroclaw sop pending

zeroclaw sop graph

将 SOP 的节点图渲染为文本

用法: zeroclaw sop graph [OPTIONS] <NAME>

参数:

  • <NAME> — 要渲染的 SOP 名称

选项:

  • --format <FORMAT> — 输出格式

    默认值:outline

    可能的值:

    • outline:每个节点一行,包含其出站流边
    • adjacencyfrom -> to [role] 邻接关系,每行一条边
    • json: 整个投影的格式化 JSON

zeroclaw sop delete

从磁盘中删除一个 SOP 定义

用法: zeroclaw sop delete <NAME>

参数:

  • <NAME> — 要删除的 SOP 名称

zeroclaw migrate

从其他代理运行时迁移数据

用法: zeroclaw migrate <COMMAND>

子命令:

  • openclaw — 将内存从 OpenClaw 工作区导入到此 ZeroClaw 工作区

zeroclaw migrate openclaw

OpenClaw 工作区中的内存导入到这个 ZeroClaw 工作区

用法: zeroclaw migrate openclaw [OPTIONS]

选项:

  • --source <SOURCE> — 到 OpenClaw 工作区的可选路径(默认为 ~/.openclaw/workspace)
  • --dry-run — 验证并预览迁移,而不写入任何数据
  • --reindex — 导入条目后重建后端索引

zeroclaw auth

管理 model_provider 订阅认证配置文件

用法: zeroclaw auth <COMMAND>

子命令:

  • login — 使用 OAuth 登录(OpenAI Codex、Gemini 或 xAI)
  • paste-redirect — 通过粘贴重定向 URL 或 auth code 完成 OAuth
  • paste-token — 粘贴设置令牌 / 认证令牌(用于 Anthropic 订阅认证)
  • setup-tokenpaste-token 的别名(默认交互式)
  • refresh — 使用刷新令牌刷新 OAuth 访问令牌
  • logout — 删除认证配置文件
  • use — 为 model_provider 设置活动配置文件
  • list — 列出 auth 配置文件
  • status — 显示带有当前配置文件和令牌过期信息的认证状态
  • email-login — 通过 OAuth2 设备代码流程验证电子邮件通道

zeroclaw auth login

使用 OAuth 登录(OpenAI Codex、Gemini 或 xAI)

用法: zeroclaw auth login [OPTIONS] --model-provider <MODEL_PROVIDER>

选项:

  • --model-provider <MODEL_PROVIDER> — ModelProvider (openai-codexgeminixai)

  • --profile <PROFILE> — 配置文件名称(默认:default)

    默认值:default

  • --device-code — 使用 OAuth device-code 流程

  • --import <PATH> — 导入现有的 auth.json 文件,而不是开始新的登录流程。支持 openai-codex (~/.codex/auth.json) 和 xai (~/.grok/auth.json)

zeroclaw auth paste-redirect

通过粘贴重定向 URL 或授权码来完成 OAuth

用法: zeroclaw auth paste-redirect [OPTIONS] --model-provider <MODEL_PROVIDER>

选项:

  • --model-provider <MODEL_PROVIDER> — ModelProvider (openai-codexgeminixai)

  • --profile <PROFILE> — 配置文件名称(默认:default)

    默认值:default

  • --input <INPUT> — 完整重定向 URL 或原始 OAuth 代码

zeroclaw auth paste-token

粘贴设置令牌 / 认证令牌(用于 Anthropic 订阅认证)

用法: zeroclaw auth paste-token [OPTIONS] --model-provider <MODEL_PROVIDER>

选项:

  • --model-provider <MODEL_PROVIDER> — ModelProvider (anthropic)

  • --profile <PROFILE> — 配置文件名称(默认:default)

    默认值:default

  • --token <TOKEN> — 令牌值(如果省略,则交互式读取)

  • --auth-kind <AUTH_KIND> — 认证类型覆盖(authorizationapi-key

zeroclaw auth setup-token

paste-token 的别名(默认交互式)

用法: zeroclaw auth setup-token [OPTIONS] --model-provider <MODEL_PROVIDER>

选项:

  • --model-provider <MODEL_PROVIDER> — ModelProvider (anthropic)

  • --profile <PROFILE> — 配置文件名称(默认:default)

    默认值:default

zeroclaw auth refresh

使用刷新令牌刷新 OAuth 访问令牌

用法: zeroclaw auth refresh [OPTIONS] --model-provider <MODEL_PROVIDER>

选项:

  • --model-provider <MODEL_PROVIDER> — ModelProvider (openai-codexgeminixai)
  • --profile <PROFILE> — 配置文件名称或配置文件 ID

zeroclaw auth logout

移除认证配置文件

用法: zeroclaw auth logout [OPTIONS] --model-provider <MODEL_PROVIDER>

选项:

  • --model-provider <MODEL_PROVIDER> — ModelProvider

  • --profile <PROFILE> — 配置文件名称(默认:default)

    默认值:default

zeroclaw auth use

为 model_provider 设置活动配置文件

用法: zeroclaw auth use --model-provider <MODEL_PROVIDER> --profile <PROFILE>

选项:

  • --model-provider <MODEL_PROVIDER> — ModelProvider
  • --profile <PROFILE> — 配置文件名称或完整配置文件 ID

zeroclaw auth list

列出认证配置文件

用法: zeroclaw auth list

zeroclaw auth status

显示带有活动配置文件和令牌过期信息的认证状态

用法: zeroclaw auth status

zeroclaw auth email-login

通过 OAuth2 设备码流程验证电子邮件通道

用法: zeroclaw auth email-login [OPTIONS] --channel <CHANNEL>

选项:

  • --channel <CHANNEL> — 来自 [channels.email.<alias>] 的电子邮件渠道别名(例如 ‘hotmail’)

  • --profile <PROFILE> — 配置文件名称(默认:default)

    默认值:default

zeroclaw hardware

发现并检查 USB 硬件。

枚举已连接的 USB 设备,识别已知的开发板(STM32 Nucleo、Arduino、ESP32),并通过 probe-rs / ST-Link 获取芯片信息。

示例:zeroclaw hardware discover zeroclaw hardware introspect /dev/ttyACM0 zeroclaw hardware info –chip STM32F401RETx

用法: zeroclaw hardware <COMMAND>

子命令:

  • discover — 枚举 USB 设备 (VID/PID) 并显示已知板卡
  • introspect — 按路径检查设备(例如 /dev/ttyACM0)
  • info — 通过 USB 获取芯片信息(通过 ST-Link 使用 probe-rs)。目标设备上无需固件

zeroclaw hardware discover

枚举 USB 设备并显示已知开发板。

按 VID/PID 扫描已连接的 USB 设备,并将其与已知开发板(STM32 Nucleo、Arduino、ESP32)进行匹配。

示例:zeroclaw 硬件发现

用法: zeroclaw hardware discover

zeroclaw hardware introspect

通过其序列号或设备路径 introspect 一个设备。

打开指定的设备路径,并查询板卡信息、固件版本和支持的功能。

示例:zeroclaw hardware introspect /dev/ttyACM0 zeroclaw hardware introspect COM3

用法: zeroclaw hardware introspect <PATH>

参数:

  • <PATH> — 串口或设备路径

zeroclaw hardware info

通过 ST-Link 使用 probe-rs 通过 USB 获取芯片信息。

通过调试探针直接查询目标 MCU,而无需目标板上的任何固件。

示例:zeroclaw hardware info zeroclaw hardware info –chip STM32F401RETx

用法: zeroclaw hardware info [OPTIONS]

选项:

  • --chip <CHIP> — 芯片名称(例如 STM32F401RETx)。默认值:Nucleo-F401RE 的 STM32F401RETx

    默认值:STM32F401RETx

zeroclaw peripheral

管理硬件外设。

添加、列出、刷新并配置向代理暴露工具的硬件板(GPIO、传感器、执行器)。支持的板:nucleo-f401re、rpi-gpio、esp32、arduino-uno。

示例:zeroclaw peripheral 列表 zeroclaw peripheral add nucleo-f401re /dev/ttyACM0 zeroclaw peripheral add rpi-gpio native zeroclaw peripheral flash –port /dev/cu.usbmodem12345 zeroclaw peripheral flash-nucleo

用法: zeroclaw peripheral <COMMAND>

子命令:

  • list — 列出已配置的外设
  • add — 添加一个外设(板路径,例如 nucleo-f401re /dev/ttyACM0)
  • flash — 将 ZeroClaw 固件刷写到 Arduino(创建 .ino,必要时安装 arduino-cli,上传)
  • setup-uno-q — 设置 Arduino Uno Q Bridge 应用(为 agent 控制部署 GPIO bridge)
  • flash-nucleo — 将 ZeroClaw 固件刷写到 Nucleo-F401RE(构建 + probe-rs 运行)

zeroclaw peripheral list

列出已配置的外围设备

用法: zeroclaw peripheral list

zeroclaw peripheral add

按板类型和传输路径添加外围设备。

注册一个硬件板,以便代理可以使用其工具(GPIO、传感器、执行器)。在像 Raspberry Pi 这样的单板计算机上,本地 GPIO 请使用 ‘native’ 作为路径。

支持的板卡:nucleo-f401re、rpi-gpio、esp32、arduino-uno。

示例:zeroclaw peripheral add nucleo-f401re /dev/ttyACM0 zeroclaw peripheral add rpi-gpio native zeroclaw peripheral add esp32 /dev/ttyUSB0

用法: zeroclaw peripheral add <BOARD> <PATH>

参数:

  • <BOARD> — 板类型(nucleo-f401re、rpi-gpio、esp32)
  • <PATH> — 串行传输的路径(/dev/ttyACM0)或用于本地 GPIO 的 “native”

zeroclaw peripheral flash

将 ZeroClaw 固件刷写到 Arduino 板上。

生成 .ino 草图,在 arduino-cli 尚未可用时安装它,编译并上传固件。

示例:zeroclaw peripheral flash zeroclaw peripheral flash –port /dev/cu.usbmodem12345 zeroclaw peripheral flash -p COM3

用法: zeroclaw peripheral flash [OPTIONS]

选项:

  • -p, --port <PORT> — 串口(例如 /dev/cu.usbmodem12345)。如果省略,则使用 config 中的第一个 arduino-uno

zeroclaw peripheral setup-uno-q

设置 Arduino Uno Q Bridge 应用(为代理控制部署 GPIO 桥接)

用法: zeroclaw peripheral setup-uno-q [OPTIONS]

选项:

  • --host <HOST> — Uno Q IP(例如 192.168.0.48)。如果省略,则假定在 Uno Q 上运行

zeroclaw peripheral flash-nucleo

将 ZeroClaw 固件刷写到 Nucleo-F401RE(builds + probe-rs run)

用法: zeroclaw peripheral flash-nucleo

zeroclaw memory

管理代理内存条目。

列出、检查并清除由 agent 存储的记忆条目。支持按类别和会话筛选、分页,以及带确认的批量清除。

示例:zeroclaw memory stats zeroclaw memory list zeroclaw memory list –category core –limit 10 zeroclaw memory get KEY zeroclaw memory clear –category conversation –yes

用法: zeroclaw memory <COMMAND>

子命令:

  • list — 列出内存条目,可选过滤条件
  • get — 按键获取特定的内存条目
  • stats — 显示内存后端统计信息和健康状态
  • clear — 按类别、按键清除记忆,或清除全部
  • reindex

zeroclaw memory list

列出带可选筛选条件的记忆条目

用法: zeroclaw memory list [OPTIONS]

选项:

  • --category <CATEGORY>

  • --session <SESSION>

  • --limit <LIMIT>

    默认值:50

  • --offset <OFFSET>

    默认值:0

zeroclaw memory get

按键获取特定的内存条目

用法: zeroclaw memory get <KEY>

参数:

  • <KEY>

zeroclaw memory stats

显示内存后端统计信息和健康状态

用法: zeroclaw memory stats

zeroclaw memory clear

按类别清除记忆、按键清除记忆,或清除全部记忆

用法: zeroclaw memory clear [OPTIONS]

选项:

  • --key <KEY> — 按键删除单个条目(支持前缀匹配)
  • --category <CATEGORY>
  • --yes — 跳过确认提示

zeroclaw memory reindex

用法: zeroclaw memory reindex

zeroclaw config

管理 ZeroClaw 配置。

通过点路径查看、设置或初始化配置属性。使用 ‘schema’ 来转储配置文件的完整 JSON Schema。

属性通过点路径寻址(例如 channels.matrix.mention-only)。密钥字段(API 密钥、令牌)会自动使用掩码输入。当省略值时,枚举字段提供交互式选择。

示例:zeroclaw config list # 列出所有属性 zeroclaw config list –secrets # 仅列出机密 zeroclaw config list –filter channels.matrix # 按前缀筛选 zeroclaw config get channels.matrix.mention-only # 获取一个值 zeroclaw config set channels.matrix.mention-only true # 设置一个值 zeroclaw config set channels.matrix.access-token # 机密:掩码输入 zeroclaw config set channels.matrix.stream-mode # 枚举:交互式选择 zeroclaw config init channels.matrix # 使用默认值初始化部分 zeroclaw config init risk_profiles.strict # 创建新的动态映射别名 zeroclaw config schema # 将 JSON Schema 输出到 stdout zeroclaw config schema > schema.json

zeroclaw completions <shell> 会自动包含属性路径补全。

用法: zeroclaw config <COMMAND>

子命令:

  • schema — 将完整的配置 JSON Schema 输出到 stdout。使用 --path 时,仅返回该属性对应的 schema 片段——与通过 HTTP 返回的 OPTIONS /api/config/prop?path=... 负载相同
  • list — 列出所有配置属性及其当前值
  • get — 获取配置属性值
  • set — 设置配置属性(secret 字段会自动提示进行掩码输入)
  • init — 使用默认值初始化未配置的部分(enabled=false)
  • migrate — 将磁盘上的配置迁移到当前 schema 版本(保留注释)
  • patch — 原子地应用 JSON Patch(RFC 6902)文档。对应 PATCH /api/config。从给定文件读取操作;当路径为 - 或省略时,则从 stdin 读取。支持的操作:addreplaceremovetestmovecopy 会被拒绝
  • docs — 打印 API explorer URL(如果 daemon 未运行,还会附带提示)
  • generate

zeroclaw config schema

将完整的配置 JSON Schema 转储到 stdout。使用 --path 时,仅返回该属性的 schema 片段——与通过 HTTP 的 OPTIONS /api/config/prop?path=... 返回的同一载荷。

用法: zeroclaw config schema [OPTIONS]

选项:

  • --path <PATH> — 属性路径,用于限定 schema dump 的范围(例如 agents.researcher.model_provider)。如果不指定,则会导出整个配置的 schema

zeroclaw config list

列出所有配置属性及其当前值

用法: zeroclaw config list [OPTIONS]

选项:

  • -f, --filter <FILTER> — 按路径前缀过滤(例如 “channels.telegram”)
  • --secrets — 仅显示 secret(加密)字段

zeroclaw config get

获取配置属性值

用法: zeroclaw config get [OPTIONS] <PATH>

参数:

  • <PATH> — 属性路径(例如 channels.telegram.mention-only)

选项:

  • --json — 输出结构化 JSON 包装({path, value} 或 {path, populated}),而不是纯文本

zeroclaw config set

设置一个配置属性(secret 字段会自动提示进行掩码输入)

用法: zeroclaw config set [OPTIONS] <PATH> [VALUE]

参数:

  • <PATH> — 属性路径
  • <VALUE> — 新值(对于 secret 字段可省略以获取掩码输入)

选项:

  • --no-interactive — 跳过交互式提示 — 要求在命令行中提供值,接受枚举的原始字符串
  • --comment <COMMENT> — 可选注释,写入 TOML 中该值旁边(在后续编辑中会保留)
  • --json — 成功时输出结构化 JSON 包装器

zeroclaw config init

使用默认值初始化未配置的部分(enabled=false)

用法: zeroclaw config init [OPTIONS] [SECTION]

参数:

  • <SECTION> — 章节前缀(例如 channels.matrix),或使用 <section>.<alias> 创建新的动态映射别名(例如 risk_profiles.strict)。省略则初始化全部

选项:

  • --json — 输出结构化的 JSON 封装({initialized: […]}),而不是纯文本

zeroclaw config migrate

将磁盘上的配置迁移到当前模式版本(保留注释)

用法: zeroclaw config migrate [OPTIONS]

选项:

  • --json — 输出结构化 JSON 包装({migrated, backup_path?, schema_version, valid?, error?}),而不是纯文本

zeroclaw config patch

以原子方式应用 JSON Patch(RFC 6902)文档。对应于 PATCH /api/config。从给定文件中读取操作;当路径为 - 或省略时,则从标准输入读取。支持的操作:addreplaceremovetest。不接受 movecopy

用法: zeroclaw config patch [OPTIONS] [INPUT]

参数:

  • <INPUT> — JSON Patch 文档的路径,或使用 - 表示 stdin(默认)

选项:

  • --json — 以 JSON 形式输出结果(每个已应用的 op 对应一个对象),而不是以人类可读文本输出

zeroclaw config docs

打印 API explorer URL(如果 daemon 未运行,再附上一个提示)

用法: zeroclaw config docs

zeroclaw config generate

用法: zeroclaw config generate [OPTIONS] [VERSION]

参数:

  • <VERSION> — 目标 schema 版本(例如 1、2、3)。默认为当前版本

选项:

  • --encrypt — 在输出中加密包含密钥的字符串值(api_key、bot_token、access_token、password、refresh_token 等)。通过基于键名的遍历器适用于所有 schema 版本。使用已解析的 config-dir 的 .secret_key(如缺失则创建一个)

zeroclaw update

检查并应用 ZeroClaw 更新。

默认情况下,下载并安装最新版本,采用 6 阶段流水线:preflight、download、backup、validate、swap 和 smoke test。失败时自动回滚。

使用 –check 仅检查更新而不安装。使用 –force 跳过确认提示。使用 –version 以指定特定版本而不是最新版本。

示例:zeroclaw update # 下载并安装最新的 zeroclaw update –check # 仅检查,不安装 zeroclaw update –force # 安装时不确认 zeroclaw update –version 0.6.0 # 安装指定版本

用法: zeroclaw update [OPTIONS]

选项:

  • --check — 仅检查更新,不安装
  • --force — 即使目标不是更新的也安装(重新安装或降级/固定到 –version)
  • --version <VERSION> — 目标版本(默认:latest)
  • --json — 与 –check 配合使用时,输出机器可读的 JSON,而非面向人类的文本

zeroclaw self-test

运行诊断自检以验证 ZeroClaw 安装。

默认情况下,运行完整的测试套件,包括网络检查(网关健康检查、内存往返)。使用 –quick 可跳过网络检查,以便更快地进行离线验证。

示例:zeroclaw self-test # 完整套件 zeroclaw self-test –quick # 仅快速检查(无网络)

用法: zeroclaw self-test [OPTIONS]

选项:

  • --quick — 仅运行快速检查(无网络)

zeroclaw completions

zeroclaw 生成 shell 补全脚本。

脚本会打印到 stdout,因此可以直接被 sourced:

示例(Unix shell):source <(zeroclaw completions bash) zeroclaw completions zsh > ~/.zfunc/_zeroclaw zeroclaw completions fish > ~/.config/fish/completions/zeroclaw.fish

示例(Windows PowerShell):zeroclaw completions powershell | Out-String | Invoke-Expression zeroclaw completions powershell > $PROFILE.CurrentUserAllHosts

用法: zeroclaw completions <SHELL>

参数:

  • <SHELL> — 目标 shell

    可选值:bashfishzshpowershellelvish

zeroclaw desktop

启动 ZeroClaw companion 桌面应用。

配套应用是一个轻量级的菜单栏 / 系统托盘应用程序,它连接到与 CLI 相同的网关。它提供对仪表板、状态监控和设备配对的快速访问。

使用 –install 打开适用于您平台的下载页面。它本身不会安装任何内容。

示例:zeroclaw desktop # 启动配套应用 zeroclaw desktop –install # 打开下载页面

用法: zeroclaw desktop [OPTIONS]

选项:

  • --install — 打开配套应用的下载页面

zeroclaw locales

从上游仓库获取指定区域设置的已翻译 Fluent(.ftl)目录,并将其安装到 <config-dir>/data/ftl/<locale>/ 下,运行时和 zerocode 加载器会从那里读取它们。

传入单个 locale。默认会获取所有目录;可使用 –catalog(逗号分隔)加以限制:cli、tools、zerocode。

示例:zeroclaw locales fetch ja zeroclaw locales fetch fr –catalog cli,tools zeroclaw locales fetch zh-CN –catalog zerocode

用法: zeroclaw locales <COMMAND>

子命令:

  • fetch — 从上游下载某个区域设置的已翻译 FTL 文件

zeroclaw locales fetch

从上游下载该区域设置的已翻译 FTL 文件

用法: zeroclaw locales fetch [OPTIONS] <LOCALE>

参数:

  • <LOCALE> — 要获取的区域设置代码(例如 jafrzh-CN

选项:

  • --catalog <CATALOG> — 要获取的目录,以逗号分隔:cli、tools、zerocode。省略则获取全部

此文档由 clap-markdown 自动生成。