Configuration

You can configure OpenCode using a JSON config file.

Format

OpenCode supports both JSON and JSONC (JSON with Comments) formats.

opencode.jsonc

{
  "$schema": "https://opencode.ai/config.json",
  // Theme configuration
  "theme": "opencode",
  "model": "anthropic/claude-sonnet-4-5",
  "autoupdate": true
}

Locations

You can place your config in a couple of different locations and they have a different order of precedence.

Configuration files are merged together, not replaced.

Configuration files are merged together, not replaced. Settings from the following config locations are combined. Later configs override earlier ones only for conflicting keys. Non-conflicting settings from all configs are preserved. For example, if your global config sets theme: "opencode" and autoupdate: true, and your project config sets model: "anthropic/claude-sonnet-4-5", the final configuration will include all three settings.

Precedence order

Config sources are loaded in this order (later sources override earlier ones):

Remote config (from .well-known/opencode) - organizational defaults
Global config (~/.config/opencode/opencode.json) - user preferences
Custom config (OPENCODE_CONFIG env var) - custom overrides
Project config (opencode.json in project) - project-specific settings
.opencode directories - agents, commands, plugins
Inline config (OPENCODE_CONFIG_CONTENT env var) - runtime overrides

This means project configs can override global defaults, and global configs can override remote organizational defaults.

The .opencode and ~/.config/opencode directories use plural names for subdirectories: agents/, commands/, modes/, plugins/, skills/, tools/, and themes/. Singular names (e.g., agent/) are also supported for backwards compatibility.

Remote

Organizations can provide default configuration via the .well-known/opencode endpoint. This is fetched automatically when you authenticate with a provider that supports it. Remote config is loaded first, serving as the base layer. All other config sources (global, project) can override these defaults. For example, if your organization provides MCP servers that are disabled by default:

Remote config from .well-known/opencode

{
  "mcp": {
    "jira": {
      "type": "remote",
      "url": "https://jira.example.com/mcp",
      "enabled": false
    }
  }
}

You can enable specific servers in your local config:

opencode.json

{
  "mcp": {
    "jira": {
      "type": "remote",
      "url": "https://jira.example.com/mcp",
      "enabled": true
    }
  }
}

Global

Place your global OpenCode config in ~/.config/opencode/opencode.json. Use global config for user-wide preferences like themes, providers, or keybinds. Global config overrides remote organizational defaults.

Per project

Add opencode.json in your project root. Project config has the highest precedence among standard config files - it overrides both global and remote configs.

Place project specific config in the root of your project.

When OpenCode starts up, it looks for a config file in the current directory or traverse up to the nearest Git directory. This is also safe to be checked into Git and uses the same schema as the global one.

Custom path

Specify a custom config file path using the OPENCODE_CONFIG environment variable.

export OPENCODE_CONFIG=/path/to/my/custom-config.json
opencode run "Hello world"

Custom config is loaded between global and project configs in the precedence order.

Custom directory

Specify a custom config directory using the OPENCODE_CONFIG_DIR environment variable. This directory will be searched for agents, commands, modes, and plugins just like the standard .opencode directory, and should follow the same structure.

export OPENCODE_CONFIG_DIR=/path/to/my/config-directory
opencode run "Hello world"

The custom directory is loaded after the global config and .opencode directories, so it can override their settings.

Schema

The config file has a schema that’s defined in opencode.ai/config.json. Your editor should be able to validate and autocomplete based on the schema.

Configuration Options

TUI

You can configure TUI-specific settings through the tui option.

opencode.json

{
  "$schema": "https://opencode.ai/config.json",
  "tui": {
    "scroll_speed": 3,
    "scroll_acceleration": {
      "enabled": true
    },
    "diff_style": "auto"
  }
}

tui.scroll_acceleration.enabled

boolean

Enable macOS-style scroll acceleration. Takes precedence over scroll_speed.

tui.scroll_speed

number

default:"3"

Custom scroll speed multiplier (minimum: 1). Ignored if scroll_acceleration.enabled is true.

tui.diff_style

string

default:"auto"

Control diff rendering. "auto" adapts to terminal width, "stacked" always shows single column.

Server

You can configure server settings for the opencode serve and opencode web commands through the server option.

opencode.json

{
  "$schema": "https://opencode.ai/config.json",
  "server": {
    "port": 4096,
    "hostname": "0.0.0.0",
    "mdns": true,
    "mdnsDomain": "myproject.local",
    "cors": ["http://localhost:5173"]
  }
}

server.port

number

Port to listen on.

server.hostname

string

default:"0.0.0.0"

Hostname to listen on. When mdns is enabled and no hostname is set, defaults to 0.0.0.0.

server.mdns

boolean

Enable mDNS service discovery. This allows other devices on the network to discover your OpenCode server.

server.mdnsDomain

string

default:"opencode.local"

Custom domain name for mDNS service. Useful for running multiple instances on the same network.

server.cors

string[]

