如何安裝並使用 OpenCode:裝 CLI/TUI、登入或 API Key、第一次倉庫任務
安裝 OpenCode CLI/TUI,接上金鑰,再在真實倉庫跑完第一次任務。
你要的是在終端裡裝一個能讀倉庫、能改檔案的開源代理,而不是再開一個網頁聊天視窗。
這篇依官方文件走完 如何安裝並使用 OpenCode:裝 CLI/TUI,用 /connect 或 opencode auth login 登入或貼上 API Key,再在真實倉庫完成第一次任務。步驟以 opencode.ai/docs 的 Intro、Providers 與 CLI 頁為準。
它適合誰、不適合誰
OpenCode 是開源終端代理:無參數執行 opencode 即進入 TUI,也可用 CLI。官方也提到桌面與 IDE 擴充,本文只走終端。第一次需要現代終端模擬器,外加一把可用的模型金鑰。
對著真實倉庫
先 cd 到你真正維護的專案。第一次問三要點或一個可加測試,而不是整倉重構。
金鑰走鑑權檔,不走提示詞
官方把提供方金鑰存在 ~/.local/share/opencode/auth.json。TUI 用 /connect,CLI 用 opencode auth login。不要把金鑰貼進對話。
先初始化再改檔
/init 會分析專案並寫出 AGENTS.md,官方建議提交。小改動可直接 Build;更大功能先用 Tab 切到 Plan 模式。
安裝、鑑權、第一次任務
-
1
安裝 CLI 並打開 TUI
在 macOS/Linux/WSL 執行
curl -fsSL https://opencode.ai/install | bash,或npm install -g opencode-ai,或brew install anomalyco/tap/opencode(官方較推薦 anomalyco tap)。Windows 原生可用 Chocolatey、Scoop 或 npm,完整能力更建議 WSL。裝完執行opencode --version,再執行opencode進入 TUI。 -
2
登入或新增 API Key
在 TUI 輸入
/connect:新手可選 OpenCode Zen,到 opencode.ai/auth 登入、填寫帳單並貼上金鑰;也可選 OpenAI、Anthropic 等其他提供方。等價 CLI:opencode auth login。用opencode auth list確認。金鑰也可來自環境變數或專案.env。 -
3
在倉庫裡跑第一次任務
cd到專案後執行opencode,先/init產生AGENTS.md。第一次提問例如「用三條要點說明倉庫結構,並建議一個可加的小測試」。小編輯只改一行註解並保持行為不變。看完 diff 再接受。可用/undo。腳本場景用opencode run。
curl -fsSL https://opencode.ai/install | bash
# or: npm install -g opencode-ai
# or: brew install anomalyco/tap/opencode
opencode --version
# Auth (pick one):
# In the TUI: /connect → provider or OpenCode Zen → paste API key
# CLI: opencode auth login
# Check: opencode auth list
# Keys live in ~/.local/share/opencode/auth.json (do not commit)
cd /path/to/your/repo
opencode
# In the TUI: /init → writes AGENTS.md (ok to commit)
# First task: Explain the repo layout in three bullets and name one small test I can add
# Small edit: Add a one-line comment to the main entry file; do not change behavior
# Undo: /undo
# Non-interactive alternative:
# opencode run "Explain README.md in three bullets and suggest one small test"
第一次容易卡住的地方
| 方式 | 帳單 | 更適合 |
|---|---|---|
| 安裝腳本 / npm / brew | 工具本身開源 | 本機第一次裝 CLI |
| OpenCode Zen 或提供方 API Key | Zen 帳單或各家 Platform 價 | 雲端讀倉與改檔 |
| 環境變數 / 專案 .env | 同提供方計費 | CI 或不想寫進 auth.json |
- TUI 花屏或快捷鍵失靈
- 官方要求較新的終端,如 WezTerm、Alacritty、Ghostty、Kitty。系統內建終端若渲染差,先換模擬器再查模型。
- 把 auth.json 當密碼本
- 預設在
~/.local/share/opencode/auth.json。不要拷進公開倉庫。若金鑰已進 Git,到對應主控台輪換。 - Windows 功能不全
- 官方建議用 WSL 取得完整相容。Chocolatey / Scoop / npm 可裝原生二進位,但體驗以文件 Windows 節為準。
官方提醒:API 按供應商或 Zen 計費。第一次用便宜模型摸 /init 與 /undo,再換到你真正要付的模型。
改完要和人對著看時
代理改完常缺一張圖。可在tidemeet用瀏覽器開短時空間,或看如何建立空間。畫布見共享白板基礎。同站見Aider與Codex CLI。
還有疑問?
必須使用 OpenCode Zen 嗎?
不必。Zen 是文件給新手的策劃模型清單。/connect 也可選其他提供方,或走 opencode auth login。以 Providers 頁為準。
AGENTS.md 要提交嗎?
官方建議提交,好讓代理記住專案結構與習慣。不要把金鑰寫進這個檔。
第一次該開 Plan 模式嗎?
小改動可直接在 Build 裡做。較大功能用 Tab 切到 Plan(此時不會改檔),談妥再切回 Build。
和臨時協作工具有什麼關係?
沒有產品綁定。只是要對著 diff 講兩句時,臨時會議工具對比說明何時用短時瀏覽器空間即可。