Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

zeroclaw 的命令行帮助

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

命令概述：

zeroclaw

最快、最小的 AI 助手。

用法： zeroclaw [OPTIONS] <COMMAND>

子命令：

  • onboard — 初始化您的工作区和配置
  • agent — 启动 AI 代理循环
  • gateway — 启动/管理网关服务器（webhooks、websockets）
  • acp — 通过 stdio 启动 ACP（Agent Control Protocol）服务器
  • daemon — 启动长期运行的自主运行时（网关 + 通道 + 心跳 + 调度器）
  • service — 管理操作系统服务生命周期（launchd/systemd 用户服务）
  • doctor — 运行守护进程/调度器/通道新鲜度的诊断
  • status — 显示系统状态（详细信息）
  • estop — 启用、检查并恢复紧急停止状态
  • cron — 配置和管理定时任务
  • models — Manage model_provider model catalogs
  • providers — List supported AI model_providers
  • channel — 管理频道（Telegram、Discord、Slack）
  • integrations — 浏览 50 多种集成
  • skills — 管理技能（用户定义的能力）
  • browse — Browse the shared workspace one directory at a time
  • sop — 管理标准操作程序（SOP）
  • migrate — 从其他代理运行时迁移数据
  • auth — Manage model_provider subscription authentication profiles
  • hardware — 发现并检查 USB 硬件
  • peripheral — 管理硬件外设（STM32、RPi GPIO 等）
  • memory — 管理代理记忆（列出、获取、统计、清除）
  • config — 管理配置
  • update — 检查并应用更新
  • self-test — 运行诊断自检
  • completions — 生成 shell 补全脚本并输出到标准输出
  • desktop — 启动或安装配套桌面应用

选项：

  • --config-dir <CONFIG_DIR>

zeroclaw onboard

初始化您的工作区和配置

Usage: zeroclaw onboard [OPTIONS] [COMMAND]

子命令：

  • providers.models — Pick a model provider to configure (Anthropic, OpenAI, OpenRouter, Ollama, custom OpenAI-compatible gateways, etc.). Multiple aliases per provider are supported — e.g. anthropic.production and anthropic.dev can coexist
  • risk-profiles — Named risk profiles binding allowlists, denylists, and approval thresholds. Agents reference one via agents.<alias>.risk_profile
  • runtime-profiles — Named runtime tuning profiles (token limits, retry policy, timeouts). Agents reference one via agents.<alias>.runtime_profile
  • storage — SQLite is the safe default for single-node installs (file-based, zero-config, no extra services). Pick Postgres for shared or multi-instance deployments, Qdrant for vector search, Markdown or Lucid for human-readable files. Each backend supports multiple aliased instances; agents reference them via memory.storage_ref
  • memory — Persistent memory backend. SQLite is the default; pick none to disable long-term recall entirely
  • skills — Skills tool settings — where skill markdown lives on disk (defaults to the data dir), and how the skills loader handles community repositories. Add skill BUNDLES under skill-bundles below
  • skill-bundles — Named bundles of skill files. Agents reference a bundle to load a set of capabilities at startup
  • mcp — Model Context Protocol settings. Toggle enabled and pick deferred or eager loading. Individual MCP servers live under mcp.servers[]
  • mcp-bundles — Named bundles of MCP servers. Agents reference a bundle to pull in a set of MCP tools as one unit
  • knowledge-bundles — Named bundles of knowledge sources (RAG indexes, doc folders). Agents reference a bundle to surface relevant snippets at inference time
  • providers.tts — Text-to-speech providers (OpenAI, ElevenLabs, Google, Edge, Piper). Configure one per voice / language; agents reference them by alias
  • providers.transcription — Speech-to-text providers (OpenAI Whisper, Groq, Deepgram, AssemblyAI, Google, local Whisper). Configure one per pipeline; agents reference them by alias
  • channels — Pick which chat platforms ZeroClaw should listen on. You can configure multiple — each channel gets its own alias
  • hardware — Optional: hardware peripherals (Arduino, STM32, GPIO, etc.). Skip if you don’t need them
  • agents — An agent binds a model provider, profiles, bundles, and channels into one dispatchable unit. Add one per persona; reuse the same alias across channels to share state
  • peer-groups — Named groups binding a channel, member agents, and external peers. Mutual opt-in: two agents become peers only when both appear in the same group’s agents list
  • cron — Scheduled tasks. Each cron entry binds a schedule expression to a prompt, channel, and target
  • tunnel — Optional: expose your gateway over the public internet via Cloudflare or ngrok. Pick none to keep it localhost-only

选项：

  • --quick — Skip interactive prompts; read from –api-key/–model-provider/–model/–memory
  • --cli — Force the dialoguer CLI backend instead of the default ratatui TUI
  • --force — Don’t ask “keep stored secret?” — always re-prompt
  • --reinit — Back up existing config and start from defaults
  • --api-key <API_KEY> — API key for model_provider configuration
  • --model-provider <MODEL_PROVIDER> — ModelProvider name. Used as the type key for the synthesized [model_providers.<type>.default] entry
  • --model <MODEL> — Model ID override
  • --memory <MEMORY> — Memory backend (sqlite, lucid, markdown, none)

zeroclaw onboard providers.models

