Skip to content

CLI 全量命令参考 ​

main.py 是 Familiars bridge 的命令行入口,包装了 47 个路由文件 暴露的全部 REST 端点(WebSocket-only 的数字人/电话流除外)。

40 个命令组、200+ 子命令。本文档是完整参考。


0. 启动前提 ​

CLI 不启动 bridge。它驱动一个已运行的 bridge 实例。

bash
# 先确保 bridge 运行
.venv/Scripts/python -m src.bridge.run

# 另开终端
python main.py --help

认证 ​

每个请求携带 X-Bridge-Token 头。CLI 按以下优先级获取 token:

  1. --token <value> 命令行参数
  2. BRIDGE_TOKEN 环境变量
  3. BRIDGE_TOKEN_PATH 环境变量指向的文件
  4. --token-file <path> 参数指定的文件
  5. 默认:workspace/.bridge_token

Bridge URL ​

  1. --base-url <url> 命令行参数
  2. BRIDGE_URL 环境变量
  3. workspace/.bridges.json(Electron spawn 时写入,含 PID + port)
  4. workspace/.bridge.port(bridge 写入的端口文件)
  5. 默认:https://127.0.0.1:18711

全局选项 ​

选项说明
--prettyJSON 输出美化(2 空格缩进)
--verbose / -v将请求信息输出到 stderr
--base-url覆盖 bridge URL
--token覆盖 bridge token
--token-file指定 token 文件路径
--timeoutHTTP 超时秒数(默认 60)

Body 控制 ​

所有 POST/PUT/PATCH 子命令都支持:

选项说明
--field KEY=VALUE逐个设置 body 字段(可重复,值自动 JSON 解析)
--body-json JSON完整 JSON body(覆盖 --field)
--body-file PATH从文件读取 JSON body(覆盖 --body-json)
--query KEY=VALUE额外 query 参数(可重复)

文件上传 ​

支持 multipart/form-data 的子命令:

选项说明
--file PATH上传文件路径(必填)
--form KEY=VALUE附加表单字段(可重复)

1. 命令组总览 ​

#组名说明子命令数
1auth本地身份注册/登录2
2broker交换所作者工具 + 市场安装 + 联邦/CRL/信任管理20
3recipeRecipe 作者工具:pack/sign/verify/publish + relay 审核8
4flowFlow 模板作者工具:pack/sign/verify/publish + relay 审核8
5agentsAgent 生命周期 + 资产16
6chat对话:发送/流式/翻译/模型列表5
7dialogues对话列表管理5
8tree对话树结构操作7
9todos待办 CRUD6
10schedules日程 CRUD5
11cron定时任务管理6
12reminders提醒:最近/SSE 流/贪睡/忽略4
13settings运行时设置(全局/agent/dialogue/LLM)8
14user用户资料/头像5
15background后台模式 + autorun4
16status运行时状态3
17usageLLM token 用量1
18memory记忆 writer 诊断1
19learn框架文档2
20feedback主动消息评分2
21quick-inputs快捷输入模板4
22quick-ask快捷键临时对话2
23draft文本自动分类为日程/待办3
24reports报告 + manager 元评审6
25responsesOpenAI Responses API 代理2
26dev开发/演示端点2
27gift礼物 v24
28feishu飞书 webhook2
29monitor社交监听器7
30skills技能列表/运行/SSE10
31skill-forge技能锻造6
32skill-workshop技能影棚(视频流水线)14
33cgCG 过场动画5
34asrASR 语音识别 + 预热7
35digital-human数字人 REST4
36phone-call电话通话 REST1
37recipes-libraryRecipe 市场库3
38recipesRecipe CRUD/绑定/干跑/评估16
39agent-workshop外部 agent 导入6
40agent-assetsAgent 资产 staging/替换9
41comm通信中心(消息/审批/中断)7
42flowsFlow 实例管理4

2. auth — 本地身份 ​

bash
# 注册新本地身份
python main.py auth register --nickname "Alice"

# 登录(当前设备指纹)
python main.py auth login
子命令HTTP路径参数
registerPOST/api/auth/register--nickname
loginPOST/api/auth/login无

3. broker — 交换所 ​

3.1 本地作者工具(不需要 bridge) ​

