コンテンツにスキップ
学習 比較 レシピ エコシステム ソースコード ドキュメント

CLI

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

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

opencode

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

opencode run "Explain how closures work in JavaScript"

tui

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

opencode [project]

Flags

フラグ短縮説明
--continue-c最新のセッションを続行
--session-s続行するセッション ID
--fork-続行時にセッションをフォーク
--prompt-使用するプロンプト
--model-m使用するモデル（プロバイダー/モデル形式）
--agent-使用するエージェント
--port-待ち受けポート
--hostname-待ち受けホスト名
--mdns-mDNS 検出を有効化
--mdns-domain-カスタム mDNS ドメイン名
--cors-CORS を許可する追加のブラウザオリジン

Commands

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

agent

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

opencode agent [command]

create

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

opencode agent create

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

フラグ短縮説明
--path-エージェントファイルの書き込み先ディレクトリ
--description-エージェントに実行させる内容
--mode-エージェントモード：all、primary、subagent のいずれか
--permissions-許可する権限のカンマ区切りリスト
--model-m使用するモデル（provider/model 形式）

利用可能な権限：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://<server-ip>:4096
フラグ短縮説明
--dir-TUI を起動する作業ディレクトリ
--continue-c最新のセッションを続行
--session-s続行するセッション ID
--fork-続行時にセッションをフォーク
--password-pBasic 認証のパスワード
--username-uBasic 認証のユーザー名

auth

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

opencode auth [command]

login

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

opencode auth login
フラグ短縮説明
--provider-pログインするプロバイダーの ID または名前
--method-m使用するログイン方法のラベル

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
フラグ説明
--eventエージェントを実行する対象の GitHub モックイベント
--tokenGitHub パーソナルアクセストークン

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

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"
フラグ短縮説明
--command-実行するコマンド（引数には message を使用）
--continue-c最新のセッションを続行
--session-s続行するセッション ID
--fork-続行時にセッションをフォーク
--share-セッションを共有
--model-m使用するモデル（プロバイダー/モデル形式）
--agent-使用するエージェント
--file-fメッセージに添付するファイル
--format-フォーマット：default（デフォルトは整形済み出力）または json（生の JSON イベント）
--title-セッションのタイトル
--attach-実行中の opencode サーバーに接続
--password-pBasic 認証のパスワード
--username-uBasic 認証のユーザー名
--dir-実行ディレクトリ（接続時はリモートサーバー上のパス）
--port-ローカルサーバーのポート
--variant-モデルバリアント（プロバイダー固有の推論強度）
--thinking-思考ブロックを表示
--dangerously-skip-permissions-権限を自動承認（危険！）

serve

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

opencode serve

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

フラグ説明
--port待ち受けポート
--hostname待ち受けホスト名
--mdnsmDNS 検出を有効化
--mdns-domainカスタム mDNS ドメイン名
--corsCORS を許可する追加のブラウザオリジン

session

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

opencode session [command]

list

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

opencode session list
フラグ短縮説明
--max-count-n最新 N 件のセッションに制限
--format-出力フォーマット：table または json

delete

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

opencode session delete <sessionID>

stats

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

opencode stats
フラグ説明
--days直近 N 日間の統計を表示
--tools表示するツール数
--modelsモデル別の使用内訳を表示
--projectプロジェクトで絞り込み

export

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

opencode export [sessionID]
フラグ説明
--sanitize機密性の高いトランスクリプト/ファイルデータをマスク

import

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

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

web

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

opencode web
フラグ説明
--port待ち受けポート
--hostname待ち受けホスト名
--mdnsmDNS 検出を有効化
--mdns-domainカスタム mDNS ドメイン名
--corsCORS を許可する追加のブラウザオリジン

acp

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

opencode acp

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

フラグ説明
--cwd作業ディレクトリ
--port待ち受けポート
--hostname待ち受けホスト名
--mdnsmDNS 検出を有効化
--mdns-domainカスタム mDNS ドメイン名
--corsCORS を許可する追加のブラウザオリジン

plugin

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

opencode plugin <module>
# Or use the alias
opencode plug <module>
フラグ短縮説明
--global-gグローバル設定にインストール
--force-f既存のプラグインバージョンを置き換え

pr

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

opencode pr <number>

db

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

opencode db [query]
フラグ説明
--format出力フォーマット：json または tsv

path

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

opencode db path

debug

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

opencode debug [command]

uninstall

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

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

upgrade

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

opencode upgrade
# Or a specific version
opencode upgrade v0.1.48
フラグ短縮説明
--method-m使用されたインストール方法（curl、npm、pnpm、bun、brew）

Global Flags

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

フラグ短縮説明
--help-hヘルプを表示
--version-vバージョン番号を表示
--print-logs-ログを stderr に出力
--log-level-ログレベル（DEBUG、INFO、WARN、ERROR）
--pure-外部プラグインなしで実行

Environment variables

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

変数型説明
OPENCODE_AUTO_SHAREbooleanセッションを自動共有
OPENCODE_GIT_BASH_PATHstringWindows における Git Bash 実行ファイルのパス
OPENCODE_CONFIGstring設定ファイルのパス
OPENCODE_TUI_CONFIGstringTUI 設定ファイルのパス
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_DOWNLOADbooleanLSP サーバーの自動ダウンロードを無効化
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_DISABLE_MOUSEbooleanTUI でのマウスキャプチャを無効化
OPENCODE_FAKE_VCSstringテスト用の偽 VCS プロバイダー
OPENCODE_CLIENTstringクライアント識別子（デフォルトは cli）
OPENCODE_ENABLE_EXAbooleanExa ウェブ検索ツールを有効化
OPENCODE_SERVER_PASSWORDstringserve/web で Basic 認証を有効化
OPENCODE_SERVER_USERNAMEstringBasic 認証ユーザー名の上書き（デフォルト opencode）
OPENCODE_MODELS_URLstringモデル設定の取得に使うカスタム URL

Experimental

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

変数型説明
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_TYbooleanPython ファイル用の TY LSP を有効化
OPENCODE_EXPERIMENTAL_PLAN_MODEbooleanプランモードを有効化
OPENCODE_EXPERIMENTAL_BACKGROUND_SUBAGENTSbooleanバックグラウンドサブエージェントタスクを有効化
OPENCODE_EXPERIMENTAL_EVENT_SYSTEMboolean実験的イベントシステムを有効化
OPENCODE_EXPERIMENTAL_NATIVE_LLMbooleanネイティブ LLM リクエストパスを有効化
OPENCODE_EXPERIMENTAL_PARALLELbooleanウェブ検索の並列実行を有効化
OPENCODE_EXPERIMENTAL_SCOUTbooleanScout サブエージェントを有効化
OPENCODE_EXPERIMENTAL_WORKSPACESbooleanワークスペースサポートを有効化