Pick a model provider to configure (Anthropic, OpenAI, OpenRouter, Ollama, custom OpenAI-compatible gateways, etc.). Multiple aliases per provider are supported — e.g. anthropic.production and anthropic.dev can coexist

Usage: zeroclaw onboard providers.models

zeroclaw onboard risk-profiles

Named risk profiles binding allowlists, denylists, and approval thresholds. Agents reference one via agents.<alias>.risk_profile

Usage: zeroclaw onboard risk-profiles

zeroclaw onboard runtime-profiles

Named runtime tuning profiles (token limits, retry policy, timeouts). Agents reference one via agents.<alias>.runtime_profile

Usage: zeroclaw onboard runtime-profiles

zeroclaw onboard storage

SQLite is the safe default for single-node installs (file-based, zero-config, no extra services). Pick Postgres for shared or multi-instance deployments, Qdrant for vector search, Markdown or Lucid for human-readable files. Each backend supports multiple aliased instances; agents reference them via memory.storage_ref

Usage: zeroclaw onboard storage

zeroclaw onboard memory

Persistent memory backend. SQLite is the default; pick none to disable long-term recall entirely

Usage: zeroclaw onboard memory

zeroclaw onboard skills

Skills tool settings — where skill markdown lives on disk (defaults to the data dir), and how the skills loader handles community repositories. Add skill BUNDLES under skill-bundles below

Usage: zeroclaw onboard skills

zeroclaw onboard skill-bundles

Named bundles of skill files. Agents reference a bundle to load a set of capabilities at startup

Usage: zeroclaw onboard skill-bundles

zeroclaw onboard mcp

Model Context Protocol settings. Toggle enabled and pick deferred or eager loading. Individual MCP servers live under mcp.servers[]

Usage: zeroclaw onboard mcp

zeroclaw onboard mcp-bundles

Named bundles of MCP servers. Agents reference a bundle to pull in a set of MCP tools as one unit

Usage: zeroclaw onboard mcp-bundles

zeroclaw onboard knowledge-bundles

Named bundles of knowledge sources (RAG indexes, doc folders). Agents reference a bundle to surface relevant snippets at inference time

Usage: zeroclaw onboard knowledge-bundles

zeroclaw onboard providers.tts

Text-to-speech providers (OpenAI, ElevenLabs, Google, Edge, Piper). Configure one per voice / language; agents reference them by alias

Usage: zeroclaw onboard providers.tts

zeroclaw onboard providers.transcription

Speech-to-text providers (OpenAI Whisper, Groq, Deepgram, AssemblyAI, Google, local Whisper). Configure one per pipeline; agents reference them by alias

Usage: zeroclaw onboard providers.transcription

zeroclaw onboard channels

Pick which chat platforms ZeroClaw should listen on. You can configure multiple — each channel gets its own alias

Usage: zeroclaw onboard channels

zeroclaw onboard hardware

Optional: hardware peripherals (Arduino, STM32, GPIO, etc.). Skip if you don’t need them

Usage: zeroclaw onboard hardware

zeroclaw onboard agents

An agent binds a model provider, profiles, bundles, and channels into one dispatchable unit. Add one per persona; reuse the same alias across channels to share state

Usage: zeroclaw onboard agents

zeroclaw onboard peer-groups

Named groups binding a channel, member agents, and external peers. Mutual opt-in: two agents become peers only when both appear in the same group’s agents list

Usage: zeroclaw onboard peer-groups

zeroclaw onboard cron

Scheduled tasks. Each cron entry binds a schedule expression to a prompt, channel, and target

Usage: zeroclaw onboard cron

zeroclaw onboard tunnel

Optional: expose your gateway over the public internet via Cloudflare or ngrok. Pick none to keep it localhost-only

Usage: zeroclaw onboard tunnel

zeroclaw agent

启动 AI 代理循环。

Launches an interactive chat session with the configured AI model_provider. Use –message for single-shot queries without entering interactive mode.

Examples: zeroclaw agent -a assistant # interactive session zeroclaw agent -a assistant -m “Summarize today’s logs” # single message zeroclaw agent -a assistant -p anthropic –model claude-sonnet-4-20250514 zeroclaw agent -a assistant –peripheral nucleo-f401re:/dev/ttyACM0

Usage: zeroclaw agent [OPTIONS] --agent <AGENT>

选项：

  • -a, --agent <AGENT> — Configured agent alias to run as (must match [agents.<alias>]). Required — there is no default agent
  • -m, --message <MESSAGE> — 单消息模式（不进入交互模式）
  • --session-state-file <SESSION_STATE_FILE> — 在此 JSON 文件中加载和保存交互式会话状态
  • -p, --model-provider <MODEL_PROVIDER> — Model provider to use (openrouter, anthropic, openai, openai-codex)
  • --model <MODEL> — 要使用的模型
  • -t, --temperature <TEMPERATURE> — Temperature (0.0 - 2.0, defaults to providers.models...temperature)
  • --peripheral <PERIPHERAL> — 附加外围设备（板子:路径，例如 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）。

运行 HTTP/WebSocket 网关，该网关接受传入的 webhook 事件和 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

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

zeroclaw gateway get-paircode

显示或生成网关配对码。

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