bash
# 生成 Ed25519 签名密钥
python main.py broker keygen --name mykey
python main.py broker keygen --name mykey --overwrite   # 覆盖旧密钥

# 列出已有密钥
python main.py broker keys-list

# 打包 broker 目录
python main.py broker pack workspace/manager/brokers/starter_broker
python main.py broker pack workspace/manager/brokers/starter_broker --output custom.broker.zip

# 签名
python main.py broker sign starter_broker.broker.zip --author-key mykey

# 校验
python main.py broker verify starter_broker.broker.zip --pretty

# 一键发布到 relay
python main.py broker publish workspace/manager/brokers/starter_broker \
  --author-key mykey --relay https://api.familiars.cn \
  --author-name "My Broker" --categories "tools,chat"

# 一键发布到本地 host 目录
python main.py broker publish workspace/manager/brokers/starter_broker \
  --author-key mykey --host-dir ./host --download-url-base https://brokers.example.com/

3.2 市场安装(需要 bridge) ​

bash
python main.py broker install --url https://example.com/x.broker.zip \
  --sha256 <64位hex> --pubkey <base64>

# 查看市场 index
python main.py broker marketplace-index

3.3 联邦管理 ​

bash
python main.py broker federation-status

3.4 Relay 信任管理(operator-only) ​

bash
python main.py broker relay-trust-add --pubkey <b64> --operator-key mykey \
  --relay https://api.familiars.cn --name "Trusted Author" --notes "vouched"

python main.py broker relay-trust-list --relay https://api.familiars.cn

python main.py broker relay-trust-remove --pubkey <b64> --operator-key mykey \
  --relay https://api.familiars.cn

3.5 Relay 审核 ​

bash
# 查看待审核队列
python main.py broker relay-review-pending --operator-key mykey --relay https://api.familiars.cn

# 审批
python main.py broker relay-review-approve --broker-id starter_broker --version 1.0.0 \
  --operator-key mykey --relay https://api.familiars.cn --note "LGTM"

# 拒绝
python main.py broker relay-review-reject --broker-id starter_broker --version 1.0.0 \
  --note "Missing manifest" --operator-key mykey --relay https://api.familiars.cn

# 查看提交状态
python main.py broker relay-review-status --broker-id starter_broker --version 1.0.0 \
  --author-key mykey --relay https://api.familiars.cn

# 交互式逐条审核
python main.py broker relay-review --operator-key mykey --relay https://api.familiars.cn

3.6 集群 CRL + 信任管理 ​

bash
# CRL 吊销
python main.py broker crl-revoke --pubkey <b64> --operator-key mykey --reason "compromised"

# CRL 列表
python main.py broker crl-list

# CRL 取消吊销
python main.py broker crl-unrevoke --pubkey <b64> --operator-key mykey

# 集群信任添加/列表/移除
python main.py broker trust-add --pubkey <b64> --operator-key mykey
python main.py broker trust-list
python main.py broker trust-remove --pubkey <b64> --operator-key mykey

完整子命令表 ​

子命令类型说明关键参数
keygen本地生成 Ed25519 签名密钥--name --overwrite
keys-list本地列出已有密钥-
pack本地打包 broker 目录为 .broker.zipsource_dir --output
sign本地签名 .broker.zipzip_path --author-key
verify本地校验签名 + manifestzip_path
publish本地一键 pack+sign+发布source_dir --author-key --relay/--host-dir+--download-url-base --author-name --categories
installbridge从市场 URL 安装--url --sha256 --pubkey
marketplace-indexbridge查看市场 index-
federation-statusbridge联邦状态-
relay-trust-add本地→relay添加信任--pubkey --operator-key --relay
relay-trust-list本地→relay列出信任--relay
relay-trust-remove本地→relay移除信任--pubkey --operator-key --relay
relay-review-pending本地→relay待审核列表--operator-key --relay
relay-review-approve本地→relay审批--broker-id --version --operator-key --relay
relay-review-reject本地→relay拒绝--broker-id --version --note --operator-key --relay
relay-review-status本地→relay状态查询--broker-id --version --author-key --relay
relay-review本地→relay交互式审核--operator-key --relay
crl-revoke本地→bridgeCRL 吊销--pubkey --operator-key --reason
crl-list本地→bridgeCRL 列表-
crl-unrevoke本地→bridgeCRL 取消吊销--pubkey --operator-key
trust-add本地→bridge集群信任添加--pubkey --operator-key
trust-list本地→bridge集群信任列表-
trust-remove本地→bridge集群信任移除--pubkey --operator-key

