CLI

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

デフォルトでは、OpenCode CLI は引数なしで実行すると TUI を起動します。

opencode

ただし、このページに記載されているコマンドも受け付けます。これにより、OpenCode とプログラム的にやり取りできます。

opencode run "Explain how closures work in JavaScript"

tui

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

opencode [project]

フラグ

フラグ	短縮形	説明
`--continue`	`-c`	前のセッションを再開
`--session`	`-s`	再開するセッション ID
`--fork`		再開時にセッションをフォーク（--continue または --session と併用）
`--prompt`		使用するプロンプト
`--model`	`-m`	使用するモデル（provider/model 形式）
`--agent`		使用する Agent
`--port`		リッスンするポート
`--hostname`		リッスンするホスト名

コマンド

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

agent

OpenCode の Agent を管理します。

opencode agent [command]

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

フラグ

フラグ	短縮形	説明
`--dir`		TUI を起動する作業ディレクトリ
`--session`	`-s`	再開するセッション ID

create

カスタム設定で新しい Agent を作成します。

opencode agent create

このコマンドは、カスタムシステムプロンプトとツール設定で新しい Agent を作成するプロセスをガイドします。

list

利用可能なすべての Agent を一覧表示します。

opencode agent list

auth

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

opencode auth [command]

login

OpenCode は Models.dev (opens in a new tab) のプロバイダーリストを使用しているため、opencode auth login で使用したいプロバイダーの API キーを設定できます。これは ~/.local/share/opencode/auth.json に保存されます。

opencode auth login

OpenCode の起動時に、認証情報ファイルからプロバイダーを読み込みます。また、環境変数やプロジェクトの .env ファイルで定義されたキーも読み込みます。

list

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

opencode auth list

または短縮版。

opencode auth ls

logout

認証情報ファイルからプロバイダーをクリアしてログアウトします。

opencode auth logout

github

リポジトリ自動化のための GitHub Agent を管理します。

opencode github [command]

install

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

opencode github install

必要な GitHub Actions ワークフローを設定し、設定プロセスをガイドします。詳しくはこちら。

run

GitHub Agent を実行します。通常は GitHub Actions で使用されます。

opencode github run

フラグ

フラグ	説明
`--event`	Agent を実行する GitHub モックイベント
`--token`	GitHub パーソナルアクセストークン

mcp

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

opencode mcp [command]

add

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

opencode mcp add

このコマンドは、ローカルまたはリモートの MCP サーバーを追加するプロセスをガイドします。

list

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

opencode mcp list

または短縮版。

opencode mcp ls

auth

OAuth 対応の MCP サーバーで認証します。

opencode mcp auth [name]

サーバー名を指定しない場合、利用可能な OAuth 対応サーバーから選択するよう求められます。

OAuth 対応サーバーとその認証状態を一覧表示することもできます。

opencode mcp auth list

または短縮版。

opencode mcp auth ls

logout

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

opencode mcp logout [name]

debug

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

opencode mcp debug <name>

models

設定済みプロバイダーの利用可能なすべてのモデルを一覧表示します。

opencode models [provider]

このコマンドは、設定済みプロバイダーの利用可能なすべてのモデルを provider/model 形式で表示します。

設定で使用する正確なモデル名を確認するのに便利です。

オプションでプロバイダー ID を渡して、そのプロバイダーのモデルのみをフィルタリングできます。

opencode models anthropic

フラグ

フラグ	説明
`--refresh`	models.dev からモデルキャッシュを更新
`--verbose`	より詳細なモデル出力を使用（コストなどのメタデータを含む）

--refresh フラグを使用して、キャッシュされたモデルリストを更新します。プロバイダーに新しいモデルが追加され、OpenCode で表示したい場合に便利です。

opencode models --refresh

run

プロンプトを直接渡して、非対話モードで opencode を実行します。

opencode run [message..]

スクリプト、自動化、または完全な TUI を起動せずに素早く回答を得たい場合に便利です。例：

opencode run "Explain the use of context in Go"

実行中の opencode serve インスタンスに接続して、毎回の MCP サーバーのコールドブート時間を回避することもできます：

# 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"

フラグ

