CLI 参考

所有 officeclaws 命令和参数,集中在一处。

运行 officeclaws help 查看内置摘要。大多数作用于 Agent 的命令都接受 --agent <id>。不指定时,会使用你的第一个 Agent。

账号

命令说明
officeclaws register [--email] [--name] [--password-stdin]创建账号并登录
officeclaws login [--email] [--password-stdin]登录
officeclaws logout [--keep-credentials]退出登录。除非传入 --keep-credentials,否则也会删除已保存的凭据。
officeclaws whoami显示当前账号以及它是否有 Agent
officeclaws subscribe [--plan selfHosted] [--locale en]打开关联到你账号的结账页面

--password-stdin 从标准输入读取密码,适用于脚本。示例:echo "$PW" | officeclaws login --email [email protected] --password-stdin。

Agent

命令说明
officeclaws onboard [flags]把一台 Contabo VPS 配置为 Agent。参见 创建你的 Agent。
officeclaws agents列出你的 Agent
officeclaws connect-codex [--agent]连接你的 ChatGPT 订阅
officeclaws chat [--agent] [-m "message"]交互式聊天,或发送单条消息
officeclaws logs [--agent] [--lines N] [-f]显示或实时查看 Agent 的日志

onboard 参数:--name、--vps、--reinstall、--ssh-pubkey、--avatar、--comm-style、--tailscale-hostname、--tailscale-authkey、--contabo-client-id、--contabo-client-secret、--contabo-api-user、--contabo-api-password。--reinstall 用于我们内部的预制服务器镜像,不会清除你的 VPS。如果想从干净的服务器开始,请改为在 Contabo 控制面板中重装 Ubuntu 24.04。

定时任务

命令说明
officeclaws cron list列出定时任务
officeclaws cron add --name --schedule --message [--timezone] [--channel] [--target]添加任务
officeclaws cron rm <name-or-id>删除任务

Telegram

命令说明
officeclaws telegram set [--bot-token] [--dm-policy pairing|allowlist|open|disabled]连接或更新机器人
officeclaws telegram show显示当前设置
officeclaws telegram pairings列出待处理的配对码
officeclaws telegram approve <code>批准一个 Telegram 用户
officeclaws telegram disable关闭 Telegram

凭据与设备

命令说明
officeclaws vault list [--type contabo|tailscale|telegram]列出已保存的凭据(值已遮盖)
officeclaws vault apply <id>把某组已保存的凭据设为当前使用
officeclaws vault rm <id>删除一组已保存的凭据
officeclaws devices list / approve <id>Agent 网关上的设备请求
officeclaws pairing list / approve <id> / reject <id> / repair操作员配对请求;repair 用于修复 “1008 pairing required”

高级

命令说明
officeclaws adopt --vps <id> --host <tailscale-ip> --name <name>当服务器已就绪但设置被中断时,登记一个已经在运行的 Agent。仅在支持人员要求时使用。
officeclaws version打印版本号

环境变量

变量说明
OFFICECLAWS_DEBUG=1把详细日志输出到 stderr
OPENCLAW_RPC=0使用备用聊天连接(很少需要)

数据存储位置

内容位置
会话、Contabo 和 Tailscale 凭据、vault系统钥匙串,服务名 openclaw-office
用于管理 Agent 的 SSH 密钥~/.ssh/openclaw_id_ed25519
设置日志~/.openclaw/logs