CLI

CLI

OpenCode CLI のオプションとコマンド。

OpenCode CLI はデフォルトでパラメータなしで実行すると TUI ターミナルユーザーインターフェースを起動します。

opencode

また、以下のドキュメントに記録されているコマンドを受け入れ、プログラム的な対話も可能です。

opencode run "Explain how closures work in JavaScript"

---

tui

OpenCode ターミナルユーザーインターフェースを起動します。

opencode [project]

Flags

Flag	Short	Description
--continue	-c	Continue the last session
--session	-s	Session ID to continue
--fork	-	Fork the session when continuing
--prompt	-	Prompt to use
--model	-m	Model to use in the form of provider/model
--agent	-	Agent to use
--port	-	Port to listen on
--hostname	-	Hostname to listen on
--mdns	-	Enable mDNS discovery
--mdns-domain	-	Custom mDNS domain name
--cors	-	Additional browser origin(s) to allow CORS

---

Commands

OpenCode CLIには以下のコマンドもあります。

---

agent

OpenCode のエージェントを管理します。

opencode agent [command]

create

カスタム設定で新しいエージェントを作成します。

opencode agent create

このコマンドは、カスタムシステムプロンプトと権限設定で新しいエージェントを作成するプロセスを案内します。許可しないものは、生成されたエージェントの frontmatter で拒否されます。

Flag	Short	Description
--path	-	Directory to write the agent file to
--description	-	What the agent should do
--mode	-	Agent mode: all, primary, or subagent
--permissions	-	Comma-separated list of permissions to allow
--model	-m	Model to use, in provider/model format

利用可能な権限：bash、read、edit、glob、grep、webfetch、task、todowrite、websearch、lsp、skill。

list

利用可能なすべてのエージェントを一覧表示します。

opencode agent list

---

attach

serve または web コマンドで既に実行中の OpenCode バックエンドサーバーにターミナルを接続します。

opencode attach [url]

これにより、リモートの OpenCode バックエンドで TUI を使用できます。

# Start the backend server for web/mobile access
opencode web --port 4096 --hostname 0.0.0.0
# In another terminal, attach the TUI to the running backend
opencode attach http://10.20.30.40:4096

Flag	Short	Description
--dir	-	Working directory to start TUI in
--continue	-c	Continue the last session
--session	-s	Session ID to continue
--fork	-	Fork the session when continuing
--password	-p	Basic auth password
--username	-u	Basic auth username

---

auth

Provider の認証情報とログインを管理するコマンドです。

opencode auth [command]

login

OpenCode は Models.dev の Provider リストで動作するため、opencode auth loginを使用して任意の Provider の API キーを設定できます。認証情報は ~/.local/share/opencode/auth.json に保存されます。

opencode auth login

Flag	Short	Description
--provider	-p	Provider ID or name to log in to
--method	-m	Login method label to use

list

認証情報ファイルに保存されているすべての認証済み Provider を一覧表示します。

opencode auth list
# Or the short version
opencode auth ls

logout

認証情報ファイルから削除して Provider からログアウトします。

opencode auth logout

---

github

リポジトリ自動化用の GitHub エージェントを管理します。

opencode github [command]

install

リポジトリに GitHub エージェントをインストールします。

opencode github install

これにより、必要な GitHub Actions ワークフローが設定され、構成プロセスが案内されます。

run

GitHub エージェントを実行します。これは通常 GitHub Actions で使用されます。

opencode github run

Flag	Description
--event	GitHub mock event to run the agent for
--token	GitHub personal access token

---

mcp

Model Context Protocol サーバーを管理します。

opencode mcp [command]

add

設定に MCP サーバーを追加します。

opencode mcp add

list

設定されたすべての MCP サーバーとその接続状態を一覧表示します。

opencode mcp list
# Or the short version
opencode mcp ls

auth

OAuth 対応の MCP サーバーでの認証を行います。

opencode mcp auth [name]

OAuth 対応サーバーの一覧：

opencode mcp auth list
# Or the short version
opencode mcp auth ls

logout

MCP サーバーの OAuth 認証情報を削除します。

opencode mcp logout [name]

debug

MCP サーバーの OAuth 接続の問題をデバッグします。

opencode mcp debug <name>

---

models

設定された Provider からすべての利用可能なモデルを一覧表示します。

opencode models [provider]

このコマンドは、構成されたすべての Provider で利用可能なモデルを provider/model 形式で表示します。

opencode models anthropic

Flag	Description
--refresh	Refresh the models cache from models.dev
--verbose	Use more verbose model output (includes metadata like costs)