4. recipe — Recipe 作者工具 ​

bash
python main.py recipe pack workspace/agent_recipes/my_recipe
python main.py recipe sign my_recipe.recipe.zip --author-key mykey
python main.py recipe verify my_recipe.recipe.zip
python main.py recipe publish workspace/agent_recipes/my_recipe \
  --author-key mykey --relay https://api.familiars.cn
子命令类型说明关键参数
pack本地打包为 .recipe.zipsource_dir --output
sign本地签名zip_path --author-key
verify本地校验zip_path
publish本地→relay打包+签名+上传source_dir --author-key --relay --author-name --categories
relay-review-pending本地→relay待审核列表--operator-key --relay
relay-review-approve本地→relay审批--artifact-id --version --operator-key --relay
relay-review-reject本地→relay拒绝--artifact-id --version --note --operator-key --relay
relay-review-status本地→relay状态查询--artifact-id --version --author-key --relay
relay-review本地→relay交互式审核--operator-key --relay

5. flow — Flow 模板作者工具 ​

与 recipe 同构,只是打包对象是 flow template 目录。

子命令类型说明关键参数
pack本地打包为 .flow.zipsource_dir --output
sign本地签名zip_path --author-key
verify本地校验zip_path
publish本地→relay打包+签名+上传source_dir --author-key --relay
relay-review-pending本地→relay待审核列表--operator-key --relay
relay-review-approve本地→relay审批--artifact-id --version --operator-key --relay
relay-review-reject本地→relay拒绝--artifact-id --version --note --operator-key --relay
relay-review-status本地→relay状态查询--artifact-id --version --author-key --relay
relay-review本地→relay交互式审核--operator-key --relay

6. agents — Agent 生命周期 ​

bash
python main.py agents list --pretty
python main.py agents create --agent-id 5
python main.py agents create-stream --name "小助手" --identity "温柔体贴" --personality "幽默"
python main.py agents delete 5
python main.py agents avatar 1 --output avatar.png
python main.py agents portrait 1 --output portrait.png
python main.py agents figure-rgba 1 --output figure.png
python main.py agents bust-loop 1 --output bust.webp
python main.py agents diagnose-dirs
子命令HTTP路径关键参数
listGET/api/agents-
createPOST/api/agents--agent-id
create-streamSSEGET /api/agents/create/stream--name --identity --personality --appearance --voice --need-figure --need-audio --figure-staging-id --voice-staging-id --voice-transcript
deleteDELETE/api/agents/{agent_id}agent_id
greeting-playedPOST/api/agents/{agent_id}/greeting/playedagent_id
greeting-videoGET/api/agents/{agent_id}/greetingagent_id --output
diagnose-dirsGET/api/agents/diagnose-dirs-
avatarGET/api/agents/{agent_id}/avataragent_id --output
portraitGET/api/agents/{agent_id}/portraitagent_id --output
figure-rgbaGET/api/agents/{agent_id}/figure_rgbaagent_id --output
bust-loopGET/api/agents/{agent_id}/bust_loopagent_id --output
bust-metaGET/api/agents/{agent_id}/bust_metaagent_id
theme-elementGET/api/agents/{agent_id}/theme/{element}agent_id element --output
theme-metaGET/api/agents/{agent_id}/theme/metaagent_id
skill-cgGET/api/agents/{agent_id}/skills/{skill_id}/cgagent_id skill_id --output
manager-entry-imageGET/api/manager/entry-image/{key}key --output

7. chat — 对话 ​

bash
# 发送消息,获取完整 JSON 回复
python main.py chat send --prompt "你好" --agent-id 1

# SSE 流式输出
python main.py chat stream --prompt "今天有什么待办?" --agent-id 1

# 翻译
python main.py chat translate --text "Hello World" --target zh

# 列出可用模型
python main.py chat models
子命令HTTP路径关键参数
sendPOST/api/chat/send--prompt --agent-id --dialogue-id --parent-id --type --call-mode
streamSSEGET /api/chat/stream--prompt --agent-id --dialogue-id --parent-id --type --model --regen-q --resume-a --call-mode
generate-streamSSEGET /api/chat/generate/stream--prompt --agent-id
translatePOST/api/translate--text --target
modelsGET/api/models-

