Skip to content

CLI 参考

QuantClaw 完整命令参考。

全局选项

bash
quantclaw [OPTIONS] COMMAND [ARGS]
  • --help, -h — 显示帮助
  • --version, -v — 显示版本
  • --config PATH — 指定配置文件路径
  • --log-level LEVEL — 日志级别:tracedebuginfowarnerror

命令

agent

向 Agent 发送消息。

bash
quantclaw agent [OPTIONS] MESSAGE

选项:

  • --session SESSION — 指定会话 key(默认自动生成)

示例:

bash
# 发送消息(自动创建会话)
quantclaw agent "你好,介绍一下你自己"

# 使用指定会话
quantclaw agent --session my:project "项目进展如何?"

run

向 Agent 发送消息(agent 的别名)。

bash
quantclaw run MESSAGE

eval

一次性 Prompt 评估——不创建也不使用会话历史。

bash
quantclaw eval PROMPT

示例:

bash
quantclaw eval "2 + 2 等于多少?"
quantclaw eval "生成一个随机 UUID"

gateway

管理 RPC 网关。

bash
quantclaw gateway [SUBCOMMAND] [OPTIONS]

gateway(无子命令)

在前台运行网关。

bash
quantclaw gateway

gateway install

安装后台服务定义(Linux: systemd --user,macOS: launchd 用户代理)。

bash
quantclaw gateway install

gateway uninstall

卸载后台服务定义。

bash
quantclaw gateway uninstall

gateway start / stop / restart

控制后台服务。

bash
quantclaw gateway start
quantclaw gateway stop
quantclaw gateway restart

gateway status

查看后台服务是否正在运行。

bash
quantclaw gateway status

gateway call

直接调用任意 RPC 方法。

bash
quantclaw gateway call METHOD [JSON_PARAMS]

示例:

bash
quantclaw gateway call gateway.health
quantclaw gateway call config.get '{"path":"llm.model"}'

sessions

管理对话会话。

bash
quantclaw sessions SUBCOMMAND
bash
quantclaw sessions list
quantclaw sessions history SESSION_KEY
quantclaw sessions delete SESSION_KEY
quantclaw sessions reset SESSION_KEY

config

管理配置。

bash
quantclaw config SUBCOMMAND
bash
quantclaw config get                    # 查看完整配置
quantclaw config get llm.model         # 查看指定配置项(点路径)
quantclaw config set llm.model "anthropic/claude-sonnet-4-6"
quantclaw config unset llm.temperature
quantclaw config reload                # 热重载(无需重启网关)
quantclaw config validate              # 验证语法
quantclaw config schema                # 查看 Schema

skills

管理技能。

bash
quantclaw skills list              # 列出已加载技能
quantclaw skills install NAME      # 安装技能依赖

memory

搜索和查看 Agent 记忆。

bash
quantclaw memory search "查询内容"
quantclaw memory search "近期事件" --limit 10
quantclaw memory status

选项:

  • --limit N — 结果数量限制(默认 5)

cron

管理定时任务。

bash
quantclaw cron list                            # 列出所有定时任务
quantclaw cron add NAME "0 9 * * *" "TASK"    # 添加任务(cron 表达式)
quantclaw cron remove TASK_ID                 # 按 ID 删除任务

health

快速健康检查——确认网关是否可达。

bash
quantclaw health

status

显示连接数和会话数。

bash
quantclaw status

logs

查看网关日志,默认显示最后 50 行。

bash
quantclaw logs            # 显示最后 50 行
quantclaw logs -n 100     # 显示最后 100 行
quantclaw logs -f         # 实时跟踪日志
quantclaw logs -n 20 -f   # 从最后 20 行开始实时跟踪
参数说明
-n <count>显示行数(默认:50)
-f跟踪模式——实时输出新日志

Linux 下若无日志文件则自动回退到 journalctl。Windows 不支持跟踪模式(-f)。

doctor

运行完整诊断检查。

bash
quantclaw doctor

dashboard

在浏览器中打开 Web 仪表板。

bash
quantclaw dashboard

打开 http://127.0.0.1:18801

onboard

交互式设置向导。

bash
quantclaw onboard [OPTIONS]

选项:

  • --quick — 快速设置(无交互)
  • --install-daemon — 同时安装网关后台服务定义

示例:

bash
quantclaw onboard                     # 交互式
quantclaw onboard --quick             # 无交互
quantclaw onboard --install-daemon    # 交互式 + 安装后台服务

对话内消息指令

与 AI 对话时,发送以斜杠开头的消息即可控制当前会话:

指令效果
/new开启新会话
/reset清空当前会话历史
/compact手动触发上下文压缩
/status显示当前会话和队列状态
/commands列出所有可用斜杠指令
/help显示帮助信息

环境变量

变量说明
OPENAI_API_KEYOpenAI / 兼容 Provider API Key
ANTHROPIC_API_KEYAnthropic API Key
QUANTCLAW_LOG_LEVEL日志级别覆盖(debuginfowarnerror
QUANTCLAW_PORTSidecar IPC 端口(内部使用,自动设置)

端口

服务端口用途
WebSocket RPC 网关18800主网关,客户端连接入口
HTTP REST API / 仪表板18801Web UI 和 REST API

完整工作流示例

bash
# 1. 初始化
quantclaw onboard --quick

# 2. 安装并启动后台服务
quantclaw gateway install
quantclaw gateway start

# 3. 发送消息
quantclaw agent "你好!"

# 4. 查看会话历史
quantclaw sessions list
quantclaw sessions history SESSION_KEY

# 5. 搜索记忆
quantclaw memory search "项目笔记"

# 6. 检查状态
quantclaw health
quantclaw status

# 7. 查看日志
quantclaw logs

需要帮助? 运行 quantclaw --helpquantclaw COMMAND --help

基于 Apache 2.0 协议发布。