botmux 知识库内容目录。每个 wiki 页面按类型列出，附一行摘要。 阅读此文件以快速定位相关页面。 Last updated: 2026-08-10 | Total pages: 44
docs/ — 官方文档整理
入门与核心概念
- overview — 产品定位、解决的三类问题、直接桥接 CLI 不做 SDK wrapper 的核心理念、20+ 适配器及与 Agent SDK 方案的边界对比
- quickstart — 前置条件、安装、botmux setup 扫码建应用向导、启动验证与 headless 自查
- architecture — 官方架构说明：daemon/worker/CLI 三层进程模型、模块结构表、五步数据流与 tmux 后端解耦
- session-model — 消息落到哪个会话：三种群形态、Oncall/chat-scope 群、/group 建群、会话状态机与三层权限模型
核心交互
- cards — 实时流式卡片：xterm 无头截图还原 TUI、状态色、卡片操作、每轮冻结存档与打断快捷键
- web-terminal — 每会话自带 xterm.js Web 终端，只读/可操作双链接、移动端快捷键与远程访问配置
- slash-commands — 会话内斜杠命令完整参考：daemon 拦截语义、透传白名单、全命令分组
- session-handoff — /adopt 零打扰桥接本机 tmux CLI 进飞书，/relay 会话跨群搬家上下文接续
- tmux — tmux 默认后端使 CLI 进程常驻，daemon 重启不丢上下文（re-attach 而非冷启）
多 Bot 协作与编排
- multi-bot — 同群多机器人各绑不同 CLI，@mention 路由、bots list 自动发现与 —mention 接力
- multi-topic — 主 bot 拆任务、开多话题派 bot 组并行干活，飞书任务清单当共享进度板
- workflow — v3 即兴 workflow 自然语言拆 DAG（grill/Gate/并发/人机协作卡片）与 Saved Workflow 复用
- roles — /role 两级人设、Role Profile 复用集、能力标签花名册、跨部署团队面板与角色切换
- whiteboard — 按群共享的 markdown 状态白板，多 bot/会话共享项目上下文，CAS 乐观并发写入
场景功能
- schedule — 自然语言/斜杠命令/对话三种方式创建定时任务，到点在原话题续消息执行
- external-trigger — Webhook 接入点（令牌/HMAC 校验、三种投递目标）与 API 任务触发（四态轮询、幂等键）
- oncall — 值班/报警群绑定项目目录后全群成员可 @ 提问，三种开启方式与权限分层
- voice — 回复卡片一键转语音消息，SAMI 或 OpenAI 兼容 TTS 引擎配置与按 bot 覆盖
- sandbox — overlayfs 写隔离（写隔离/原生读/零拷贝），owner 经 /land diff 卡片审阅后落盘
- dashboard — 轮换式 token URL 登录的浏览器管控面与对外只读观测接口
- doc-comment — /watch-comment：把飞书云文档评论变成会话输入输出通道
配置参考
- bots-json — ~/.botmux/bots.json 完整字段参考（必填/CLI 与模型/cliRuntime/env/权限/沙盒/卡片等分组）
- adapters — 25 个 CLI/Agent 适配器的 cliId 清单、MCP Bridge 接入与 wrapper/网关四步接入法
- env — ~/.botmux/.env 机器级环境变量与 ~/.botmux/ 关键文件位置速查
- cli-commands — botmux 终端管理命令（setup/start/restart/list/delete/dashboard/autostart）
- hooks — 生命周期 hooks：配置优先级、9 种事件、stdin payload 与截断规则
扩展系统
- plugins — 一个 npm 包交付 Skill/MCP/CLI/Dashboard/Host Service 五种扩展点：加载、manifest、MCP 聚合、生命周期
- skill-cli — CLI 会话内经 ~/.botmux/bin wrapper 获得 send/history/bots 等命令，skillInjection 注入机制
- api-core-only — botmux serve —api-only headless 嵌入式 API：就绪契约、三层鉴权、HMAC 签名与 no-transport 加固
- zmx — 显式 opt-in 的可选持久会话后端（zmx≥0.7.0），tail/send/history 无 leader 最终一致屏幕
实践
- best-practices — oncall/报警运维/个人研发/多人协作四类场景推荐配置与三端协同通用建议
- faq — FAQ 与踩坑合并按主题归类：机器人不回复症状分流、权限/发版、tmux 持久性与三步排查法
src/ — 源码分析
架构与进程
- architecture-overview — 三层进程模型（bot→daemon、会话→worker、CLI 进程）、五个入口、src/ 十四个子目录职责地图
- daemon-worker — daemon 启动卫生与事件分发入口、worker-pool fork 与 IPC 消息暂存、worker 七步生命周期与空闲回收
- cli — cli.ts argv switch 分发结构与 src/cli/ 34 个辅助模块的命令-文件对照
消息与卡片
- im-routing — event-dispatcher 长连接入口与 ACK 去重、消息→bot→会话分发链路、话题群路由判定
- card-streaming — CLI 输出经 screen_update/截图上报、daemon POST/PATCH 决策与 latest-wins 节流的卡片流水线
适配器
- adapters — CliAdapter（25 个 CLI 的能力面）与 SessionBackend（六种会话后端）双接口架构、registry 与 cliRuntime
- cloud-agents — 非 TUI 接入两族：runner 型适配器（mira/mir/codex-app）与 codex 混合 RPC 引擎
编排与管控
- workflow-engine — v3 Workflow DAG 引擎：JSON schema、orchestrator/runtime 分层、journal+STATE、run 生命周期与存储
- dashboard — Dashboard 独立进程 + React 19 前端：SSE 聚合多 daemon、REST+SSE 通信、publicReadOnly 认证与构建流程
安装与注入
- setup-flow — setup TUI/脚本化双模式、飞书应用三种扫码创建路径、权限-事件-发版自动化管线与 scopes 清单
- skills — 内置 11+2 个桥接技能与三通道投递机制（—plugin-dir 注入 / skillsDir 三模式 / spawn 清理）
- vc-agent — 飞书会议智能体：双事件源、转写稳定窗口状态机、会中卡片、protobuf 语音通道与 CLI 子命令