PetClaw 操作命令

这页只聚焦在 PetClaw 实际可执行的命令。

补充说明：如果你查的是 OpenClaw 上游文档，里面常会写成 openclaw ...；在当前项目里，通常直接理解为 petclaw ... 即可。

最常用的 5 个命令

| 命令 | 用途 | 什么时候用 | |---|---|---| | petclaw --version | 查看当前 runtime 版本 | 确认安装是否成功 | | petclaw health | 检查本地 gateway 健康状态 | 应用连不上服务时 | | petclaw gateway | 启动本地 gateway | 首次启动或服务未运行时 | | petclaw dashboard --no-open | 输出带 token 的控制台地址 | 调试 dashboard 链接或 token | | petclaw channels login --channel whatsapp | 登录 WhatsApp 频道 | 配置账号接入时 |

启动与基础检查

查看版本

petclaw --version

用于确认内嵌 runtime 是否已经安装，以及当前版本是否正确。

检查健康状态

petclaw health

适合在这些场景下使用：

应用打不开会话
WebSocket 连接失败
不确定本地 gateway 是否还活着

查看整体状态

petclaw status

status 更偏面向人的全局状态概览，适合快速看频道、会话和运行状态。

Gateway 相关命令

gateway 是当前项目最重要的一组命令之一。

petclaw gateway
petclaw gateway run
petclaw gateway status
petclaw gateway health
petclaw gateway probe
petclaw gateway discover
petclaw gateway call <method>

常见用途

petclaw gateway
- 直接启动本地 gateway
petclaw gateway status
- 看 gateway 当前是否正在运行
petclaw gateway health
- 看 gateway 是否能正常响应
petclaw gateway probe
- 探测本地服务是否可达
petclaw gateway discover
- 做本地或局域网发现
petclaw gateway call <method>
- 手动调用 RPC 方法做调试

最常见的启动命令

petclaw gateway

在当前 CLI 设计里，petclaw gateway 本身就可以作为启动命令使用。

Dashboard 与会话相关命令

获取 dashboard 地址

petclaw dashboard --no-open

这条命令会输出一个带 token 的控制台 URL。当前项目会从输出里提取 #token=...，它是连接本地 gateway 的关键步骤之一。

查看会话

petclaw sessions
petclaw sessions cleanup

适合：

查看当前有哪些 session
清理历史 session 数据
排查会话异常或残留

Channels 相关命令

channels 主要用于配置外部消息渠道和账号登录态。

petclaw channels list
petclaw channels status
petclaw channels add
petclaw channels remove
petclaw channels login --channel whatsapp
petclaw channels logout

常见场景

| 命令 | 用途 | |---|---| | petclaw channels list | 查看当前支持或已配置的 channels | | petclaw channels status | 检查频道连接状态 | | petclaw channels add | 添加新的 channel 配置 | | petclaw channels remove | 删除 channel 配置 | | petclaw channels login --channel whatsapp | 发起 WhatsApp 登录或配对 | | petclaw channels logout | 退出当前 channel 登录态 |

配置与诊断命令

初始化与引导

petclaw setup
petclaw onboard
petclaw configure

setup：初始化本地配置与 workspace
onboard：执行首次引导
configure：交互式配置凭据、频道、网关和默认项

配置与修复

petclaw config
petclaw doctor
petclaw backup
petclaw reset

config：查看、修改、校验配置
doctor：做健康检查并给出修复建议
backup：备份本地状态
reset：重置本地状态

其他常见命令族

这些命令不是每次都会用到，但在排障、集成和扩展时很常见：

| 命令族 | 用途 | |---|---| | logs | 查看 gateway 日志 | | models | 模型发现、扫描、配置 | | approvals | 执行审批管理 | | devices | 设备配对与 token 管理 | | plugins | 插件和扩展管理 | | skills | 查看或检查 skills | | docs | 搜索 OpenClaw 文档 | | update | 更新 OpenClaw / runtime | | completion | 生成 shell completion |

在这个项目里怎么理解这些命令

对当前项目来说，CLI 主要负责：

安装
初始化
启动 gateway
诊断与修复
配置 channel 和 dashboard

而聊天、历史记录、工具卡片等主界面能力，更多是通过连接本地 gateway 后走 RPC 完成，不是不断调用 CLI 完成。