Additional origins to allow for CORS when using the HTTP server from a browser-based client. Values must be full origins (scheme + host + optional port), eg https://app.example.com.

Tools

You can manage the tools an LLM can use through the tools option.

opencode.json

{
  "$schema": "https://opencode.ai/config.json",
  "tools": {
    "write": false,
    "bash": false
  }
}

Models

You can configure the providers and models you want to use in your OpenCode config through the provider, model and small_model options.

opencode.json

{
  "$schema": "https://opencode.ai/config.json",
  "provider": {},
  "model": "anthropic/claude-sonnet-4-5",
  "small_model": "anthropic/claude-haiku-4-5"
}

The small_model option configures a separate model for lightweight tasks like title generation. By default, OpenCode tries to use a cheaper model if one is available from your provider, otherwise it falls back to your main model. Provider options can include timeout and setCacheKey:

opencode.json

{
  "$schema": "https://opencode.ai/config.json",
  "provider": {
    "anthropic": {
      "options": {
        "timeout": 600000,
        "setCacheKey": true
      }
    }
  }
}

provider.{provider}.options.timeout

number

default:"300000"

Request timeout in milliseconds. Set to false to disable.

provider.{provider}.options.setCacheKey

boolean

Ensure a cache key is always set for designated provider.

Provider-Specific Options

Some providers support additional configuration options beyond the generic timeout and apiKey settings.

Amazon Bedrock

Amazon Bedrock supports AWS-specific configuration:

opencode.json

{
  "$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"
      }
    }
  }
}

provider.amazon-bedrock.options.region

string

default:"us-east-1"

AWS region for Bedrock (defaults to AWS_REGION env var or us-east-1).

provider.amazon-bedrock.options.profile

string

AWS named profile from ~/.aws/credentials (defaults to AWS_PROFILE env var).

provider.amazon-bedrock.options.endpoint

string

Custom endpoint URL for VPC endpoints. This is an alias for the generic baseURL option using AWS-specific terminology. If both are specified, endpoint takes precedence.

Bearer tokens (AWS_BEARER_TOKEN_BEDROCK or /connect) take precedence over profile-based authentication.

Themes

You can configure the theme you want to use in your OpenCode config through the theme option.

opencode.json

{
  "$schema": "https://opencode.ai/config.json",
  "theme": "opencode"
}

Agents

You can configure specialized agents for specific tasks through the agent option.

opencode.jsonc

{
  "$schema": "https://opencode.ai/config.json",
  "agent": {
    "code-reviewer": {
      "description": "Reviews code for best practices and potential issues",
      "model": "anthropic/claude-sonnet-4-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
      }
    }
  }
}

You can also define agents using markdown files in ~/.config/opencode/agents/ or .opencode/agents/.

Default agent

You can set the default agent using the default_agent option. This determines which agent is used when none is explicitly specified.

opencode.json

{
  "$schema": "https://opencode.ai/config.json",
  "default_agent": "plan"
}

The default agent must be a primary agent (not a subagent). This can be a built-in agent like "build" or "plan", or a custom agent you’ve defined. If the specified agent doesn’t exist or is a subagent, OpenCode will fall back to "build" with a warning. This setting applies across all interfaces: TUI, CLI (opencode run), desktop app, and GitHub Action. You can configure the share feature through the share option.

opencode.json

{
  "$schema": "https://opencode.ai/config.json",
  "share": "manual"
}

This takes:

"manual" - Allow manual sharing via commands (default)
"auto" - Automatically share new conversations
"disabled" - Disable sharing entirely

By default, sharing is set to manual mode where you need to explicitly share conversations using the /share command.

Commands

You can configure custom commands for repetitive tasks through the command option.

opencode.jsonc

{
  "$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-4-5"
    },
    "component": {
      "template": "Create a new React component named $ARGUMENTS with TypeScript support.\nInclude proper typing and basic structure.",
      "description": "Create a new component"
    }
  }
}

You can also define commands using markdown files in ~/.config/opencode/commands/ or .opencode/commands/.

Keybinds

You can customize your keybinds through the keybinds option.

opencode.json

{
  "$schema": "https://opencode.ai/config.json",
  "keybinds": {}
}

Autoupdate

OpenCode will automatically download any new updates when it starts up. You can disable this with the autoupdate option.

opencode.json

{
  "$schema": "https://opencode.ai/config.json",
  "autoupdate": false
}

If you don’t want updates but want to be notified when a new version is available, set autoupdate to "notify".

This only works if it was not installed using a package manager such as Homebrew.

Formatters

You can configure code formatters through the formatter option.

opencode.json

{
  "$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"]
    }
  }
}

Permissions

By default, opencode allows all operations without requiring explicit approval. You can change this using the permission option. For example, to ensure that the edit and bash tools require user approval:

opencode.json

{
  "$schema": "https://opencode.ai/config.json",
  "permission": {
    "edit": "ask",
    "bash": "ask"
  }
}

Compaction

You can control context compaction behavior through the compaction option.

opencode.json