8. dialogues — 对话列表 ​

bash
python main.py dialogues list 1
python main.py dialogues create 1 --topic "新对话"
python main.py dialogues rename 1 3 --topic "重命名"
python main.py dialogues mark-read 1 3
python main.py dialogues delete 1 3
子命令HTTP路径关键参数
listGET/api/dialogues/{agent_id}agent_id
createPOST/api/dialogues/{agent_id}agent_id --topic
renamePATCH/api/dialogues/{agent_id}/{dialogue_id}agent_id dialogue_id --topic
mark-readPOST/api/dialogues/{agent_id}/{dialogue_id}/readagent_id dialogue_id
deleteDELETE/api/dialogues/{agent_id}/{dialogue_id}agent_id dialogue_id

9. tree — 对话树 ​

bash
python main.py tree get 1 1
python main.py tree query 1 1 --text "报销流程" --k 5
python main.py tree node 1 1 42
python main.py tree path 1 1 42
python main.py tree delete 1 1 42
python main.py tree move 1 1 --node-id 42 --new-parent-id 10
python main.py tree edit 1 1 42 --content "修改后的内容"
子命令HTTP路径关键参数
getGET/api/tree/{agent_id}/{dialogue_id}agent_id dialogue_id
queryGET/api/tree/{agent_id}/{dialogue_id}/queryagent_id dialogue_id --text --k
nodeGET/api/tree/{agent_id}/{dialogue_id}/node/{node_id}agent_id dialogue_id node_id
pathGET/api/tree/{agent_id}/{dialogue_id}/path/{node_id}agent_id dialogue_id node_id
deleteDELETE/api/tree/{agent_id}/{dialogue_id}/node/{node_id}agent_id dialogue_id node_id
movePOST/api/tree/{agent_id}/{dialogue_id}/moveagent_id dialogue_id --node-id --new-parent-id
editPATCH/api/tree/{agent_id}/{dialogue_id}/node/{node_id}agent_id dialogue_id node_id --content

10. todos — 待办 ​

bash
python main.py todos list
python main.py todos create --title "买牛奶" --deadline 2026-07-05T18:00
python main.py todos patch 3 --title "买全脂牛奶"
python main.py todos complete 3
python main.py todos uncomplete 3
python main.py todos delete 3
子命令HTTP路径关键参数
listGET/api/todos--open-only
createPOST/api/todos--title --content --deadline --emergency-level --needs-reminder --remind-at --frequency
patchPATCH/api/todos/{todo_id}todo_id --title --content --deadline --emergency-level
completePOST/api/todos/{todo_id}/completetodo_id
uncompletePOST/api/todos/{todo_id}/uncompletetodo_id
deleteDELETE/api/todos/{todo_id}todo_id

11. schedules — 日程 ​

bash
python main.py schedules list --agent-id 1
python main.py schedules create --title "会议" --scheduled-time 2026-08-30T14:00:00
python main.py schedules complete 5
python main.py schedules uncomplete 5
python main.py schedules delete 5
子命令HTTP路径关键参数
listGET/api/schedules--agent-id
createPOST/api/schedules--title --content --scheduled-time --emergency-level --frequency --kind --needs-reminder --remind-at
completePOST/api/schedules/{schedule_id}/completeschedule_id
uncompletePOST/api/schedules/{schedule_id}/uncompleteschedule_id
deleteDELETE/api/schedules/{schedule_id}schedule_id

12. cron — 定时任务 ​

bash
python main.py cron list --agent-id 1
python main.py cron create --name "morning_report" --cron "0 9 * * *" --task "生成每日报告" --agent-id 1
python main.py cron patch morning_report --cron "30 9 * * *"
python main.py cron runs morning_report --limit 10
python main.py cron run-now morning_report
python main.py cron delete morning_report
子命令HTTP路径关键参数
listGET/api/cron-jobs--agent-id --include-system
createPOST/api/cron-jobs--name --cron --task --agent-id --action --recurring
patchPATCH/api/cron-jobs/{name}name --new-name --cron --task --action --recurring --agent-id
deleteDELETE/api/cron-jobs/{name}name
runsGET/api/cron-jobs/{name}/runsname --limit
run-nowPOST/api/cron-jobs/{name}/run-nowname