使用 --new 参数时，即使网关之前已配对，也会生成一个新的配对码（适用于添加额外客户端）。

Examples: zeroclaw gateway get-paircode # show current pairing code zeroclaw gateway get-paircode –new # generate a new pairing code zeroclaw gateway get-paircode –new –port 3001 # target alternate-port gateway

用法： zeroclaw gateway get-paircode [OPTIONS]

选项：

  • --new — 生成新的配对码（即使已配对）
  • -p, --port <PORT> — Port of the running gateway to query; defaults to config gateway.port
  • --host <HOST> — Host of the running gateway to query; defaults to config gateway.host

zeroclaw acp

启动 ACP 服务器（基于 stdio 的 JSON-RPC 2.0）。

在标准输入/标准输出上启动一个 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 守护进程

启动长期运行的自主守护进程。

启动完整的 ZeroClaw 运行时：包括网关服务器、所有已配置的频道（Telegram、Discord、Slack 等）、心跳监控器和定时任务调度器。这是在生产环境或作为常驻助手运行 ZeroClaw 的推荐方式。

使用 zeroclaw service install 将守护进程注册为操作系统服务（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> — 要绑定的主机；默认为配置中的 gateway.host

zeroclaw service

管理操作系统服务生命周期（launchd/systemd 用户服务）

用法： zeroclaw service [OPTIONS] <COMMAND>

子命令：

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

选项：

  • --service-init <SERVICE_INIT> — 要使用的初始化系统：auto（自动检测）、systemd 或 openrc

    默认值：auto

    可能的值：auto、systemd、openrc

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 服务状态

检查守护进程服务状态

用法： 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

运行守护进程/调度器/通道新鲜度的诊断

用法： zeroclaw doctor [COMMAND]

子命令：

  • models — Probe model catalogs across model_providers and report availability
  • traces — 查询运行时跟踪事件（工具诊断和模型回复）

zeroclaw doctor models

Probe model catalogs across model_providers and report availability

用法： zeroclaw doctor models [OPTIONS]

选项：

  • --model-provider <MODEL_PROVIDER> — Probe a specific model_provider only (default: all known model_providers)
  • --use-cache — 优先使用缓存的目录（跳过强制实时刷新）

zeroclaw doctor traces

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

用法： zeroclaw doctor traces [OPTIONS]

选项：

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

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

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

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

    默认值：20

zeroclaw status

显示系统状态（详细信息）

用法： zeroclaw status [OPTIONS]

选项：

  • --format <FORMAT> — 输出格式：“exit-code” 在健康时退出码为 0，否则为 1（用于 Docker HEALTHCHECK）

zeroclaw estop

激活、检查并恢复紧急停止状态。

示例：- zeroclaw estop - zeroclaw estop --level network-kill - zeroclaw estop --level domain-block --domain "*.chase.com" - zeroclaw estop --level tool-freeze --tool shell --tool browser - zeroclaw estop status - zeroclaw estop resume --network - zeroclaw estop resume --domain "*.chase.com" - zeroclaw estop resume --tool shell

用法： zeroclaw estop [OPTIONS] [COMMAND]

子命令：

  • status — 打印当前急停状态
  • resume — 从已激活的急停级别恢复

选项：

  • --level <LEVEL> — 从 zeroclaw estop 触发急停时使用的级别

    可能的值：kill-all、network-kill、domain-block、tool-freeze

  • --domain <DOMAINS> — domain-block 的域名模式（可重复）

  • --tool <TOOLS> — tool-freeze 使用的工具名称（可重复指定）

zeroclaw 急停状态

打印当前急停状态

用法： zeroclaw estop status

zeroclaw 停止 恢复

从已激活的急停电平恢复

用法： zeroclaw estop resume [OPTIONS]

选项：

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

zeroclaw cron

配置和管理定时任务。

Schedule recurring, one-shot, or interval-based tasks using cron expressions, RFC3339 timestamps with explicit Z or offsets, durations, or fixed intervals.

Cron expressions use the standard 5-field format: ‘min hour day month weekday’. When –tz is omitted, cron schedules use the runtime local timezone. For user-facing schedules, pass –tz with an explicit IANA timezone.

示例：zeroclaw cron list zeroclaw cron add ‘0 9 * * 1-5’ ‘早上好’ –tz America/New_York –agent zeroclaw cron add ‘*/30 * * * ’ ‘检查系统健康状态’ –agent zeroclaw cron add ‘/5 * * * *’ ‘echo ok’ zeroclaw cron add-at 2025-01-15T14:00:00Z ‘发送提醒’ –agent zeroclaw cron add-every 60000 ‘Ping 心跳’ zeroclaw cron once 30m ‘30 分钟后运行备份’ –agent zeroclaw cron pause TASK_ID zeroclaw cron update TASK_ID –expression ‘0 8 * * *’ –tz Europe/London

用法： zeroclaw cron <COMMAND>

子命令：

  • list — 列出所有计划任务
  • add — 添加新的计划任务
  • add-at — Add a one-shot scheduled task at an RFC3339 timestamp with explicit Z or offset
  • add-every — 添加一个固定间隔的定时任务
  • once — 添加一个一次性延迟任务（例如 “30m”、“2h”、“1d”）
  • remove — 移除已调度的任务
  • update — 更新计划任务
  • pause — 暂停计划任务
  • resume — 恢复暂停的任务

