Droid 文档
安装、配置和使用 Droid,以及参与项目开发的参考文档。
Droid 是 Factory Droid CLI 的非官方 VS Code / Cursor 扩展。 扩展将对话、任务执行、模型配置与代码审阅集中到编辑器中。以下按使用与开发两条路径组织。
配图来自 v0.8.10 产品图集,保留采集版本与演示数据说明; 当前使用方法以正文和安装版本为准。
使用 Droid
第一次使用按 安装 → 配置模型 → 开始对话 → 审阅修改 阅读。 补全使用独立服务,可以在需要时再配置。
| 你要完成的事 | 指南 | 读完可以做什么 |
|---|---|---|
| 安装插件并连接本机 CLI | 安装与第一次对话 | 安装 VSIX,确认环境,发送第一条消息 |
| 使用自己的 API Key | 模型与服务渠道 | 区分渠道与模型,管理别名及启停 |
| 读回复、查看工具,临时追问 | 聊天与 BTW 旁问 | 引用上下文、带图提问、跟进执行过程 |
| 检查 AI 修改了什么 | 审阅文件改动 | 选择比较范围,查看 Diff,判断撤销条件 |
| 手动写代码时获得建议 | 代码补全与 Next Edit | 配置服务,接受续写或跳到下一处编辑 |
| 跟进并行或长任务 | 子代理与 Mission | 打开子会话,查看 Worker 与任务状态 |
| 连接失败、正文停住或状态异常 | 排障与诊断 | 确认任务状态,定位日志,提供复现信息 |
参与开发
建议先跑起本地预览,再沿一次发送阅读代码。接着看状态归属和恢复流程,最后进入所改功能的细节。
| 顺序 | 阅读入口 | 解决的问题 |
|---|---|---|
| 01 · 跑起来 | 环境与本地启动 | 哪些依赖必须安装,怎样区分模拟预览和真实会话 |
| 02 · 找到位置 | 第一个修改 | 改控件、业务交互、SDK 行为分别从哪里开始 |
| 03 · 跟一次请求 | 发送调用链 | 输入怎样到达 Droid,事件怎样返回页面 |
| 04 · 理解恢复 | 状态归属 · 会话恢复 | 什么是事实,什么能重建,哪些操作不能重放 |
| 05 · 处理故障 | 定位与复现 | 先查哪一层,怎样描述触发顺序和预期结果 |
| 06 · 交付修改 | 验证与提交 · 构建与发布 | 验证什么、打包什么、哪些步骤会公开产物 |
代码分为哪些部分
flowchart LR
UI[公共 UI 组件] --> View[Webview 业务适配]
View <-->|Bridge 消息| Host[Extension Host]
Host <-->|Runtime 接口| SDK[Droid CLI / SDK]
Host --> Completion[独立补全服务]
公共控件、Markdown 和 Diff 展示在 packages/chat-ui/;Droid 业务页面与状态在 src/webview-v2/。 Host 管理编辑器、会话和文件,Runtime 负责适配 Droid。代码补全走独立请求路径。 完整目录职责与消息流见 架构文档,公共组件接入见 chat-ui 文档。
怎样阅读能力与状态
| 文档中的表述 | 含义 |
|---|---|
| 已接入 / 当前实现 | 源码存在对应调用链;不表示每个平台、模型或异常路径都已验收 |
| 依赖 CLI / 模型 / daemon | 需要当前环境提供能力;插件界面本身不能补齐后端支持 |
| 已构建 / 已测试 / 已安装 | 各自只说明对应的验证结果,不能相互替代 |
| 计划 / 待验收 | 尚不能作为已交付能力使用 |
网站文档跟随仓库源码,安装包以 Releases 中的版本说明为准。具体功能边界查看 能力矩阵。
维护者参考
| 需要维护的内容 | 唯一入口 |
|---|---|
| 当前实现与验证缺口 | STATUS |
| 下一步工作与优先级 | PLAN |
| 交互、样式与设计约束 | DESIGN |
| 让已有界面更简单、紧凑、实用 | 界面整改 skill · 模型选择器案例 |
| 按版本记录变化 | CHANGELOG |
| 开发、测试、提交与安装规则 | AGENTS |
维护文档采用当前快照:STATUS 只写当前版本、交付和验证缺口;PLAN 只留待办; DESIGN 只留仍有效的交互约定。修改对应小节,不按日期不断追加施工记录。 短期调查、旧计划、构建流水和推广草稿从 Git 历史查阅,不另建归档副本。 文档与源码冲突时先核对相关生产入口;不因超过一两天就删除仍有效的使用说明和架构边界。
文档网站直接构建这些 Markdown,不维护第二套正文。修改页面、导航和部署的方式见 维护文档网站。新增说明优先放回对应文档,不追加临时调研或交接文件。