13. reminders — 提醒 ​

bash
python main.py reminders recent --since-ts 1725000000 --limit 20
python main.py reminders stream --start-ts 1725000000
python main.py reminders snooze todo 3 --minutes 15
python main.py reminders dismiss schedule 5
子命令HTTP路径关键参数
recentGET/api/reminders/recent--since-ts --limit
streamSSEGET /api/reminders/stream--start-ts
snoozePOST/api/reminders/{kind}/{subject_id}/snoozekind(schedule/todo) subject_id --minutes
dismissPOST/api/reminders/{kind}/{subject_id}/dismisskind subject_id

14. settings — 运行时设置 ​

bash
python main.py settings get
python main.py settings put --body-json '{"color":"red"}'
python main.py settings get-agent 1
python main.py settings put-agent 1 --body-json '{"need_initiative":false}'
python main.py settings get-llm
python main.py settings put-llm --base-url https://api.openai.com/v1 --api-key sk-xxx
子命令HTTP路径关键参数
getGET/api/settings-
putPUT/api/settingsJSON body
get-agentGET/api/agents/{agent_id}/settingsagent_id
put-agentPUT/api/agents/{agent_id}/settingsagent_id JSON body
get-dialogueGET/api/dialogues/{agent_id}/{dialogue_id}/settingsagent_id dialogue_id
put-dialoguePUT/api/dialogues/{agent_id}/{dialogue_id}/settingsagent_id dialogue_id JSON body
get-llmGET/api/settings/llm-
put-llmPUT/api/settings/llm--base-url --api-key --default-model --transport-mode --auto-fallback

15. user — 用户资料 ​

bash
python main.py user profile-get
python main.py user profile-put --body-json '{"nickname":"Alice"}'
python main.py user avatar-get --output my_avatar.png
python main.py user avatar-upload --file avatar.png
python main.py user intro --text "我是一名开发者"
子命令HTTP路径关键参数
profile-getGET/api/user/profile-
profile-putPUT/api/user/profileJSON body
avatar-getGET/api/user/avatar--output
avatar-uploadPOST/api/user/avatar--file
introPOST/api/user/intro--text

16. background — 后台模式 ​

子命令HTTP路径
stateGET/api/background/state
enablePOST/api/background/enable
disablePOST/api/background/disable
quitPOST/api/background/quit

17. status — 运行时状态 ​

子命令HTTP路径关键参数
getGET/api/status-
streamSSEGET /api/status/stream-
debugPOST/api/status/debug--key --label --detail --level --clear

18. usage — LLM 用量 ​

bash
python main.py usage summary --model gpt-4o
子命令HTTP路径关键参数
summaryGET/api/usage/summary--model

19. memory — 记忆诊断 ​

bash
python main.py memory writer-status --recent 30 --agent-id 1
子命令HTTP路径关键参数
writer-statusGET/api/memory/writer-status--recent --agent-id

20. learn — 框架文档 ​

子命令HTTP路径关键参数
docsGET/api/learn/docs-
docGET/api/learn/docs/{doc_key}doc_key

21. feedback — 主动消息评分 ​

子命令HTTP路径关键参数
proactivePOST/api/feedback/proactive--agent-id --rating(0/1) --decision-id --fired-at --signal-summary --action-category --act-score
statsGET/api/feedback/proactive/stats--agent-id

22. quick-inputs — 快捷输入 ​

子命令HTTP路径关键参数
listGET/api/quick-inputs-
addPOST/api/quick-inputs--text
usePOST/api/quick-inputs/{qid}/useqid
deleteDELETE/api/quick-inputs/{qid}qid

23. quick-ask — 快捷问答 ​

子命令HTTP路径关键参数
createPOST/api/quick_ask/dialogue--quoted-text
archivePOST/api/quick_ask/dialogue/{dialogue_id}/archivedialogue_id

24. draft — 文本分类草稿 ​

子命令HTTP路径关键参数
autoPOST/api/draft/from_text--text --agent-id
schedulePOST/api/draft/schedule_from_text--text --agent-id
todoPOST/api/draft/todo_from_text--text --agent-id