zeroclaw cron list

列出所有计划任务

用法： zeroclaw cron list

zeroclaw cron add

添加一个新的周期性计划任务。

Uses standard 5-field cron syntax: ‘min hour day month weekday’. When –tz is omitted, cron schedules use the runtime local timezone. For user-facing schedules, pass –tz with an explicit IANA timezone.

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

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

参数：

  • <EXPRESSION> — Cron 表达式
  • <COMMAND> — Command (shell) or prompt (when –prompt) to run

选项：

  • -a, --agent <AGENT_ALIAS> — Configured agent alias the cron job runs as. Required — there is no default agent
  • --tz <TZ> — 可选的 IANA 时区（例如 America/Los_Angeles）
  • --prompt — Treat the argument as an agent prompt instead of a shell command
  • --allowed-tool <ALLOWED_TOOLS> — Restrict agent cron jobs to the specified tool names (repeatable, prompt-only)

zeroclaw cron add-at

Add a one-shot task that fires at a specific RFC3339 timestamp with explicit Z or offset.

The timestamp must include an explicit Z or numeric offset (e.g. 2025-01-15T14:00:00Z or 2025-01-15T09:00:00-05:00).

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

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

参数：

  • <AT> — One-shot RFC3339 timestamp with explicit Z or offset
  • <COMMAND> — Command (shell) or prompt (when –prompt) to run

选项：

  • -a, --agent <AGENT_ALIAS> — Configured agent alias the cron job runs as
  • --prompt — Treat the argument as an agent prompt instead of a shell command
  • --allowed-tool <ALLOWED_TOOLS> — Restrict agent cron jobs to the specified tool names (repeatable, prompt-only)

zeroclaw cron add-every

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

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

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

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

参数：

  • <EVERY_MS> — 以毫秒为单位的间隔
  • <COMMAND> — Command (shell) or prompt (when –prompt) to run

选项：

  • -a, --agent <AGENT_ALIAS> — Configured agent alias the cron job runs as
  • --prompt — Treat the argument as an agent prompt instead of a shell command
  • --allowed-tool <ALLOWED_TOOLS> — Restrict agent cron jobs to the specified tool names (repeatable, prompt-only)

zeroclaw cron once

添加一个从现在起延迟后触发的一次性任务。

接受人类可读的时间间隔：s（秒）、m（分钟）、h（小时）、d（天）。

Examples: zeroclaw cron once –agent ops-bot 30m ‘Run backup in 30 minutes’ zeroclaw cron once –agent researcher –prompt 2h ‘Follow up on deployment’

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

参数：

  • <DELAY> — 延迟持续时间
  • <COMMAND> — Command (shell) or prompt (when –prompt) to run

选项：

  • -a, --agent <AGENT_ALIAS> — Configured agent alias the cron job runs as
  • --prompt — Treat the argument as an agent prompt instead of a shell command
  • --allowed-tool <ALLOWED_TOOLS> — Restrict agent cron jobs to the specified tool names (repeatable, prompt-only)

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’

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

参数：

  • <ID> — 任务 ID

选项：

  • -a, --agent <AGENT_ALIAS> — Configured agent alias whose risk profile gates the new shell command (when –command is provided). Required
  • --expression <EXPRESSION> — 新的 cron 表达式
  • --tz <TZ> — 新的 IANA 时区
  • --command <COMMAND> — 要运行的新命令
  • --name <NAME> — 新作业名称
  • --allowed-tool <ALLOWED_TOOLS> — 使用指定的工具名称替换代理作业的允许工具列表（可重复）

zeroclaw cron pause

暂停计划任务

用法： zeroclaw cron pause <ID>

参数：

  • <ID> — 任务 ID

zeroclaw cron resume

恢复暂停的任务

用法： zeroclaw cron resume <ID>

参数：

  • <ID> — 任务 ID

zeroclaw 模型

Manage model_provider model catalogs

用法： zeroclaw models <COMMAND>

子命令：

  • refresh — Refresh and cache model_provider models
  • list — List cached models for a model_provider
  • set — 在配置中设置默认模型
  • status — 显示当前模型配置和缓存状态

zeroclaw models refresh

Refresh and cache model_provider models

用法： zeroclaw models refresh [OPTIONS]

选项：

  • --model-provider <MODEL_PROVIDER> — ModelProvider name (defaults to configured default model_provider)
  • --all — Refresh all model_providers that support live model discovery
  • --force — 强制实时刷新并忽略缓存

zeroclaw models list

List cached models for a model_provider

用法： zeroclaw models list [OPTIONS]

选项：

  • --model-provider <MODEL_PROVIDER> — ModelProvider name (defaults to configured default model_provider)

zeroclaw models set

在配置中设置默认模型

用法： zeroclaw models set <MODEL>

参数：

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

zeroclaw 模型状态

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

用法： zeroclaw models status

zeroclaw providers

List supported AI model_providers

用法： zeroclaw providers

zeroclaw channel

管理通信通道。

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

