文档索引 (Documentation Index)

OpenCode 学习文档的完整索引。


🚀 快速导航


📚 按学习阶段分类

🌱 入门 (Getting Started)

文档时间描述
快速入门30min从零开始,第一次对话
FAQ按需常见问题解答

📖 学习路径 (Learning Paths)

路径时间难度适合人群
路径 A: 快速了解1-2hPM/评估者
路径 B: 深入开发1-2天⭐⭐⭐工程师
路径 C: 扩展生态半天⭐⭐插件开发者

📦 按模块分类

架构与设计 (Architecture & Design)

文档难度描述
系统架构Monorepo 结构解析
ACP 协议⭐⭐编辑器集成协议
MCP 协议⭐⭐工具扩展协议
LSP 协议⭐⭐代码智能协议

核心包 (Core Packages)

文档难度优先级
opencode📄⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐
sdk📄⭐⭐⭐⭐⭐⭐⭐⭐
plugin📄⭐⭐⭐⭐⭐
console📄⭐⭐⭐⭐⭐
app📄⭐⭐⭐⭐⭐
desktop📄⭐⭐⭐⭐⭐
ui📄⭐⭐⭐⭐
slack📄⭐⭐
extensions📄⭐⭐
enterprise📄⭐⭐
web📄
util📄
function📄

内部模块 (Internals)

模块文档难度优先级
agent📄⭐⭐⭐⭐⭐⭐⭐⭐⭐
config📄⭐⭐⭐⭐⭐⭐⭐⭐
permission📄⭐⭐⭐⭐⭐⭐⭐⭐
session📄⭐⭐⭐⭐⭐⭐
snapshot📄⭐⭐⭐⭐⭐⭐
skill📄⭐⭐⭐⭐
share📄⭐⭐⭐⭐
pty📄⭐⭐⭐⭐⭐⭐
bus📄⭐⭐⭐⭐⭐
project📄⭐⭐⭐⭐⭐
tool📄⭐⭐⭐⭐⭐⭐⭐⭐⭐
cli📄⭐⭐⭐⭐⭐⭐
utilities📄

协议实现 (Protocol Implementations)

模块文档难度优先级
MCP 实现📄⭐⭐⭐⭐⭐⭐
LSP 实现📄⭐⭐⭐⭐⭐⭐
ACP 实现📄⭐⭐⭐⭐⭐⭐

关键流程 (Key Workflows)

流程文档难度描述
Agent 生命周期📄⭐⭐⭐从 Prompt 到 Code
状态同步📄⭐⭐⭐实时更新机制
插件加载📄⭐⭐插件系统流程
工具执行📄⭐⭐⭐⭐工具调用详解
权限流程📄⭐⭐⭐权限检查机制
快照回滚📄⭐⭐Git 变更追踪
错误处理📄⭐⭐错误恢复策略

集成与生态 (Integrations)

集成文档难度
VS Code📄⭐⭐
GitHub Action📄⭐⭐

实战案例 (Cookbook)

案例文档难度时间
创建自定义 Agent📄20min
集成 MCP Server📄⭐⭐30min
调试会话问题📄⭐⭐20min

🔍 按关键词索引

A

C

E

M

P

S

T


📊 文档统计

类别文档数量总字数
入门指南2~15,000
学习路径1~5,000
架构设计4~20,000
核心包12~30,000
内部模块10~25,000
关键流程7~20,000
集成2~5,000
实战案例3~15,000
总计41~135,000

🎯 学习建议

第一次学习?

  1. 👉 快速入门 (30min)
  2. 👉 学习路径 A (1-2h)
  3. 👉 Cookbook - 案例 01 (20min)

想要深入开发?

  1. 👉 学习路径 B (1-2天)
  2. 👉 核心包 - opencode (必读)
  3. 👉 内部模块 - Agent (必读)

想要扩展生态?

  1. 👉 学习路径 C (半天)
  2. 👉 Cookbook (实战案例)
  3. 👉 插件系统 (核心)

🔧 文档模板

需要创建新文档?参考:


💬 获取帮助


准备好开始学习了? 👉 快速入门