DotCraft 文档索引
按目标选择文档。第一次使用建议先走 快速开始，完成 Desktop、工作区和模型配置后，再进入日常使用、自动化或开发集成。
我是第一次使用
| 目标 | 推荐文档 |
|---|---|
| 下载 Desktop、初始化工作区、配置 API Key、第一次运行 | 快速开始 |
| 使用图形化桌面客户端 | Desktop 指南 |
| 在终端里使用完整界面 | TUI 指南 |
| 配置 API Key、模型、Endpoint 和工作区覆盖 | 配置指南 |
我想日常使用和排查
| 目标 | 推荐文档 |
|---|---|
| 查看 Trace、会话、工具调用和可视化配置 | Dashboard 指南 |
| 理解设置何时生效、哪些需要重启 | 设置生效层级指南 |
| 安装、启用、试用或移除 DotCraft 插件 | 安装和使用插件 |
| 让 Agent 创建、修补和维护工作区 skill | Agent Skill 自学习 |
| 搜索本地 skills，并从 SkillHub / ClawHub 安装第三方 skills | Skills 搜索与安装 |
| 限制文件、Shell、网络和沙箱能力 | 安全配置 |
| 配置 SubAgent role、profile 和递归深度 | SubAgent 配置指南 |
我想运行自动化或扩展工作流
| 目标 | 推荐文档 |
|---|---|
| 本地任务、Cron 选择和人工审核 | Automations 指南 |
| Automations 字段、模板变量和工具 | Automations 参考 |
| 生命周期事件钩子和 Shell 扩展 | Hooks 指南 |
| Hook 事件、payload、退出码和示例 | Hooks 参考 |
| 准备本地 plugin manifest 和 plugin-contained skills | 创建插件 |
| 用外部 coding agent CLI 作为子代理 | External CLI 子代理指南 |
我想接入客户端或编辑器
| 目标 | 推荐文档 |
|---|---|
| 让 JetBrains、Obsidian、Unity 等编辑器接入 DotCraft | ACP 模式指南 |
| 使用 Unity 编辑器扩展和场景资源工具 | Unity 集成指南 |
| 使用 Hub 管理本机工作区运行时和可视化入口 | Hub 本地管理指南 |
| 运行 Wire Protocol 服务、多客户端共享工作区 | AppServer 模式指南 |
| 实现本地 Hub client，发现和托管工作区 AppServer | Hub Protocol |
| 实现 AppServer JSON-RPC client | AppServer Protocol |
| 暴露 OpenAI-compatible HTTP API | API 模式指南 |
| 接入 AG-UI / CopilotKit 前端 | AG-UI 模式指南 |
我想构建机器人、SDK 或外部适配器
| 目标 | 推荐文档 |
|---|---|
| 选择 Python 或 TypeScript SDK | SDK 总览 |
| 使用 Python 构建外部渠道 | Python SDK |
| 参考 Telegram Python 适配器 | Python Telegram Adapter |
| 使用 TypeScript 构建外部频道模块 | TypeScript SDK |
| 接入 QQ / 企业微信 / 飞书 / Telegram / 微信 | QQ · WeCom · Feishu · Telegram · Weixin |
我想查参考信息
| 目标 | 推荐文档 |
|---|---|
| 查看完整配置字段 | 完整配置参考 |
| 查看插件架构、manifest 和 Plugin Function 设计 | Plugin Architecture Spec |
| 查看 Hub 本地管理协议 | Hub Protocol |
| 查看 AppServer 协议开发指南 | AppServer Protocol |
| 查看 Dashboard API 和 Trace 事件 | Dashboard API |
| 使用完整示例验证功能 | Samples 总览 |
| 准备工作区模板 | Workspace Sample |
| 查看 AppServer 完整协议规格 | AppServer Protocol Spec |
故障排查
搜索 Desktop 没有找到下载入口
打开 快速开始 或 Desktop 指南。
不确定配置应该放全局还是工作区
API Key 放全局 ~/.craft/config.json；项目特定模型、工具、入口和自动化配置放 <workspace>/.craft/config.json。
想贡献文档
文档要求中英文同步：中文在 docs/*.md，英文在 docs/en/*.md。中文页使用“快速开始 / 配置 / 使用示例 / 进阶 / 故障排查”，英文页使用 “Quick Start / Configuration / Usage Examples / Advanced Topics / Troubleshooting”。