示例：zeroclaw 频道列表 zeroclaw 频道医生 zeroclaw 频道添加 telegram ‘{“bot_token”:“…”,“name”:“my-bot”}’ zeroclaw 频道移除 my-bot zeroclaw 频道绑定-telegram zeroclaw_user zeroclaw 频道发送 ‘Alert!’ –channel-id telegram –recipient 123456789

用法： zeroclaw channel <COMMAND>

子命令：

  • list — 列出所有已配置的通道
  • start — 启动所有配置的通道（在 main.rs 中处理异步）
  • doctor — 运行已配置通道的健康检查（在 main.rs 中处理异步逻辑）
  • add — 添加新的频道配置
  • remove — 移除频道配置
  • bind-telegram — 将 Telegram 身份（用户名或数字用户 ID）绑定到白名单中
  • send — 向配置的频道发送消息

zeroclaw 频道列表

列出所有已配置的频道

用法： zeroclaw channel list

zeroclaw channel start

启动所有已配置的通道（在 main.rs 中处理异步）

用法： zeroclaw channel start

zeroclaw channel doctor

为配置的通道运行健康检查（在 main.rs 中处理异步部分）

用法： zeroclaw channel doctor

zeroclaw channel add

添加新的通道配置。

提供通道类型以及该通道类型所需的配置键的 JSON 对象。

支持的类型：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 频道绑定-telegram

将 Telegram 身份绑定到白名单中。

将 Telegram 用户名（不带 ‘@’ 前缀）或数字用户 ID 添加到频道白名单中，以便代理能够响应来自该身份的消息。

示例：zeroclaw 频道绑定-telegram zeroclaw_user zeroclaw 频道绑定-telegram 123456789

用法： zeroclaw channel bind-telegram <IDENTITY>

参数：

  • <IDENTITY> — 允许使用的 Telegram 身份标识（不含 ‘@’ 的用户名或数字用户 ID）

zeroclaw channel send

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

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

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

示例：zeroclaw channel send ‘有人靠近你的设备。’ –channel-id telegram –recipient 123456789 zeroclaw channel send ‘构建成功！’ –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 集成

浏览 50 多种集成

用法： zeroclaw integrations <COMMAND>

子命令：

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

zeroclaw 集成信息

显示特定集成的详细信息

用法： zeroclaw integrations info <NAME>

参数：

  • <NAME> — 集成名称

zeroclaw skills

管理技能（用户定义的能力）

用法： zeroclaw skills <COMMAND>

子命令：

  • list — 列出所有已安装的技能
  • add — Scaffold a new skill from scratch (canonical SKILL.md + optional subdirs)
  • edit — Open a skill’s SKILL.md (or a sibling file) in $EDITOR
  • bundle — Manage skill bundles (the named directories skills live in)
  • audit — 审计技能源目录或已安装的技能名称
  • install — 从 URL 或本地路径安装新技能
  • remove — 移除已安装的技能
  • test — 运行 TEST.sh 验证某个技能（或所有技能）

zeroclaw skills list

列出所有已安装的技能

用法： zeroclaw skills list

zeroclaw skills add

Scaffold a new skill under a skill bundle. Writes <bundle.directory>//SKILL.md plus the canonical optional subdirs (scripts/, references/, assets/). Name must be lowercase + hyphens; description is required (prompted on TTY if omitted).

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

Usage: zeroclaw skills add [OPTIONS] <NAME>

参数：

  • <NAME> — Skill name (lowercase + hyphens only)

选项：

  • --bundle <BUNDLE> — Target bundle alias. Optional when exactly one bundle is configured
  • --description <DESCRIPTION> — What the skill does and when to use it (frontmatter description). Required; prompted on TTY when missing
  • --license <LICENSE> — SPDX license identifier (e.g. MIT)
  • --author <AUTHOR> — Skill author handle
  • --version <VERSION> — SemVer version (defaults to 0.1.0)
  • --category <CATEGORY> — Skill category for registry grouping
  • --no-scaffold — Skip scaffolding scripts/, references/, assets/
  • --edit — Open SKILL.md in $EDITOR after scaffold

zeroclaw skills edit

Open a skill’s SKILL.md (or a sibling file) in $EDITOR

Usage: zeroclaw skills edit [OPTIONS] <NAME>

参数：

  • <NAME> — Skill name

选项：

  • --bundle <BUNDLE> — Target bundle alias. Optional when name is unique across bundles
  • --file <FILE> — Edit a sibling file instead of SKILL.md (e.g. scripts/runner.sh)

zeroclaw skills bundle

Manage skill bundles (the named directories skills live in)

Usage: zeroclaw skills bundle <COMMAND>

子命令：

  • list — List configured skill bundles and their resolved directories
  • add — Add a new skill bundle. Directory defaults to shared/skills//
  • remove — Remove a configured skill bundle
  • show — Show metadata + skill list for a bundle

zeroclaw skills bundle list

List configured skill bundles and their resolved directories

Usage: zeroclaw skills bundle list

zeroclaw skills bundle add

Add a new skill bundle. Directory defaults to shared/skills//

Usage: zeroclaw skills bundle add [OPTIONS] <ALIAS>

参数：

  • <ALIAS> — Bundle alias (lowercase + hyphens; same convention as agents/channels)

选项：

  • --directory <DIRECTORY> — Override directory (relative to install root or absolute). Must resolve inside <install>/shared/