---

run

プロンプトを直接渡して非インタラクティブモードで opencode を実行します。

opencode run [message..]

opencode run Explain the use of context in Go

実行中の opencode serve インスタンスに接続することもできます：

# Start a headless server in one terminal
opencode serve
# In another terminal, run commands that attach to it
opencode run --attach http://localhost:4096 "Explain async/await in JavaScript"

Flag	Short	Description
--command	-	The command to run, use message for args
--continue	-c	Continue the last session
--session	-s	Session ID to continue
--fork	-	Fork the session when continuing
--share	-	Share the session
--model	-m	Model to use in the form of provider/model
--agent	-	Agent to use
--file	-f	File(s) to attach to message
--format	-	Format: default (formatted) or json (raw JSON events)
--title	-	Title for the session
--attach	-	Attach to a running opencode server
--password	-p	Basic auth password
--username	-u	Basic auth username
--dir	-	Directory to run in, or path on the remote server when attaching
--port	-	Port for the local server
--variant	-	Model variant (provider-specific reasoning effort)
--thinking	-	Show thinking blocks
--dangerously-skip-permissions	-	Auto-approve permissions (dangerous!)

---

serve

API アクセス用のヘッドレス OpenCode サーバーを起動します。

opencode serve

これにより、TUI インターフェースなしで opencode 機能への API アクセスを提供する HTTP サーバーが起動します。HTTP Basic 認証を有効にするには OPENCODE_SERVER_PASSWORD を設定します。

Flag	Description
--port	Port to listen on
--hostname	Hostname to listen on
--mdns	Enable mDNS discovery
--mdns-domain	Custom mDNS domain name
--cors	Additional browser origin(s) to allow CORS

---

session

OpenCode セッションを管理します。

opencode session [command]

list

すべての OpenCode セッションを一覧表示します。

opencode session list

Flag	Short	Description
--max-count	-n	Limit to N most recent sessions
--format	-	Output format: table or json

delete

OpenCode セッションを削除します。

opencode session delete <sessionID>

---

stats

OpenCode セッションのトークン使用量とコスト統計を表示します。

opencode stats

Flag	Description
--days	Show stats for the last N days
--tools	Number of tools to show
--models	Show model usage breakdown
--project	Filter by project

---

export

セッション情報を JSON としてエクスポートします。

opencode export [sessionID]

Flag	Description
--sanitize	Redact sensitive transcript/file data

---

import

JSON ファイルまたは OpenCode 共有 URL からセッション情報をインポートします。

opencode import <file>

opencode import session.json
opencode import https://opncd.ai/s/abc123

---

web

Web インターフェース付きのヘッドレス OpenCode サーバーを起動します。

opencode web

Flag	Description
--port	Port to listen on
--hostname	Hostname to listen on
--mdns	Enable mDNS discovery
--mdns-domain	Custom mDNS domain name
--cors	Additional browser origin(s) to allow CORS

---

acp

ACP (Agent Client Protocol) サーバーを起動します。

opencode acp

このコマンドは、stdin/stdout 経由で nd-JSON を使用して通信する ACP サーバーを起動します。

Flag	Description
--cwd	Working directory
--port	Port to listen on
--hostname	Hostname to listen on
--mdns	Enable mDNS discovery
--mdns-domain	Custom mDNS domain name
--cors	Additional browser origin(s) to allow CORS

---

plugin

プラグインをインストールして設定を更新します。

opencode plugin <module>
# Or use the alias
opencode plug <module>

Flag	Short	Description
--global	-g	Install in global config
--force	-f	Replace existing plugin version

---

pr

GitHub PRブランチを取得してチェックアウトし、OpenCode を実行します。

opencode pr <number>

---

db

データベースクエリツール。

opencode db [query]

Flag	Description
--format	Output format: json or tsv

path

データベースファイルパスを表示します。

opencode db path

---

debug

デバッグとトラブルシューティングツール。

opencode debug [command]

---

uninstall

OpenCode をアンインストールして関連するすべてのファイルを削除します。

opencode uninstall

Flag	Short	Description
--keep-config	-c	Keep configuration files
--keep-data	-d	Keep session data and snapshots
--dry-run	-	Show what would be removed without removing
--force	-f	Skip confirmation prompts

---

upgrade

opencode を最新バージョンまたは特定のバージョンに更新します。

opencode upgrade
# Or a specific version
opencode upgrade v0.1.48

Flag	Short	Description
--method	-m	The installation method that was used; curl, npm, pnpm, bun, brew

---

Global Flags

opencode CLI は以下のグローバルフラグを受け入れます。