25. reports — 报告 ​

子命令HTTP路径关键参数
listGET/api/manager/reports-
by-agentGET/api/manager/reports/by-agent-
metaGET/api/manager/reports/meta-
contentGET/api/manager/reports/content--path
roll-upPOST/api/manager/reports/roll-up-
run-legacyPOST/api/manager/report--period

26. responses — OpenAI Responses API 代理 ​

子命令HTTP路径关键参数
proxyPOST/v1/responsesJSON body (--body-file/--body-json)
proxy-streamSSEPOST /v1/responsesJSON body (streaming)

27. dev — 开发端点 ​

子命令HTTP路径
fake-giftPOST/api/dev/fake_gift
gift-demoPOST/api/dev/gift_demo

28. gift — 礼物 v2 ​

子命令HTTP路径关键参数
videoGET/api/gift/video/{decision_id}decision_id --output
swapPOST/api/gift/swap--agent-id --dialogue-id --node-id --candidate-index --keyword
openPOST/api/gift/open--agent-id --dialogue-id --node-id
purchasePOST/api/gift/purchase--agent-id --dialogue-id --node-id

29. feishu — 飞书 ​

子命令HTTP路径关键参数
test-webhookPOST/api/feishu/test_webhook--webhook-url --title --content
webhookPOST/api/feishu/webhookJSON body

30. monitor — 消息监听 ​

bash
python main.py monitor list
python main.py monitor diag
python main.py monitor start wechat
python main.py monitor stop wechat
python main.py monitor settings-get
python main.py monitor file-roots
python main.py monitor file-roots-refresh --source wechat
子命令HTTP路径关键参数
listGET/api/monitor-
settings-getGET/api/monitor/settings-
settings-putPUT/api/monitor/settingsJSON body
file-rootsGET/api/monitor/file-roots-
file-roots-refreshPOST/api/monitor/file-roots/refresh--source(wechat/qq) --allow-ui-probe
diagGET/api/monitor/_diag-
startPOST/api/monitor/{monitor_id}/startmonitor_id
stopPOST/api/monitor/{monitor_id}/stopmonitor_id

31. skills — 技能 ​

bash
python main.py skills list
python main.py skills run 1 my_skill
python main.py skills stream run_abc123
python main.py skills agent-list 1
python main.py skills run-in-dialogue 1 my_skill --dialogue-id 3
python main.py skills doc my_skill
python main.py skills cancel-run run_abc123
子命令HTTP路径关键参数
listGET/api/skills-
cancel-runPOST/api/skills/runs/{run_id}/cancelrun_id
unschedulePOST/api/agents/{agent_id}/skills/{skill_id}/unscheduleagent_id skill_id
activeGET/api/skills/runs/active-
streamSSEGET /api/skills/runs/{run_id}/streamrun_id
agent-listGET/api/agents/{agent_id}/skillsagent_id
docGET/api/skills/{skill_id}/docskill_id
kbGET/api/agents/{agent_id}/knowledge-basesagent_id
runPOST/api/agents/{agent_id}/skills/{skill_id}/runagent_id skill_id
run-in-dialoguePOST/api/agents/{agent_id}/skills/{skill_id}/run_in_dialogueagent_id skill_id --dialogue-id --parent-id

32. skill-forge — 技能锻造 ​

子命令HTTP路径关键参数
proposePOST/api/skills/forge/from-dialogue/proposeJSON body
reproposePOST/api/skills/forge/from-dialogue/reproposeJSON body
summaryPOST/api/skills/forge/summaryJSON body
previewPOST/api/skills/forge/previewJSON body
revisePOST/api/skills/forge/revise--skill-md --user-guidance --skill-id
commitPOST/api/skills/forge/commit--skill-id --skill-md --scope(global/agent) --agent-id --overwrite

33. skill-workshop — 技能影棚 ​