zeroclaw skills bundle remove

Remove a configured skill bundle

Usage: zeroclaw skills bundle remove <ALIAS>

参数：

  • <ALIAS> — Bundle alias

zeroclaw skills bundle show

Show metadata + skill list for a bundle

Usage: zeroclaw skills bundle show <ALIAS>

参数：

  • <ALIAS> — Bundle alias

zeroclaw 技能审计

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

用法： zeroclaw skills audit <SOURCE>

参数：

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

zeroclaw skills install

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

Usage: zeroclaw skills install [OPTIONS] <SOURCE>

参数：

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

选项：

  • --no-tier-banner — Suppress only the install-time tier banner; other install progress output (resolving, installed, audited) is unaffected

zeroclaw skills remove

移除已安装的技能

用法： zeroclaw skills remove <NAME>

参数：

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

zeroclaw 技能测试

运行 TEST.sh 验证某个技能（或所有技能）

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

参数：

  • <NAME> — 要测试的技能名称；省略表示所有技能

选项：

  • --verbose — 显示详细输出

zeroclaw browse

List children of a directory under /shared/. Paths are relative to the shared workspace root; .. traversal that escapes the root is rejected. Used by the dashboard’s skill-bundle directory picker and by operators who want to inspect what’s installed.

Examples: zeroclaw browse # list shared/ root zeroclaw browse skills # list shared/skills/ zeroclaw browse skills/coding # list shared/skills/coding/

Usage: zeroclaw browse [PATH]

参数：

  • <PATH> — Path relative to <install>/shared/. Empty = root

    Default value: ``

zeroclaw sop

管理标准操作程序（SOP）

用法： zeroclaw sop <COMMAND>

子命令：

  • list — 列出已加载的 SOP
  • validate — 验证 SOP 定义
  • show — 显示 SOP 的详细信息

zeroclaw sop list

列出已加载的 SOP

用法： zeroclaw sop list

zeroclaw sop validate

验证SOP定义

用法： zeroclaw sop validate [NAME]

参数：

  • <NAME> — 要验证的 SOP 名称（如果省略，则验证所有 SOP）

zeroclaw sop show

显示 SOP 的详细信息

用法： zeroclaw sop show <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 — 验证并预览迁移，但不写入任何数据

zeroclaw auth

Manage model_provider subscription authentication profiles

用法： zeroclaw auth <COMMAND>

子命令：

  • login — 使用 OAuth 登录（OpenAI Codex 或 Gemini）
  • paste-redirect — 通过粘贴重定向 URL 或授权码完成 OAuth
  • paste-token — 粘贴设置令牌 / 身份验证令牌（用于 Anthropic 订阅身份验证）
  • setup-token — paste-token 的别名（默认以交互模式运行）
  • refresh — 使用刷新令牌刷新 OpenAI Codex 访问令牌
  • logout — 移除认证配置文件
  • use — Set active profile for a model_provider
  • list — 列出认证配置文件
  • status — 显示认证状态，包括当前配置的用户配置文件和令牌过期信息

zeroclaw auth login

使用 OAuth 登录（OpenAI Codex 或 Gemini）

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

选项：

  • --model-provider <MODEL_PROVIDER> — ModelProvider (openai-codex or gemini)

  • --profile <PROFILE> — 配置文件名称（默认值：default）

    默认值：default

  • --device-code — 使用 OAuth 设备码流程

  • --import <PATH> — 导入现有的 auth.json 文件，而不是启动新的登录流程。目前仅支持 openai-codex；Codex 默认使用 ~/.codex/auth.json

zeroclaw auth paste-redirect

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

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

选项：

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

  • --profile <PROFILE> — 配置文件名称（默认值：default）

    默认值：default

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

zeroclaw auth paste-token

粘贴设置令牌 / 认证令牌（用于 Anthropic 订阅认证）

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

选项：

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

  • --profile <PROFILE> — 配置文件名称（默认值：default）

    默认值：default

  • --token <TOKEN> — Token 值（如果省略，则交互式读取）

  • --auth-kind <AUTH_KIND> — 身份验证类型覆盖（authorization 或 api-key）

zeroclaw auth setup-token

paste-token 的别名（默认以交互模式运行）

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

选项：

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

  • --profile <PROFILE> — 配置文件名称（默认值：default）

    默认值：default

zeroclaw auth refresh

使用刷新令牌刷新 OpenAI Codex 访问令牌

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

选项：

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

zeroclaw auth logout

移除身份验证配置文件

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

选项：

  • --model-provider <MODEL_PROVIDER> — ModelProvider

  • --profile <PROFILE> — 配置文件名称（默认值：default）

    默认值：default

zeroclaw auth use

Set active profile for a model_provider

Usage: 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 硬件

发现并检查 USB 硬件。

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

示例：zeroclaw 硬件发现 zeroclaw 硬件内省 /dev/ttyACM0 zeroclaw 硬件信息 –chip STM32F401RETx

用法： zeroclaw hardware <COMMAND>

子命令：

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

zeroclaw 硬件发现

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

通过 VID/PID 扫描已连接的 USB 设备，并将其与已知的开发板（STM32 Nucleo、Arduino、ESP32）进行匹配。

