Skip to content

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管理 agentlist 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
cgCG 过场list run delete skill-state preview
asr语音识别transcribe prewarm focus gpu-tier model-choice regenerate-voice
recipesRecipe(市场)catalog protocol list get export-zip import-zip bind unbind validate dry-run eval
recipeRecipe(作者工具)pack sign verify publish relay-review-pending/approve/reject/status
flowFlow(作者工具)pack sign verify publish relay-review-*
flowsFlow 实例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

✨ Familiars · 多 Agent AI 桌面应用 —— 对话树记忆 · 长期记忆 · 工具系统 · 数字人 · Broker 生态