快速上手

启动 TUI

cd your-project
opencode

也可指定目录:

opencode /path/to/project

第一步:连接模型

若尚未配置 Provider,在 TUI 输入:

/connect

完成 API Key 配置后再继续。


第二步:初始化项目

/init

OpenCode 会分析项目并在根目录生成 AGENTS.md,描述结构、约定与常用命令。这是后续 Agent 的持久上下文,与 Codex / Cursor 等工具采用的 AGENTS.md 标准 一致。


Plan 与 Build 模式

OpenCode 的两个主 Agent 对应两种工作方式:

模式Agent行为
PlanPlan默认禁止写文件、跑 bash;适合方案设计
BuildBuild全工具可用;适合落地实现

切换方式:Tab 键(右下角显示当前模式)。

推荐工作流:先 Plan 后 Build

  1. 切到 Plan,描述需求:
我们要给笔记应用增加「软删除」:删除时标记 deleted,并新增「最近删除」页面支持恢复或永久删除。
  1. 审阅 Agent 给出的步骤,补充细节(可拖入截图):
UI 参考我上传的截图,列表样式与现有 Notes 页一致。
  1. Tab 切回 Build
方案没问题,请开始实现,并跑测试验证。

提问与 @ 引用

解释代码

@packages/functions/src/api/index.ts 里认证是怎么做的?

@ 可引用文件或目录,缩小上下文范围。

直接改代码(跳过 Plan)

参考 @packages/functions/src/notes.ts 的鉴权方式,在 @packages/functions/src/settings.ts 实现相同逻辑。

撤销与重做

改错了可以用 slash 命令:

/undo

恢复被撤销的改动:

/redo

分享会话

/share

生成当前对话链接并复制到剪贴板,便于团队协作(注意勿分享敏感代码)。


非交互:opencode run

适合脚本与 CI:

opencode run "列出 src 目录下所有 TODO 注释" -m anthropic/claude-haiku-4-5

常用标志(以 opencode run --help 为准):

  • -m / --model:指定模型
  • -f:附加文件上下文

Bash 快捷方式

在 TUI 输入框中以 ! 开头可直接跑 shell,例如:

!npm test

第一个完整任务清单

  1. cd 到仓库根目录
  2. opencode 启动 TUI
  3. /connect 配置 Provider
  4. /init 生成 AGENTS.md
  5. Tab → Plan,描述小功能
  6. Tab → Build,执行实现
  7. !git diff/undo 审查变更
  8. 人工 git commit

下一步