示例：zeroclaw 硬件发现

用法： zeroclaw hardware discover

zeroclaw 硬件自省

通过设备的序列号或设备路径进行自省。

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

示例：zeroclaw 硬件检查 /dev/ttyACM0 zeroclaw 硬件检查 COM3

用法： zeroclaw hardware introspect <PATH>

参数：

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

zeroclaw 硬件信息

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

通过调试探针直接查询目标 MCU，无需在目标板上运行任何固件。

示例：zeroclaw 硬件信息 zeroclaw 硬件信息 –chip STM32F401RETx

用法： zeroclaw hardware info [OPTIONS]

选项：

  • --chip <CHIP> — 芯片名称（例如 STM32F401RETx）。默认值：对于 Nucleo-F401RE 为 STM32F401RETx

    默认值：STM32F401RETx

zeroclaw 外围设备

管理硬件外设。

添加、列出、刷新和配置向智能体暴露工具（GPIO、传感器、执行器）的硬件板。支持的板子包括：nucleo-f401re、rpi-gpio、esp32、arduino-uno。

示例：zeroclaw 外设列表 zeroclaw 外设添加 nucleo-f401re /dev/ttyACM0 zeroclaw 外设添加 rpi-gpio 原生 zeroclaw 外设烧录 –端口 /dev/cu.usbmodem12345 zeroclaw 外设烧录-nucleo

用法： zeroclaw peripheral <COMMAND>

子命令：

  • list — 列出已配置的外设
  • add — 添加外设（板子路径，例如 nucleo-f401re /dev/ttyACM0）
  • flash — 将 Flash ZeroClaw 固件刷写到 Arduino（生成 .ino 文件，按需安装 arduino-cli，并执行上传）
  • setup-uno-q — 设置 Arduino Uno Q 桥接应用（部署用于代理控制的 GPIO 桥接）
  • flash-nucleo — 将 ZeroClaw 固件烧录到 Nucleo-F401RE（构建 + probe-rs 运行）

zeroclaw 外围设备列表

列出已配置的外设

用法： zeroclaw peripheral list

zeroclaw peripheral add

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

注册硬件板，以便代理可以使用其工具（GPIO、传感器、执行器）。在树莓派等单板计算机上，使用“native”作为本地 GPIO 的路径。

支持的板子：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 外围闪存

将 Flash ZeroClaw 固件刷写到 Arduino 开发板上。

生成 .ino 草图，如果尚未安装则安装 arduino-cli，编译并上传固件。

示例：zeroclaw 外围设备闪存 zeroclaw 外围设备闪存 –port /dev/cu.usbmodem12345 zeroclaw 外围设备闪存 -p COM3

用法： zeroclaw peripheral flash [OPTIONS]

选项：

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

zeroclaw 外围设备 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 外围设备 flash-nucleo

将 ZeroClaw 固件刷写到 Nucleo-F401RE（构建 + probe-rs 运行）

用法： zeroclaw peripheral flash-nucleo

zeroclaw memory

管理代理内存条目。

列出、检查并清除代理存储的内存条目。支持按类别和会话进行过滤、分页以及带确认的批量清除。

示例：zeroclaw 内存统计 zeroclaw 内存列表 zeroclaw 内存列表 –category core –limit 10 zeroclaw 内存获取 KEY zeroclaw 内存清除 –category conversation –yes

用法： zeroclaw memory <COMMAND>

子命令：

  • list — 列出内存条目，支持可选的过滤条件
  • get — 根据键获取特定的内存条目
  • stats — 显示内存后端统计信息和健康状况
  • clear — 按类别、按键清除记忆，或清除所有记忆
  • reindex — Rebuild backend indexes: FTS tables + any missing embedding vectors

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 内存统计

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

用法： zeroclaw memory stats

zeroclaw memory clear

按类别、按键清除记忆，或清除所有记忆

用法： zeroclaw memory clear [OPTIONS]

选项：

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

zeroclaw memory reindex

Rebuild backend indexes: FTS tables + any missing embedding vectors.

Run after zeroclaw migrate openclaw or other bulk writes that land rows with embedding = NULL. Safe to re-run; only touches entries whose vector is missing. No-op for backends without a vector index.

Usage: 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 schema # 将 JSON Schema 打印到标准输出 zeroclaw config schema > schema.json

属性路径的 Tab 补全功能已自动包含在 zeroclaw completions <shell> 中。

用法： zeroclaw config <COMMAND>

子命令：

  • schema — Dump the full configuration JSON Schema to stdout. With --path, returns the schema fragment for that property only — same payload OPTIONS /api/config/prop?path=... returns over HTTP
  • list — 列出所有配置属性及其当前值
  • get — 获取配置属性值
  • set — 设置配置属性（敏感字段会自动提示以掩码方式输入）
  • init — 使用默认值（enabled=false）初始化未配置的部分
  • migrate — 将 config.toml 迁移到磁盘上的当前 schema 版本（保留注释）
  • patch — Apply a JSON Patch (RFC 6902) document atomically. Mirrors PATCH /api/config
  • docs — Print the API explorer URL (plus a hint if the daemon isn’t running)
  • generate — Generate a canonical config at any supported schema version to stdout

zeroclaw config schema

