日本語
ドキュメント
CLI

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

フラグ

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

create

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

opencode agent create

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

list

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

opencode agent list

auth

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

opencode auth [command]

login

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

opencode auth login

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

list

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

opencode auth list

または短縮版を使用します。

opencode auth ls

logout

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

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
フラグ
フラグ説明
--eventAgent を実行する GitHub モックイベント
--tokenGitHub 個人アクセストークン

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

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

opencode models [provider]

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

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

オプションで Provider ID を渡して、その Provider でフィルタリングできます。

opencode models anthropic

フラグ

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

--refresh フラグを使用して、キャッシュされたモデルリストを更新します。Provider に新しいモデルが追加され、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
--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リッスンするホスト名
--mdnsmDNS ディスカバリを有効化
--corsCORS を許可する追加のブラウザオリジン

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 ブラウザが開いて Web インターフェースから OpenCode にアクセスできます。OPENCODE_SERVER_PASSWORD を設定して HTTP 基本認証を有効にします（ユーザー名のデフォルトは opencode）。

フラグ

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

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_SHAREbooleanセッションを自動共有
OPENCODE_GIT_BASH_PATHstringWindows での Git Bash 実行ファイルのパス
OPENCODE_CONFIGstring設定ファイルのパス
OPENCODE_CONFIG_DIRstring設定ディレクトリのパス
OPENCODE_CONFIG_CONTENTstringインライン JSON 設定内容
OPENCODE_DISABLE_AUTOUPDATEboolean自動更新チェックを無効化
OPENCODE_DISABLE_PRUNEboolean古いデータの削除を無効化
OPENCODE_DISABLE_TERMINAL_TITLEboolean自動ターミナルタイトル更新を無効化
OPENCODE_PERMISSIONstringインライン JSON 権限設定
OPENCODE_DISABLE_DEFAULT_PLUGINSbooleanデフォルトプラグインを無効化
OPENCODE_DISABLE_LSP_DOWNLOADboolean自動 LSP サーバーダウンロードを無効化
OPENCODE_ENABLE_EXPERIMENTAL_MODELSboolean実験的モデルを有効化
OPENCODE_DISABLE_AUTOCOMPACTboolean自動コンテキスト圧縮を無効化
OPENCODE_DISABLE_CLAUDE_CODEboolean.claude（プロンプト + スキル）の読み込みを無効化
OPENCODE_DISABLE_CLAUDE_CODE_PROMPTboolean~/.claude/CLAUDE.md の読み込みを無効化
OPENCODE_DISABLE_CLAUDE_CODE_SKILLSboolean.claude/skills の読み込みを無効化
OPENCODE_DISABLE_MODELS_FETCHbooleanリモートソースからのモデル取得を無効化
OPENCODE_FAKE_VCSstringテスト用の偽 VCS Provider
OPENCODE_DISABLE_FILETIME_CHECKboolean最適化のためのファイル時間チェックを無効化
OPENCODE_CLIENTstringクライアント識別子（デフォルト cli）
OPENCODE_ENABLE_EXAbooleanExa Web 検索ツールを有効化
OPENCODE_SERVER_PASSWORDstringserve/web の基本認証を有効化
OPENCODE_SERVER_USERNAMEstring基本認証ユーザー名を上書き（デフォルト opencode）
OPENCODE_MODELS_URLstringモデル設定を取得するカスタム URL

実験的

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

変数型説明
OPENCODE_EXPERIMENTALbooleanすべての実験的機能を有効化
OPENCODE_EXPERIMENTAL_ICON_DISCOVERYbooleanアイコンディスカバリを有効化
OPENCODE_EXPERIMENTAL_DISABLE_COPY_ON_SELECTbooleanTUI での選択時コピーを無効化
OPENCODE_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MSnumberbash コマンドのデフォルトタイムアウト（ミリ秒）
OPENCODE_EXPERIMENTAL_OUTPUT_TOKEN_MAXnumberLLM レスポンスの最大出力トークン数
OPENCODE_EXPERIMENTAL_FILEWATCHERbooleanディレクトリ全体のファイルウォッチャーを有効化
OPENCODE_EXPERIMENTAL_OXFMTbooleanoxfmt フォーマッターを有効化
OPENCODE_EXPERIMENTAL_LSP_TOOLboolean実験的 LSP ツールを有効化
OPENCODE_EXPERIMENTAL_DISABLE_FILEWATCHERbooleanファイルウォッチャーを無効化
OPENCODE_EXPERIMENTAL_EXAboolean実験的 Exa 機能を有効化
OPENCODE_EXPERIMENTAL_LSP_TYboolean実験的 LSP 型チェックを有効化
OPENCODE_EXPERIMENTAL_MARKDOWNboolean実験的 Markdown 機能を有効化
OPENCODE_EXPERIMENTAL_PLAN_MODEbooleanプランモードを有効化
TUIWeb