{
  "$schema": "https://opencode.ai/config.json",
  "compaction": {
    "auto": true,
    "prune": true,
    "reserved": 10000
  }
}

compaction.auto

boolean

default:"true"

Automatically compact the session when context is full.

compaction.prune

boolean

default:"true"

Remove old tool outputs to save tokens.

compaction.reserved

number

default:"10000"

Token buffer for compaction. Leaves enough window to avoid overflow during compaction.

Watcher

You can configure file watcher ignore patterns through the watcher option.

opencode.json

{
  "$schema": "https://opencode.ai/config.json",
  "watcher": {
    "ignore": ["node_modules/**", "dist/**", ".git/**"]
  }
}

Patterns follow glob syntax. Use this to exclude noisy directories from file watching.

MCP servers

You can configure MCP servers you want to use through the mcp option.

opencode.json

{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {}
}

Plugins

Plugins extend OpenCode with custom tools, hooks, and integrations. Place plugin files in .opencode/plugins/ or ~/.config/opencode/plugins/. You can also load plugins from npm through the plugin option.

opencode.json

{
  "$schema": "https://opencode.ai/config.json",
  "plugin": ["opencode-helicone-session", "@my-org/custom-plugin"]
}

Instructions

You can configure the instructions for the model you’re using through the instructions option.

opencode.json

{
  "$schema": "https://opencode.ai/config.json",
  "instructions": ["CONTRIBUTING.md", "docs/guidelines.md", ".cursor/rules/*.md"]
}

This takes an array of paths and glob patterns to instruction files.

Disabled providers

You can disable providers that are loaded automatically through the disabled_providers option. This is useful when you want to prevent certain providers from being loaded even if their credentials are available.

opencode.json

{
  "$schema": "https://opencode.ai/config.json",
  "disabled_providers": ["openai", "gemini"]
}

The disabled_providers takes priority over enabled_providers.

The disabled_providers option accepts an array of provider IDs. When a provider is disabled:

It won’t be loaded even if environment variables are set.
It won’t be loaded even if API keys are configured through the /connect command.
The provider’s models won’t appear in the model selection list.

Enabled providers

You can specify an allowlist of providers through the enabled_providers option. When set, only the specified providers will be enabled and all others will be ignored.

opencode.json

{
  "$schema": "https://opencode.ai/config.json",
  "enabled_providers": ["anthropic", "openai"]
}

This is useful when you want to restrict OpenCode to only use specific providers rather than disabling them one by one.

The disabled_providers takes priority over enabled_providers.

If a provider appears in both enabled_providers and disabled_providers, the disabled_providers takes priority for backwards compatibility.

Experimental

The experimental key contains options that are under active development.

opencode.json

{
  "$schema": "https://opencode.ai/config.json",
  "experimental": {}
}

Experimental options are not stable. They may change or be removed without notice.

Variables

You can use variable substitution in your config files to reference environment variables and file contents.

Env vars

Use {env:VARIABLE_NAME} to substitute environment variables:

opencode.json

{
  "$schema": "https://opencode.ai/config.json",
  "model": "{env:OPENCODE_MODEL}",
  "provider": {
    "anthropic": {
      "models": {},
      "options": {
        "apiKey": "{env:ANTHROPIC_API_KEY}"
      }
    }
  }
}

If the environment variable is not set, it will be replaced with an empty string.

Files

Use {file:path/to/file} to substitute the contents of a file:

opencode.json

{
  "$schema": "https://opencode.ai/config.json",
  "instructions": ["./custom-instructions.md"],
  "provider": {
    "openai": {
      "options": {
        "apiKey": "{file:~/.secrets/openai-key}"
      }
    }
  }
}

File paths can be:

Relative to the config file directory
Or absolute paths starting with / or ~

These are useful for:

Keeping sensitive data like API keys in separate files.
Including large instruction files without cluttering your config.
Sharing common configuration snippets across multiple config files.

Get Started

Core Concepts

Integrations

Extensibility

Interfaces

Advanced

Enterprise

​Format

​Locations

​Precedence order

​Remote

​Global

​Per project

​Custom path

​Custom directory

​Schema

​Configuration Options

​TUI

​Server

​Tools

​Models

​Provider-Specific Options

Amazon Bedrock

​Themes

​Agents

​Default agent

​Sharing

​Commands

​Keybinds

​Autoupdate

​Formatters

​Permissions

​Compaction

​Watcher

​MCP servers

​Plugins

​Instructions

​Disabled providers

​Enabled providers

​Experimental

​Variables

​Env vars

​Files

Format

Locations

Precedence order

Remote

Global

Per project

Custom path

Custom directory

Schema

Configuration Options

TUI

Server

Tools

Models

Provider-Specific Options

Themes

Agents

Default agent

Sharing

Commands

Keybinds

Autoupdate

Formatters

Permissions

Compaction

Watcher

MCP servers

Plugins

Instructions

Disabled providers

Enabled providers

Experimental

Variables

Env vars

Files