Dump the full configuration JSON Schema to stdout. With --path, returns the schema fragment for that property only — same payload OPTIONS /api/config/prop?path=... returns over HTTP

Usage: zeroclaw config schema [OPTIONS]

选项：

  • --path <PATH> — Property path to scope the schema dump (e.g. agents.researcher.model_provider). Without it, dumps the whole-config schema

zeroclaw config list

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

用法： zeroclaw config list [OPTIONS]

选项：

  • -f, --filter <FILTER> — 按路径前缀进行过滤（例如 “channels.telegram”）
  • --secrets — 仅显示机密（加密）字段

zeroclaw config get

获取配置属性值

Usage: zeroclaw config get [OPTIONS] <PATH>

参数：

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

选项：

  • --json — Emit a structured JSON envelope ({path, value} or {path, populated}) instead of plain text

zeroclaw config set

设置配置属性（秘密字段自动提示以进行掩码输入）

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

参数：

  • <PATH> — 属性路径
  • <VALUE> — 新值（对于密钥字段，省略此参数以获取掩码输入）

选项：

  • --no-interactive — 跳过交互式提示 — 要求在命令行上提供值，接受枚举的原始字符串
  • --comment <COMMENT> — Optional comment to write alongside the value in TOML (preserves through future edits)
  • --json — Emit a structured JSON envelope on success

zeroclaw config init

使用默认值（enabled=false）初始化未配置的节

Usage: zeroclaw config init [OPTIONS] [SECTION]

参数：

  • <SECTION> — 节前缀（例如 channels.matrix）。省略则初始化所有

选项：

  • --json — Emit a structured JSON envelope ({initialized: […]}) instead of plain text

zeroclaw config migrate

将 config.toml 迁移到磁盘上的当前架构版本（保留注释）

Usage: zeroclaw config migrate [OPTIONS]

选项：

  • --json — Emit a structured JSON envelope ({migrated, backup_path?, schema_version}) instead of plain text

zeroclaw config patch

Apply a JSON Patch (RFC 6902) document atomically. Mirrors PATCH /api/config.

Reads operations from the given file, or from stdin when path is - or omitted. Supported ops: add, replace, remove, test. move and copy are rejected.

Usage: zeroclaw config patch [OPTIONS] [INPUT]

参数：

  • <INPUT> — Path to a JSON Patch document, or - for stdin (default)

选项：

  • --json — Print results as JSON (one object per applied op) instead of human-readable text

zeroclaw config docs

Print the API explorer URL (plus a hint if the daemon isn’t running)

Usage: zeroclaw config docs

zeroclaw config generate

Generate a canonical config at any supported schema version to stdout.

Runs the embedded V1 fixture through the typed migration chain and emits the result at the requested version. Useful for repros, doc snippets, and seeding test installs. Valid versions are 1..=CURRENT_SCHEMA_VERSION — invalid inputs error out.

Usage: zeroclaw config generate [OPTIONS] [VERSION]

参数：

  • <VERSION> — Target schema version (e.g. 1, 2, 3). Defaults to current

选项：

  • --encrypt — Encrypt secret-bearing string values in the output (api_key, bot_token, access_token, password, refresh_token, etc.). Works at every schema version via a key-name-based walker. Uses the resolved config-dir’s .secret_key (creates one if missing)

zeroclaw update

检查并应用 ZeroClaw 更新。

默认情况下，下载并安装最新版本，采用 6 阶段流水线：预检、下载、备份、验证、切换和冒烟测试。失败时自动回滚。

使用 --check 仅检查更新而不安装。使用 --force 跳过确认提示。使用 --version 指定目标版本，而非最新版本。

示例：zeroclaw update # 下载并安装最新的 zeroclaw 更新 –check # 仅检查，不安装 zeroclaw update –force # 无需确认即安装 zeroclaw update –version 0.6.0 # 安装指定版本

用法： zeroclaw update [OPTIONS]

选项：

  • --check — 仅检查更新，不安装
  • --force — 跳过确认提示
  • --version <VERSION> — 目标版本（默认：最新版本）

zeroclaw 自检

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

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

示例：zeroclaw self-test # 完整套件 zeroclaw self-test –quick # 仅快速检查（无网络）

用法： zeroclaw self-test [OPTIONS]

选项：

  • --quick — 仅运行快速检查（无需网络）

zeroclaw 补全

为 zeroclaw 生成 shell 补全脚本。

该脚本会输出到标准输出（stdout），以便可以直接通过 source 命令加载：

Examples (Unix shells): source <(zeroclaw completions bash) zeroclaw completions zsh > ~/.zfunc/_zeroclaw zeroclaw completions fish > ~/.config/fish/completions/zeroclaw.fish

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

用法： zeroclaw completions <SHELL>

参数：

  • <SHELL> — 目标 Shell

    可能的值：bash、fish、zsh、powershell、elvish

zeroclaw 桌面版

启动 ZeroClaw 伴侣桌面应用。

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

使用 –install 下载适用于您平台的预构建的配套应用。

示例：zeroclaw desktop # 启动配套应用 zeroclaw desktop –install # 下载并安装它

用法： zeroclaw desktop [OPTIONS]

选项：

  • --install — 下载并安装配套应用

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