Flag	Short	Description
--help	-h	Display help
--version	-v	Print version number
--print-logs	-	Print logs to stderr
--log-level	-	Log level (DEBUG, INFO, WARN, ERROR)
--pure	-	Run without external plugins

---

Environment variables

OpenCode は環境変数を使用して設定できます。

Variable	Type	Description
OPENCODE_AUTO_SHARE	boolean	Automatically share sessions
OPENCODE_GIT_BASH_PATH	string	Path to Git Bash executable on Windows
OPENCODE_CONFIG	string	Path to config file
OPENCODE_TUI_CONFIG	string	Path to TUI config file
OPENCODE_CONFIG_DIR	string	Path to config directory
OPENCODE_CONFIG_CONTENT	string	Inline json config content
OPENCODE_DISABLE_AUTOUPDATE	boolean	Disable automatic update checks
OPENCODE_DISABLE_PRUNE	boolean	Disable pruning of old data
OPENCODE_DISABLE_TERMINAL_TITLE	boolean	Disable automatic terminal title updates
OPENCODE_PERMISSION	string	Inlined json permissions config
OPENCODE_DISABLE_DEFAULT_PLUGINS	boolean	Disable default plugins
OPENCODE_DISABLE_LSP_DOWNLOAD	boolean	Disable automatic LSP server downloads
OPENCODE_ENABLE_EXPERIMENTAL_MODELS	boolean	Enable experimental models
OPENCODE_DISABLE_AUTOCOMPACT	boolean	Disable automatic context compaction
OPENCODE_DISABLE_CLAUDE_CODE	boolean	Disable reading from .claude
OPENCODE_DISABLE_CLAUDE_CODE_PROMPT	boolean	Disable reading ~/.claude/CLAUDE.md
OPENCODE_DISABLE_CLAUDE_CODE_SKILLS	boolean	Disable loading .claude/skills
OPENCODE_DISABLE_MODELS_FETCH	boolean	Disable fetching models from remote sources
OPENCODE_DISABLE_MOUSE	boolean	Disable mouse capture in the TUI
OPENCODE_FAKE_VCS	string	Fake VCS provider for testing purposes
OPENCODE_CLIENT	string	Client identifier (defaults to cli)
OPENCODE_ENABLE_EXA	boolean	Enable Exa web search tools
OPENCODE_SERVER_PASSWORD	string	Enable basic auth for serve/web
OPENCODE_SERVER_USERNAME	string	Override basic auth username (default opencode)
OPENCODE_MODELS_URL	string	Custom URL for fetching models configuration

Experimental

これらの環境変数は、変更または削除される可能性がある実験的機能を有効にします。

Variable	Type	Description
OPENCODE_EXPERIMENTAL	boolean	Enable the experimental umbrella flag
OPENCODE_EXPERIMENTAL_ICON_DISCOVERY	boolean	Enable icon discovery
OPENCODE_EXPERIMENTAL_DISABLE_COPY_ON_SELECT	boolean	Disable copy on select in TUI
OPENCODE_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MS	number	Default timeout for bash commands in ms
OPENCODE_EXPERIMENTAL_OUTPUT_TOKEN_MAX	number	Max output tokens for LLM responses
OPENCODE_EXPERIMENTAL_FILEWATCHER	boolean	Enable file watcher for entire dir
OPENCODE_EXPERIMENTAL_OXFMT	boolean	Enable oxfmt formatter
OPENCODE_EXPERIMENTAL_LSP_TOOL	boolean	Enable experimental LSP tool
OPENCODE_EXPERIMENTAL_DISABLE_FILEWATCHER	boolean	Disable file watcher
OPENCODE_EXPERIMENTAL_EXA	boolean	Enable experimental Exa features
OPENCODE_EXPERIMENTAL_LSP_TY	boolean	Enable TY LSP for python files
OPENCODE_EXPERIMENTAL_PLAN_MODE	boolean	Enable plan mode
OPENCODE_EXPERIMENTAL_BACKGROUND_SUBAGENTS	boolean	Enable background subagent tasks
OPENCODE_EXPERIMENTAL_EVENT_SYSTEM	boolean	Enable experimental event system
OPENCODE_EXPERIMENTAL_NATIVE_LLM	boolean	Enable native LLM request path
OPENCODE_EXPERIMENTAL_PARALLEL	boolean	Enable parallel web search execution
OPENCODE_EXPERIMENTAL_SCOUT	boolean	Enable Scout subagent
OPENCODE_EXPERIMENTAL_WORKSPACES	boolean	Enable workspace support