命令行、API 与功能索引
命令行
csgclaw 管理本机服务和产品对象。csgclaw-cli 面向与运行中服务交互的流程,可用于终端、集成和智能体。使用相应命令的 --help 查看此版本的参数。下表命令组按当前主程序注册入口整理,具体权限和可用子命令因调用身份而异。
| 命令组 | 能做什么 |
|---|---|
serve / stop / upgrade | 启停本地服务、检查和应用更新。 |
agent / model | 创建、列出、启动、停止、删除、查看运行日志和管理模型授权。 |
participant(pt)/ user | 管理参与者或真人身份,绑定内置或外部渠道。 |
room / member / message | 创建和查看房间、管理成员、收发及查看消息。 |
team / task | 配置团队,查看和推进任务、房间派工与验收。 |
scheduled-task | 查看服务器时间和执行者,列出、创建、修改计划。 |
template / skill | 管理模板及版本、查看或管理技能资源。 |
app | 查看连接器类型、资源和智能体绑定。管理连接、断开和配置。 |
relay | 诊断 Relay 注册和连接协议。 |
completion | 输出 Bash、Zsh、Fish 等受支持的 Shell 补全,查看帮助确定可用选项。 |
快速确认本地安装和只读查询:
csgclaw --version
csgclaw --help
csgclaw agent list
csgclaw room list
csgclaw scheduled-task context
csgclaw-cli --help
全局参数放在子命令前。例如需要结构化输出时使用 csgclaw --output json agent list。连接自定义实例时查看 CLI 的 --help、CSGCLAW_BASE_URL 和访问令牌相关设置。参见完整命令参考及房间任务命令。
API 与集成
| 目的 | 参考 |
|---|---|
| 管理 Agent、参与者、房间 、消息与会话 | HTTP API 中文参考 |
| 以会话方式发送输入、接收事件和处理交互 | 会话 API 演示 · 第三方客户端接入 |
| 管理连接器、MCP 服务和知识库 | 连接器 API · MCP 配置 · 知识库 |
| 接入社区 Relay 或托管环境 | Relay · 托管运行参考 |
| 使用结构化结果、引用和 token 统计 | 结构化输出 · 引用格式 · Token 消耗 |
调用受保护接口时使用当前实例要求的身份。访问令牌、渠道凭据及第三方模型 Key 分别管理。Agent 自身使用的权限和用户管理权限也按接口区分。
本地配置
服务监听地址、访问令牌和启动配置见 本地配置参考。模型与提供方在工作区的 模型服务 管理。升级既有环境时,请核对 维护与升级说明。
功能索引
| 功能面 | 文档 |
|---|---|
| 安装、首次启动、首次对话 | 快速上手 |
| 新建任务、选择执行对象、会话配置、历史搜索、消息、附件、资源、交互、预览与线程 | 任务与对话 |
| 团队、房间、角色、发言、外部消息成员、共享目录、任务进度和验收 | 多智能体协作 |
| 智能体创建与配置、个人记忆、模板和版本、社区发布与下架、云端智能体 | 智能体、模板与广场 |
| 模型服务、资源启停、技能、连接器、MCP、知识库 | 模型与资源 |
| 手动及自然语言计划、执行记录、外部消息和飞书渠道 | 定时任务与消息集成 |
| 13 项设置、桌面能力、数据和升级维护 | 设置、维护与排障 |
| 命令行和开发者接口 | 本章 |
已退役的容器运行方式见迁移说明。
演示范围
截图来自 1808df82 的本地 Web 演示环境。真实模型回复、Worker 派工与交付、计划触发、OpenCSG 登录与发布、外部消息和飞书收发,以及桌面原生功能需要在实际部署环境中验证。