フラグ	短縮形	説明
`--command`		実行するコマンド、message を引数として使用
`--continue`	`-c`	前のセッションを再開
`--session`	`-s`	再開するセッション ID
`--fork`		再開時にセッションをフォーク（--continue または --session と併用）
`--share`		セッションを共有
`--model`	`-m`	使用するモデル（provider/model 形式）
`--agent`		使用する Agent
`--file`	`-f`	メッセージに添付するファイル
`--format`		フォーマット：default（整形済み）または json（生の JSON イベント）
`--title`		セッションのタイトル（値が指定されない場合、切り詰められたプロンプトを使用）
`--attach`		実行中の opencode サーバーに接続（例：http://localhost:4096） (opens in a new tab)
`--port`		ローカルサーバーのポート（デフォルトはランダムポート）

serve

API アクセス用のヘッドレス OpenCode サーバーを起動します。完全な HTTP インターフェースについてはサーバードキュメントをご覧ください。

opencode serve

TUI インターフェースなしで opencode 機能への API アクセスを提供する HTTP サーバーを起動します。OPENCODE_SERVER_PASSWORD を設定して HTTP 基本認証を有効にできます（ユーザー名のデフォルトは opencode）。

フラグ

フラグ	説明
`--port`	リッスンするポート
`--hostname`	リッスンするホスト名
`--mdns`	mDNS ディスカバリを有効化
`--cors`	CORS を許可する追加のブラウザオリジン

session

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

opencode session [command]

list

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

opencode session list

フラグ

フラグ	短縮形	説明
`--max-count`	`-n`	最新の N セッションに制限
`--format`		出力フォーマット：table または json（デフォルト table）

stats

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

opencode stats

フラグ

フラグ	説明
`--days`	過去 N 日間の統計を表示（デフォルト全期間）
`--tools`	表示するツール数（デフォルト全部）
`--models`	モデル使用内訳を表示（デフォルト非表示）。数値を渡してトップ N を表示
`--project`	プロジェクトでフィルタリング（デフォルト全プロジェクト、空文字列：現在のプロジェクト）

export

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

opencode export [sessionID]

セッション ID を指定しない場合、利用可能なセッションから選択するよう求められます。

import

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

opencode import <file>

ローカルファイルまたは OpenCode 共有 URL からインポートできます。

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

web

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

opencode web

HTTP サーバーを起動し、Web インターフェースを通じて OpenCode にアクセスするためのブラウザを開きます。OPENCODE_SERVER_PASSWORD を設定して HTTP 基本認証を有効にできます（ユーザー名のデフォルトは opencode）。

フラグ

フラグ	説明
`--port`	リッスンするポート
`--hostname`	リッスンするホスト名
`--mdns`	mDNS ディスカバリを有効化
`--cors`	CORS を許可する追加のブラウザオリジン

acp

ACP（Agent Client Protocol）サーバーを起動します。

opencode acp

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

フラグ

フラグ	説明
`--cwd`	作業ディレクトリ
`--port`	リッスンするポート
`--hostname`	リッスンするホスト名

uninstall

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

opencode uninstall

フラグ

フラグ	短縮形	説明
`--keep-config`	`-c`	設定ファイルを保持
`--keep-data`	`-d`	セッションデータとスナップショットを保持
`--dry-run`		削除せずに削除対象を表示
`--force`	`-f`	確認プロンプトをスキップ

upgrade

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

opencode upgrade [target]

最新バージョンにアップグレードする場合。

opencode upgrade

特定のバージョンにアップグレードする場合。

opencode upgrade v0.1.48

フラグ

フラグ	短縮形	説明
`--method`	`-m`	使用したインストール方法：curl、npm、pnpm、bun、brew

グローバルフラグ

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

フラグ	短縮形	説明
`--help`	`-h`	ヘルプを表示
`--version`	`-v`	バージョン番号を表示
`--print-logs`		ログを stderr に出力
`--log-level`		ログレベル（DEBUG、INFO、WARN、ERROR）

環境変数

OpenCode は環境変数で設定できます。

