Appearance
CLI 全量命令
Familiars 提供
main.py这一个 CLI 入口,包装了后端 bridge 的全部 REST 端点(除 UI-only WebSocket 流)。来源:CLI.md(全量参考)。
启动前提
CLI 不启动桥,它驱动一个已运行的 bridge;认证走 X-Bridge-Token:
- 默认从
workspace/.bridge_token读取; - 覆盖:
--token/--token-file/BRIDGE_TOKEN环境变量。
bash
# 确保 bridge 已运行
.venv/Scripts/python -m src.bridge.run
# 另开终端
python main.py --help命令组一览
| 组 | 说明 | 子命令示例 |
|---|---|---|
agents | 管理 agent | list create delete avatar portrait manager-entry-image |
chat | 对话 | send stream generate-stream translate models |
dialogues | 对话列表 | list create rename mark-read delete |
tree | 对话树 | get query node path delete move edit |
todos | 待办 | list create patch complete uncomplete delete |
schedules | 日程 | list create complete uncomplete delete |
cron | 定时任务 | list create patch delete runs run-now |
reminders | 提醒 | recent stream snooze dismiss |
settings | 设置 | get put get-agent put-agent get-dialogue put-dialogue get-llm put-llm |
user | 用户 | profile-get profile-put avatar-get avatar-upload intro |
auth | 本地身份 | register login |
background | 后台 | state enable disable quit |
status | 状态 | get stream debug |
usage | 用量 | summary |
memory | 记忆 | writer-status |
learn | 知识 | docs doc |
feedback | 反馈 | proactive stats list add use delete create archive |
draft | 草稿 | auto schedule todo |
reports | 汇报 | list by-agent meta content roll-up run-legacy |
responses | 响应代理 | proxy proxy-stream |
dev | 调试 | fake-gift gift-demo |
gift | 礼物 | video swap open purchase |
feishu | 飞书 | test-webhook webhook |
monitor | 消息监听 | list settings-get settings-put file-roots diag start stop |
skills | 技能 | list run stream agent-list run-in-dialogue propose commit upload… |
skill-forge | 技能锻造 | propose repropose summary preview revise commit |
skill-workshop | 技能影棚 | list upload rewrite run status clips concat-final history… |
cg | CG 过场 | list run delete skill-state preview |
asr | 语音识别 | transcribe prewarm focus gpu-tier model-choice regenerate-voice… |
recipes | Recipe(市场) | catalog protocol list get export-zip import-zip bind unbind validate dry-run eval |
recipe | Recipe(作者工具) | pack sign verify publish relay-review-pending/approve/reject/status |
flow | Flow(作者工具) | pack sign verify publish relay-review-* |
flows | Flow 实例 | list get trace cancel |
comm | 通信 | messages post send approvals-pending approval-request approval-respond interrupt |
broker | 交换所 | keygen keys-list pack sign verify publish install marketplace-index federation-status relay-* crl-* trust-* |
完整 33 组、180+ 子命令(
GROUPS表实时维护)见 CLI.md(顶栏可直接跳转仓库源文档)。下表按语义大组速览:
常用
bash
# 列出所有 agent(表格)
python main.py agents list --pretty
# 用默认 agent 发起对话(SSE 流式输出)
python main.py chat stream --prompt "今天有什么待办?"
# 创建待办
python main.py todos create --title "buy milk" --deadline 2026-07-05T18:00
# 待办完成 / 取消完成
python main.py todos complete --id 3
python main.py todos uncomplete --id 3
# 查询对话树 + 语义检索
python main.py tree get --agent-id 1 --dialogue-id 1
python main.py tree query --agent-id 1 --dialogue-id 1 --text "报销流程" --k 5
# 查看消息监听状态;启动微信监听(GUI 型监听需 1-2 分钟)
python main.py monitor list
python main.py monitor start wechat
# 技能:列表 / 在某个对话里运行
python main.py skills list
python main.py skills run-in-dialogue --agent-id 1 --skill-id my_skill --dialogue-id 3
# 汇报
python main.py reports list --agent-id 1
python main.py reports by-agent --agent-id 1 --kind daily
# 交换所:打包 + 校验 + 安装
python main.py broker keygen --name mykey
python main.py broker pack --source-dir workspace/manager/brokers/starter_broker
python main.py broker verify starter_broker.broker.zip --pretty
python main.py broker install --url https://example.com/x.broker.zip --sha256 <64hex> --pubkey <base64>
# 发布到 relay(发布即审核)
python main.py recipe publish --source-dir <dir> --author-key mykey --relay https://api.familiars.cn
python main.py flow publish --source-dir <dir> --author-key mykey --relay https://api.familiars.cn
# 代理端查看待审核队列
python main.py broker relay-review --relay https://api.familiars.cn --operator-key mykey详细、带输出样例的用法:CLI.md