子命令HTTP路径关键参数
listGET/api/skill_workshop/skills-
uploadPOST/api/skill_workshop/upload--file
asset-getGET/api/skill_workshop/asset--output
rewritePOST/api/skill_workshop/rewriteJSON body
runPOST/api/skill_workshop/runJSON body
statusGET/api/skill_workshop/run/{run_id}/statusrun_id
imagesGET/api/skill_workshop/run/{run_id}/imagesrun_id
regen-imagePOST/api/skill_workshop/run/{run_id}/regenerate_imagerun_id JSON body
approve-imagesPOST/api/skill_workshop/run/{run_id}/approve_imagesrun_id JSON body
clipsGET/api/skill_workshop/run/{run_id}/clipsrun_id
clip-genPOST/api/skill_workshop/run/{run_id}/clips/{idx}/generaterun_id idx JSON body
concat-finalPOST/api/skill_workshop/run/{run_id}/concat_finalrun_id JSON body
historyGET/api/skill_workshop/history/{skill_id}skill_id
history-runGET/api/skill_workshop/history/{skill_id}/{run_id}skill_id run_id

34. cg — CG 过场 ​

子命令HTTP路径关键参数
listGET/api/agents/manager/cg/list-
runPOST/api/agents/manager/cg/run--target-agent-id --target-skill-id --prompt
deleteDELETE/api/agents/{agent_id}/skills/{skill_id}/cgagent_id skill_id
skill-stateGET/api/skill_state-
previewPOST/api/agents/{agent_id}/skills/{skill_id}/cg/previewagent_id skill_id --seconds

35. asr — 语音识别 ​

子命令HTTP路径关键参数
transcribePOST/api/asr/transcribe--file --language
prewarmPOST/api/asr/prewarm-
call-prewarmPOST/api/call/prewarm--agent-id
dialog-prewarmPOST/api/dialog/prewarm-
focusPOST/api/focus/{mode}mode(dialog/call/idle) --agent-id --dialogue-id
gpu-tierGET/api/gpu_tier-
model-choicePOST/api/model_choice--model-id --choice(download/skip/never_prompt)

36. digital-human — 数字人 ​

子命令HTTP路径关键参数
statusGET/api/digital_human/{agent_id}/statusagent_id
prewarmPOST/api/digital_human/{agent_id}/prewarmagent_id
unloadPOST/api/digital_human/{agent_id}/unloadagent_id
regen-voicePOST/api/digital_human/{agent_id}/regenerate_voiceagent_id

37. phone-call — 电话通话 ​

子命令HTTP路径关键参数
statusGET/api/phone_call/{agent_id}/statusagent_id

38. recipes-library — Recipe 市场库 ​

子命令HTTP路径关键参数
listGET/api/recipes/library-
installPOST/api/recipes/library/install--library-id --overwrite
publishPOST/api/recipes/library/publish--recipe-id --channel --author --version

39. recipes — Recipe CRUD ​

bash
python main.py recipes list
python main.py recipes get my_recipe
python main.py recipes catalog
python main.py recipes create --body-file manifest.json
python main.py recipes bind my_recipe 1
python main.py recipes validate my_recipe --body-json '{"section":"manifest"}'
python main.py recipes dry-run my_recipe --prompt "你好" --mock-response "模拟回复"
python main.py recipes eval my_recipe --agent-id 1 --timeout 120
python main.py recipes export-zip my_recipe --output my_recipe.zip
python main.py recipes import-zip --file my_recipe.zip
子命令HTTP路径关键参数
catalogGET/api/recipes/catalog-
protocolGET/api/recipes/_meta/protocol-
listGET/api/recipes-
getGET/api/recipes/{recipe_id}recipe_id
export-zipGET/api/recipes/{recipe_id}/export_ziprecipe_id --output
import-zipPOST/api/recipes/import_zip--file
import-folderPOST/api/recipes/import_folderJSON body
createPOST/api/recipesJSON body
updatePUT/api/recipes/{recipe_id}recipe_id JSON body
deleteDELETE/api/recipes/{recipe_id}recipe_id
bindPOST/api/recipes/{recipe_id}/bind/{agent_id}recipe_id agent_id
unbindPOST/api/recipes/{recipe_id}/unbind/{agent_id}recipe_id agent_id
validatePOST/api/recipes/{recipe_id}/validaterecipe_id JSON body
chain-sourceGET/api/recipes/chain_source/{slot}slot
dry-runPOST/api/recipes/{recipe_id}/dry-runrecipe_id --prompt --mock-response
evalPOST/api/recipes/{recipe_id}/evalrecipe_id --agent-id --suite --max-cases --timeout --parallelism --save-baseline