変数	型	説明
`OPENCODE_AUTO_SHARE`	boolean	セッションを自動共有
`OPENCODE_GIT_BASH_PATH`	string	Windows での Git Bash 実行ファイルのパス
`OPENCODE_CONFIG`	string	設定ファイルのパス
`OPENCODE_CONFIG_DIR`	string	設定ディレクトリのパス
`OPENCODE_CONFIG_CONTENT`	string	インライン JSON 設定内容
`OPENCODE_DISABLE_AUTOUPDATE`	boolean	自動更新チェックを無効化
`OPENCODE_DISABLE_PRUNE`	boolean	古いデータの削除を無効化
`OPENCODE_DISABLE_TERMINAL_TITLE`	boolean	自動ターミナルタイトル更新を無効化
`OPENCODE_PERMISSION`	string	インライン JSON 権限設定
`OPENCODE_DISABLE_DEFAULT_PLUGINS`	boolean	デフォルトプラグインを無効化
`OPENCODE_DISABLE_LSP_DOWNLOAD`	boolean	自動 LSP サーバーダウンロードを無効化
`OPENCODE_ENABLE_EXPERIMENTAL_MODELS`	boolean	実験的モデルを有効化
`OPENCODE_DISABLE_AUTOCOMPACT`	boolean	自動コンテキスト圧縮を無効化
`OPENCODE_DISABLE_CLAUDE_CODE`	boolean	`.claude`（プロンプト + スキル）の読み込みを無効化
`OPENCODE_DISABLE_CLAUDE_CODE_PROMPT`	boolean	`~/.claude/CLAUDE.md` の読み込みを無効化
`OPENCODE_DISABLE_CLAUDE_CODE_SKILLS`	boolean	`.claude/skills` の読み込みを無効化
`OPENCODE_DISABLE_MODELS_FETCH`	boolean	リモートソースからのモデル取得を無効化
`OPENCODE_FAKE_VCS`	string	テスト用の偽 VCS Provider
`OPENCODE_DISABLE_FILETIME_CHECK`	boolean	最適化のためのファイル時間チェックを無効化
`OPENCODE_CLIENT`	string	クライアント識別子（デフォルト `cli`）
`OPENCODE_ENABLE_EXA`	boolean	Exa Web 検索ツールを有効化
`OPENCODE_SERVER_PASSWORD`	string	`serve`/`web` の基本認証を有効化
`OPENCODE_SERVER_USERNAME`	string	基本認証ユーザー名を上書き（デフォルト `opencode`）
`OPENCODE_MODELS_URL`	string	モデル設定を取得するカスタム URL

実験的

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

変数	型	説明
`OPENCODE_EXPERIMENTAL`	boolean	すべての実験的機能を有効化
`OPENCODE_EXPERIMENTAL_ICON_DISCOVERY`	boolean	アイコンディスカバリを有効化
`OPENCODE_EXPERIMENTAL_DISABLE_COPY_ON_SELECT`	boolean	TUI での選択時コピーを無効化
`OPENCODE_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MS`	number	bash コマンドのデフォルトタイムアウト（ミリ秒）
`OPENCODE_EXPERIMENTAL_OUTPUT_TOKEN_MAX`	number	LLM レスポンスの最大出力トークン数
`OPENCODE_EXPERIMENTAL_FILEWATCHER`	boolean	ディレクトリ全体のファイルウォッチャーを有効化
`OPENCODE_EXPERIMENTAL_OXFMT`	boolean	oxfmt フォーマッターを有効化
`OPENCODE_EXPERIMENTAL_LSP_TOOL`	boolean	実験的 LSP ツールを有効化
`OPENCODE_EXPERIMENTAL_DISABLE_FILEWATCHER`	boolean	ファイルウォッチャーを無効化
`OPENCODE_EXPERIMENTAL_EXA`	boolean	実験的 Exa 機能を有効化
`OPENCODE_EXPERIMENTAL_LSP_TY`	boolean	実験的 LSP 型チェックを有効化
`OPENCODE_EXPERIMENTAL_MARKDOWN`	boolean	実験的 Markdown 機能を有効化
`OPENCODE_EXPERIMENTAL_PLAN_MODE`	boolean	プランモードを有効化

TUI Web