这里是项目的 docs/ 目录(文中统称 Docs)。如果你刚拿到代码,请从 GettingStart 开始;如果已经打开设置页,请使用 Settings 逐项手册。
| 阶段 | 先完成什么 | 文档 |
|---|---|---|
| 入门 | 启动后端与 WebUI,配置一个模型,完成第一轮对话 | GettingStart |
| 配置 | 理解 Provider、Preset、Node,设置 Companion | 模型与 Harness、预设与伴侣 |
| 工具与知识 | 添加资料目录,启用 Skill、工具和 MCP | 知识库、Skills、默认设置 |
| 协作 | 给多个 Agent 分工、创建依赖任务、检查交接 | 协作组指南 |
| 跨设备 | 打开远程 Board、授权协作、切换执行设备、同步节点 | 连接与同步 |
| 高级 | 编排事件、发布模型网关、审计运行 | 运行事件、网关、诊断 |
新手指南与 Settings 手册依据实际界面和源码编写。下列专题包含更深入的实现、适用条件和验证记录;其中的日期、模型名和测试成绩属于当时记录。
| 专题 | 文档 |
|---|---|
| 本地服务与模型 | 操作手册、实现与边界 |
| 节点长期记忆与对话压缩 | 设置方法、机制与来源 |
| Word / Excel 知识 | 使用流程、解析与计算合同 |
| Skill 管理与扩展 | 操作指南、来源与整理、编写 Skill / 插件 |
| Harness | 配置步骤、通用实现、OpenCode、Antigravity |
| Provider | 字段合同、授权存储、功能矩阵 |
| 图片与媒体 | OpenAI Images、网关图片、语音截图工具、语音错误隔离 |
| 桌面与命令执行 | Computer Use、命令会话、节点小窗 |
| 移动与协作组 | 协作组、移动组聊、定向协作 |
| 设备互联 | 用户操作、P2P 与鉴权中心部署、云端前端 |
| 远程执行 | Linux Worker 部署 |
| 节点同步 | 预览与提交、同步协议 |
| 启动与排错 | 启动修复、排错、节点打开诊断 |
- 架构概览:前后端、节点、Provider、工具与运行事件的职责。
- 配置合同:配置校验与错误处理。
- 能力系统:Tool、Skill、MCP、Plugin 的发现与装载。
- HTTP 传输:项目统一网络传输边界。
- 运行状态机:节点状态与恢复规则。
- 长期架构:后续演进设计;不应当作全部已实现功能。
测试报告、事故记录及历史验收文档保留在本目录及 benchmarks/ 下,供追溯使用。查看当前使用方法时优先从本索引和 Settings 手册进入。