CSGClaw：CLI 命令参考

← 返回 CSGClaw 概览

csgclaw 负责初始化、本地服务生命周期、Agent 管理以及协作类命令。csgclaw-cli 仅提供 bot / room / member / message，面向脚本与 Agent；二者都通过本地 HTTP API 访问服务，不直接操作沙箱或渠道 SDK。

通用约定

输出格式

• --output table：表格或易读文本。
• --output json：结构化 JSON。
• 未指定时：输出到终端默认 table；管道或重定向默认 json。
• serve、stop、agent logs 等命令的输出格式以当前版本行为为准。

环境变量

• CSGCLAW_BASE_URL：默认 API 地址。
• CSGCLAW_ACCESS_TOKEN：默认 API Token。
• 同时使用 --endpoint / --token 时，命令行优先。

渠道

• 多数协作命令支持 --channel：csgclaw（默认）或 feishu。

配置与路径（仅 csgclaw）

• --config：默认 ~/.csgclaw/config.toml。
• 后台日志：~/.csgclaw/server.log；PID：~/.csgclaw/server.pid。
• Agent 状态：~/.csgclaw/agents/state.json；内置 IM 状态：~/.csgclaw/im/state.json。

csgclaw 全局与顶层命令

csgclaw [global-flags] <command> [args]

全局参数

参数	含义
--endpoint	HTTP 服务地址，默认来自 CSGCLAW_BASE_URL
--token	API Token，默认来自 CSGCLAW_ACCESS_TOKEN
--output	table | json
--config	配置文件路径
--version / -V	打印版本

顶层命令：onboard、serve、stop、agent、user、bot、room、member、message。

csgclaw onboard

初始化本地配置与引导状态。

参数	说明
--provider	csghub-lite、custom
--base-url	LLM Base URL
--api-key	LLM API Key
--models	逗号分隔模型 ID
--reasoning-effort	可选，上游 reasoning_effort 默认值
--manager-image	引导 Manager 使用的镜像
--debian-registries	拉取 debian:bookworm-slim 的 OCI registry 列表，逗号分隔，写入配置
--force-recreate-manager	删除并重建引导 Manager box

无配置且未传模型相关参数时可进入交互引导；脚本环境建议显式传入模型。模型配置不完整时，serve 会报错并提示补齐。

csgclaw serve / stop

命令	说明
serve [-d|--daemon]	启动服务；--daemon 为后台运行；可指定 --log、--pid
stop	按 PID 文件发送 SIGTERM

csgclaw agent

子命令：list、create、start、stop、delete、logs、status。

子命令	摘要
list [--filter]	列出 Agent，可按状态过滤
create --name ... [--id] [--description] [--profile]	创建
start <id> / stop <id>	启停
delete <id> / delete --all [-f]	删除；--all 批量，-f 跳过确认
logs <id> [-f] [-n lines]	日志；-n 须大于 0；--follow 时一般不支持 --output json
status [id]	指定 id 查看单个；省略 id 时等同 list

csgclaw user

子命令：list、create、delete。均支持 --channel（csgclaw / feishu）。create 时 --name 必填；飞书侧可配置 --avatar 等。

协作命令组（bot / room / member / message）

与 csgclaw-cli 使用同一套参数与校验逻辑。

bot：list、create、delete

• list：--channel、--role（manager / worker）
• create：--name（必填）、--role（manager | worker，必填）、--id、--description、--channel、--model-id
• delete <id> [--channel]

room：list、create、delete

• create：--title、--description、--creator-id、--member-ids（逗号分隔）、--locale、--channel

member：list、create

• list：--room-id、--channel
• create：--room-id、--user-id（必填）、--inviter-id、--locale、--channel

message：list、create

• list：--room-id（必填）、--channel
• create：--room-id、--sender-id、--content（必填）、可选 --mention-id、--channel

csgclaw-cli

csgclaw-cli [global-flags] <command>

全局参数：--endpoint、--token、--output、--version。
命令：bot、room、member、message（子命令与 csgclaw 中同名组一致）。

HTTP 与配置文件字段见 API 与配置。