設定
JSON 設定ファイルを使用して OpenCode を構成できます。
OpenCode は、JSON と JSONC (コメント付きの JSON) 形式の両方をサポートしています。
{
"$schema": "https://opencode.ai/config.json",
"model": "anthropic/claude-sonnet-5-5",
"autoupdate": true,
"server": {
"port": 4096,
},
}設定をいくつかの異なる場所に配置できます。それらは異なる優先順位を持ちます。
設定ファイルは結合され、置き換えられません。次の構成場所からの設定が結合されます。競合するキーに対してのみ、後の設定が前の設定を上書きします。すべての構成からの競合しない設定は保持されます。
たとえば、グローバル設定で autoupdate: true を設定し、プロジェクト設定で model: "anthropic/claude-sonnet-5-5" を設定した場合、最終的な構成には両方の設定が含まれます。
設定ソースは次の順序でロードされます (後のソースは前のソースをオーバーライドします)。
- リモート設定 (
.well-known/opencodeから) - 組織のデフォルト - グローバル設定 (
~/.config/opencode/opencode.json) - ユーザー設定 - カスタム設定 (
OPENCODE_CONFIG環境変数) - カスタムオーバーライド - プロジェクト設定 (プロジェクト内の
opencode.json) - プロジェクト固有の設定 .opencodeディレクトリ - エージェント、コマンド、プラグイン- インライン設定 (
OPENCODE_CONFIG_CONTENT環境変数) - ランタイムオーバーライド
つまり、プロジェクト設定はグローバルのデフォルトをオーバーライドでき、グローバル設定はリモート組織のデフォルトをオーバーライドできます。
組織は、.well-known/opencode エンドポイント経由でデフォルト設定を提供できます。これは、それをサポートするプロバイダーで認証するときに自動的に取得されます。
リモート設定が最初にロードされ、基本層として機能します。他のすべての設定ソース (グローバル、プロジェクト) は、これらのデフォルトをオーバーライドできます。
たとえば、組織がデフォルトで無効になっている MCP サーバーを提供している場合:
{
"mcp": {
"jira": {
"type": "remote",
"url": "https://jira.example.com/mcp",
"enabled": false
}
}
}ローカル設定で特定のサーバーを有効にすることができます。
{
"mcp": {
"jira": {
"type": "remote",
"url": "https://jira.example.com/mcp",
"enabled": true
}
}
}グローバル OpenCode 設定を ~/.config/opencode/opencode.json に配置します。プロバイダー、モデル、権限などのユーザー全体の設定にはグローバル設定を使用します。
TUI 固有の設定には、~/.config/opencode/tui.json を使用します。
グローバル設定はリモート組織のデフォルトをオーバーライドします。
プロジェクトのルートに opencode.json を追加します。プロジェクト設定は、標準設定ファイルの中で最も高い優先順位を持ち、グローバル設定とリモート設定の両方をオーバーライドします。
プロジェクト固有の TUI 設定については、その横に tui.json を追加します。
OpenCode が起動すると、現在のディレクトリで設定ファイルを検索するか、最も近い Git ディレクトリまで移動します。
これは Git に安全にチェックインでき、グローバルスキーマと同じスキーマを使用します。
OPENCODE_CONFIG 環境変数を使用してカスタム設定ファイルのパスを指定します。
export OPENCODE_CONFIG=/path/to/my/custom-config.json
opencode run "Hello world"カスタム設定は、優先順位でグローバル設定とプロジェクト設定の間にロードされます。
OPENCODE_CONFIG_DIR を使用してカスタム設定ディレクトリを指定します。
環境変数。このディレクトリでは、エージェント、コマンド、
モードとプラグインは標準の .opencode ディレクトリと同様であり、次のようにする必要があります。
同じ構造に従います。
export OPENCODE_CONFIG_DIR=/path/to/my/config-directory
opencode run "Hello world"カスタムディレクトリはグローバル config ディレクトリと .opencode ディレクトリの後にロードされるため、それらの設定をオーバーライドできます。
サーバー/ランタイム構成スキーマは opencode.ai/config.json で定義されています。
TUI 設定は opencode.ai/tui.json を使用します。
エディターはスキーマに基づいて検証し、オートコンプリートできる必要があります。
TUI 固有の設定には、専用の tui.json (または tui.jsonc) ファイルを使用します。
{
"$schema": "https://opencode.ai/tui.json",
"scroll_speed": 3,
"scroll_acceleration": {
"enabled": true
},
"diff_style": "auto"
}カスタム TUI 設定ファイルを指定するには、OPENCODE_TUI_CONFIG を使用します。
opencode.json 内の従来の theme、keybinds、および tui キーは非推奨となり、可能であれば自動的に移行されます。
TUI の設定の詳細については、こちら をご覧ください。
opencode serve オプションを使用して、opencode web および server コマンドのサーバー設定を構成できます。
{
"$schema": "https://opencode.ai/config.json",
"server": {
"port": 4096,
"hostname": "0.0.0.0",
"mdns": true,
"mdnsDomain": "myproject.local",
"cors": ["http://localhost:5173"]
}
}利用可能なオプション:
port- リッスンするポート。hostname- リッスンするホスト名。mdnsが有効でホスト名が設定されていない場合、デフォルトは0.0.0.0になります。mdns- mDNS サービス検出を有効にします。これにより、ネットワーク上の他のデバイスが OpenCode サーバーを検出できるようになります。mdnsDomain- mDNS サービスのカスタムドメイン名。デフォルトはopencode.localです。同じネットワーク上で複数のインスタンスを実行する場合に便利です。cors- ブラウザベースのクライアントから HTTP サーバーを使用するときに CORS を許可する追加のオリジン。値は完全なオリジン (スキーム + ホスト + オプションのポート) である必要があります (例:https://app.example.com)。
サーバーの詳細については、こちらをご覧ください。
LLM が使用できるツールは、tools オプションを通じて管理できます。
{
"$schema": "https://opencode.ai/config.json",
"tools": {
"write": false,
"bash": false
}
}provider、model、および small_model オプションを使用して、OpenCode 設定で使用するプロバイダーとモデルを構成できます。
{
"$schema": "https://opencode.ai/config.json",
"provider": {},
"model": "anthropic/claude-sonnet-5-5",
"small_model": "anthropic/claude-haiku-5-5"
}small_model オプションは、タイトルの生成などの軽量タスク用に個別のモデルを構成します。デフォルトでは、OpenCode は、プロバイダーから安価なモデルが入手可能な場合は、より安価なモデルを使用しようとします。そうでない場合は、メインモデルにフォールバックします。
プロバイダーオプションには、timeout および setCacheKey を含めることができます。
{
"$schema": "https://opencode.ai/config.json",
"provider": {
"anthropic": {
"options": {
"timeout": 600000,
"setCacheKey": true
}
}
}
}timeout- リクエストのタイムアウト (ミリ秒単位) (デフォルト: 300000)。無効にするには、falseに設定します。setCacheKey- 指定されたプロバイダーに対してキャッシュキーが常に設定されていることを確認します。
プロバイダー固有のオプション
一部のプロバイダーは、一般的な timeout および apiKey 設定を超える追加の構成オプションをサポートしています。
Amazon Bedrock
Amazon Bedrock は、AWS 固有の設定をサポートしています。
{
"$schema": "https://opencode.ai/config.json",
"provider": {
"amazon-bedrock": {
"options": {
"region": "us-east-1",
"profile": "my-aws-profile",
"endpoint": "https://bedrock-runtime.us-east-1.vpce-xxxxx.amazonaws.com"
}
}
}
}region- Bedrock の AWS リージョン (デフォルトはAWS_REGION環境変数またはus-east-1)profile-~/.aws/credentialsからの AWS 名前付きプロファイル (デフォルトはAWS_PROFILE環境変数)endpoint- VPC エンドポイントのカスタムエンドポイント URL。これは、AWS 固有の用語を使用した汎用baseURLオプションのエイリアスです。両方を指定した場合は、endpointが優先されます。
Amazon Bedrock 設定 の詳細をご覧ください。
UI テーマを tui.json で設定します。
{
"$schema": "https://opencode.ai/tui.json",
"theme": "tokyonight"
}agent オプションを使用して、特定のタスクに特化したエージェントを構成できます。
{
"$schema": "https://opencode.ai/config.json",
"agent": {
"code-reviewer": {
"description": "Reviews code for best practices and potential issues",
"model": "anthropic/claude-sonnet-5-5",
"prompt": "You are a code reviewer. Focus on security, performance, and maintainability.",
"tools": {
// Disable file modification tools for review-only agent
"write": false,
"edit": false,
},
},
},
}~/.config/opencode/agents/ または .opencode/agents/ の Markdown ファイルを使用してエージェントを定義することもできます。 詳細はこちら。
default_agent オプションを使用してデフォルトのエージェントを設定できます。これにより、明示的に何も指定されていない場合にどのエージェントが使用されるかが決まります。
{
"$schema": "https://opencode.ai/config.json",
"default_agent": "plan"
}デフォルトのエージェントはプライマリエージェントである必要があります (サブエージェントではありません)。これは、"build" や "plan" のような組み込みエージェント、または定義したカスタムエージェント にすることができます。指定されたエージェントが存在しないか、サブエージェントである場合、OpenCode は警告とともに "build" にフォールバックします。
この設定は、TUI、CLI (opencode run)、デスクトップアプリ、および GitHub Action のすべてのインターフェイスに適用されます。
command オプションを使用して、反復タスク用のカスタムコマンドを構成できます。
{
"$schema": "https://opencode.ai/config.json",
"command": {
"test": {
"template": "Run the full test suite with coverage report and show any failures.\nFocus on the failing tests and suggest fixes.",
"description": "Run tests with coverage",
"agent": "build",
"model": "anthropic/claude-haiku-5-5",
},
"component": {
"template": "Create a new React component named $ARGUMENTS with TypeScript support.\nInclude proper typing and basic structure.",
"description": "Create a new component",
},
},
}~/.config/opencode/commands/ または .opencode/commands/ の Markdown ファイルを使用してコマンドを定義することもできます。 詳細はこちら。
tui.json でキーバインドをカスタマイズします。
{
"$schema": "https://opencode.ai/tui.json",
"keybinds": {}
}OpenCode は起動時に新しいアップデートを自動的にダウンロードします。 autoupdate オプションを使用してこれを無効にできます。
{
"$schema": "https://opencode.ai/config.json",
"autoupdate": false
}更新は必要ないが、新しいバージョンが利用可能になったときに通知を受け取りたい場合は、autoupdate を "notify" に設定します。
これは、Homebrew などのパッケージマネージャーを使用してインストールされていない場合にのみ機能することに注意してください。
formatter オプションを使用してコードフォーマッタを設定できます。
{
"$schema": "https://opencode.ai/config.json",
"formatter": {
"prettier": {
"disabled": true
},
"custom-prettier": {
"command": ["npx", "prettier", "--write", "$FILE"],
"environment": {
"NODE_ENV": "development"
},
"extensions": [".js", ".ts", ".jsx", ".tsx"]
}
}
}フォーマッタの詳細については、こちら をご覧ください。
デフォルトでは、opencode は明示的な承認を必要とせずに すべての操作を許可します。これは、permission オプションを使用して変更できます。
たとえば、edit ツールと bash ツールにユーザーの承認が必要であることを確認するには、次のようにします。
{
"$schema": "https://opencode.ai/config.json",
"permission": {
"edit": "ask",
"bash": "ask"
}
}権限の詳細については、こちらをご覧ください。
compaction オプションを使用してコンテキストの圧縮動作を制御できます。
{
"$schema": "https://opencode.ai/config.json",
"compaction": {
"auto": true,
"prune": false
}
}auto- コンテキストがいっぱいのときにセッションを自動的に圧縮します (デフォルト:true)。prune- 古いツールの出力を削除してトークンを保存します (デフォルト:false)。
watcher オプションを使用して、ファイルウォッチャーの無視パターンを構成できます。
{
"$schema": "https://opencode.ai/config.json",
"watcher": {
"ignore": ["node_modules/**", "dist/**", ".git/**"]
}
}パターンは glob 構文に従います。これを使用して、ノイズの多いディレクトリをファイル監視から除外します。
mcp オプションを使用して、使用する MCP サーバーを構成できます。
{
"$schema": "https://opencode.ai/config.json",
"mcp": {}
}Plugins は、カスタムツール、フック、統合を使用して OpenCode を拡張します。
プラグインファイルを .opencode/plugins/ または ~/.config/opencode/plugins/ に配置します。 plugin オプションを使用して npm からプラグインをロードすることもできます。
{
"$schema": "https://opencode.ai/config.json",
"plugin": ["opencode-helicone-session", "@my-org/custom-plugin"]
}instructions オプションを使用して、使用しているモデルの指示を構成できます。
{
"$schema": "https://opencode.ai/config.json",
"instructions": ["CONTRIBUTING.md", "docs/guidelines.md", ".cursor/rules/*.md"]
}これは、指示ファイルへのパスとグロブパターンの配列を受け取ります。 ルールについて詳しくはこちら。
disabled_providers オプションを使用して、自動的にロードされるプロバイダーを無効にすることができます。これは、認証情報が利用可能な場合でも、特定のプロバイダーが読み込まれないようにしたい場合に便利です。
{
"$schema": "https://opencode.ai/config.json",
"disabled_providers": ["openai", "gemini"]
}disabled_providers オプションは、プロバイダー ID の配列を受け入れます。プロバイダーが無効になっている場合:
- 環境変数を設定してもロードされません。
/connectコマンドで API キーを設定してもロードされません。- プロバイダーのモデルはモデル選択リストに表示されません。
enabled_providers オプションを使用してプロバイダーの許可リストを指定できます。設定すると、指定されたプロバイダーのみが有効になり、その他はすべて無視されます。
{
"$schema": "https://opencode.ai/config.json",
"enabled_providers": ["anthropic", "openai"]
}これは、OpenCode を 1 つずつ無効にするのではなく、特定のプロバイダーのみを使用するように制限したい場合に便利です。
プロバイダーが enabled_providers と disabled_providers の両方に表示される場合、下位互換性のために disabled_providers が優先されます。
experimental キーには、現在開発中のオプションが含まれています。
{
"$schema": "https://opencode.ai/config.json",
"experimental": {}
}設定ファイル内で変数置換を使用して、環境変数とファイルの内容を参照できます。
{env:VARIABLE_NAME} を使用して環境変数を置き換えます。
{
"$schema": "https://opencode.ai/config.json",
"model": "{env:OPENCODE_MODEL}",
"provider": {
"anthropic": {
"models": {},
"options": {
"apiKey": "{env:ANTHROPIC_API_KEY}"
}
}
}
}環境変数が設定されていない場合は、空の文字列に置き換えられます。
{file:path/to/file} を使用してファイルの内容を置き換えます。
{
"$schema": "https://opencode.ai/config.json",
"instructions": ["./custom-instructions.md"],
"provider": {
"openai": {
"options": {
"apiKey": "{file:~/.secrets/openai-key}"
}
}
}
}ファイルパスは次のとおりです。
- 設定ファイルのディレクトリからの相対パス
- または、
/または~で始まる絶対パス
これらは次の場合に役立ちます。
- API キーなどの機密データを別のファイルに保存します。
- 設定を乱雑にすることなく、大きな指示ファイルを含めることができます。
- 複数の設定ファイル間で共通の設定スニペットを共有します。