40. agent-workshop — 外部 Agent 导入 ​

子命令HTTP路径关键参数
kindsGET/api/agent_workshop/kinds-
scanGET/api/agent_workshop/scan/{kind}kind
import-startPOST/api/agent_workshop/import/{kind}/startkind --need-digital-human --display-name --model
import-cancelPOST/api/agent_workshop/import/cancel--session-id
import-streamSSEGET /api/agent_workshop/import/{kind}/streamkind --session-id --approved-steps
customPOST/api/agent_workshop/custom--display-name --repo-url --cli-command --description --need-digital-human

41. agent-assets — Agent 资产管理 ​

子命令HTTP路径关键参数
upload-stagingPOST/api/agents/upload_staging--file --kind(figure/voice)
figure-job-startPOST/api/agents/{agent_id}/asset_job/figureagent_id --file
job-statusGET/api/agents/{agent_id}/asset_jobagent_id
job-streamSSEGET /api/agents/{agent_id}/asset_job/streamagent_id
job-retryPOST/api/agents/{agent_id}/asset_job/retryagent_id --stage
job-dismissDELETE/api/agents/{agent_id}/asset_jobagent_id
job-upload-stagePOST/api/agents/{agent_id}/asset_job/upload_stageagent_id --file --stage
voice-replacePOST/api/agents/{agent_id}/voice/replaceagent_id --file --transcript
greeting-regenPOST/api/agents/{agent_id}/greeting/regenerateagent_id

42. comm — 通信中心 ​

bash
python main.py comm messages --agent-id 1
python main.py comm post --body-json '{"agent_id":1,"content":"你好"}'
python main.py comm approvals-pending --agent-id 1
python main.py comm approval-respond --request-id req_abc --approved true --scope always
python main.py comm interrupt --agent-id 1 --reason "停!"
子命令HTTP路径关键参数
messagesGET/api/communication/messages--agent-id --since --direction(agent_to_user/user_to_agent)
postPOST/api/communication/messagesJSON body
sendPOST/api/communication/sendJSON body
approvals-pendingGET/api/communication/approvals/pending--agent-id
approval-requestPOST/api/communication/approvals/requestJSON body
approval-respondPOST/api/communication/approvals/respond--request-id --approved --reason --scope
approval-statusGET/api/communication/approvals/{request_id}request_id
interruptPOST/api/communication/interrupt--agent-id --reason

43. flows — Flow 实例 ​

bash
python main.py flows list --status running
python main.py flows get flow_abc123 --trace-tail 50
python main.py flows trace flow_abc123 --tail 100
python main.py flows cancel flow_abc123
子命令HTTP路径关键参数
listGET/api/flows--status --template-id --limit
getGET/api/flows/{instance_id}instance_id --trace-tail
traceGET/api/flows/{instance_id}/traceinstance_id --tail
cancelPOST/api/flows/{instance_id}/cancelinstance_id

44. 输出格式 ​

  • JSON 响应:默认单行 JSON。加 --pretty 美化输出。
  • SSE 流:每行一个 JSON 事件。[DONE] 表示流结束。
  • 文件下载:--output <path> 指定保存路径,默认输出 {ok, path, bytes} JSON。
  • 错误:HTTP ≥ 400 在 stderr 输出 ! HTTP <status>。

45. 典型用法 ​

bash
# 完整工作流:创建 agent → 绑定 recipe → 开始对话
python main.py agents create --agent-id 5
python main.py recipes bind medical_triage 5
python main.py chat stream --prompt "分析这个病例" --agent-id 5

# 监控管理
python main.py monitor list
python main.py monitor start wechat
python main.py monitor start qq

# 技能开发
python main.py skill-forge propose --body-file proposal.json
python main.py skill-forge preview --body-file draft.json
python main.py skill-forge commit --skill-id my_skill --skill-md "$(cat SKILL.md)" --scope global

# Broker 开发完整流程
python main.py broker keygen --name mykey
python main.py broker pack workspace/manager/brokers/my_broker
python main.py broker sign my_broker.broker.zip --author-key mykey
python main.py broker verify my_broker.broker.zip --pretty
python main.py broker publish workspace/manager/brokers/my_broker \
  --author-key mykey --relay https://api.familiars.cn

Familiars · 多 Agent AI 桌面应用