Config - OpenCode

You shouldn’t have to configure OpenCode manually. Ask OpenCode to update its configuration for you.

Format

OpenCode supports both JSON and JSONC (JSON with Comments) configuration files.

opencode.jsonc

{
  "$schema": "https://opencode.ai/config.json",
  "model": "openai/gpt-5.2-custom",
  "providers": {
    "openai": {
      "models": {
        "gpt-5.2-custom": {
          "modelID": "gpt-5.2",
          "name": "GPT-5.2 Custom"
        }
      }
    }
  }
}

Locations

OpenCode loads global configuration from:

~/.config/opencode/opencode.json(c)

Project-specific configuration can use either form:

/home/user/projects/my-app/opencode.json(c)
/home/user/projects/my-app/.opencode/opencode.json(c)

When OpenCode starts, it searches for configuration files from the current directory upward to the project root. It merges direct opencode.json(c) files from the project root toward the current directory, then does the same for files inside .opencode directories. A .opencode config therefore overrides every direct config, even when the direct config is closer to the current directory. Avoid mixing the two forms across one project hierarchy unless this precedence is intentional. For example, consider a monorepo with OpenCode started from /home/user/projects/acme/packages/web:

~/.config/opencode/opencode.json

/home/user/projects/acme/
├── opencode.json
└── packages/
    └── web/
        ├── opencode.json
        └── src/

OpenCode applies these files from lowest to highest precedence:

~/.config/opencode/opencode.json
/home/user/projects/acme/opencode.json
/home/user/projects/acme/packages/web/opencode.json

In this direct-config example, the package config overrides matching settings from the repository config, which overrides matching settings from the global config. Settings that do not conflict are preserved from every file.

Schema

The complete OpenCode configuration schema is available at opencode.ai/config.json. Add the $schema field to your configuration file to enable validation and autocomplete in editors that support JSON Schema:

opencode.json

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

Use the schema as the source of truth for available fields, accepted values, and nested configuration shapes.

Shell

Set the shell used by the terminal and shell tools.

{
  "shell": "/bin/zsh"
}

Model

Set the default model in provider/model format. The root default currently does not retain a #variant; select variants in the TUI or on an agent or command.

{
  "model": "anthropic/claude-sonnet-4-5"
}

See the models guide for model selection and local models.

Default agent

Choose the primary agent used when a session does not select one explicitly.

{
  "default_agent": "build"
}

See the agents guide for built-in and custom agents.

Autoupdate

Control automatic updates from the global config. Set this to false to disable updates. The current beta treats true and "notify" identically and automatically installs compatible non-major updates; project-level values are ignored.

{
  "autoupdate": false
}

Set the intended session sharing policy. V2 accepts this field, but session sharing is not implemented yet.

{
  "share": "manual"
}

See the sharing guide for more details.

Username

Set a username for future display behavior. V2 accepts this field but does not currently display it in conversations.

{
  "username": "alice"
}

Permissions

Define ordered rules that allow, deny, or ask before an agent uses a tool on a matching resource.

{
  "permissions": [
    {
      "action": "shell",
      "resource": "git push *",
      "effect": "ask"
    }
  ]
}

See the permissions guide for rule matching and available actions.

Agents

Override built-in agents or define specialized agents with their own model, instructions, mode, and permissions.

{
  "agents": {
    "reviewer": {
      "description": "Review changes without editing files",
      "mode": "subagent",
      "system": "Focus on correctness, security, and missing tests.",
      "permissions": [
        { "action": "edit", "resource": "*", "effect": "deny" }
      ]
    }
  }
}

See the agents guide for all agent options and file-based agents.

Snapshots

Enable or disable filesystem snapshots used by undo and revert behavior.

{
  "snapshots": false
}

See the snapshots guide for undo and redo behavior.

Watcher

Ignore files and directories that should not trigger filesystem updates.

{
  "watcher": {
    "ignore": ["dist/**", "coverage/**"]
  }
}

Formatter

Define formatter settings for compatibility and future use. V2 accepts this field, but it does not run formatters yet.

{
  "formatter": {
    "prettier": {
      "command": ["bunx", "prettier", "--write", "$FILE"],
      "extensions": [".js", ".ts", ".tsx"]
    }
  }
}

See the formatters guide for accepted fields and current limitations.

LSP

Define language server settings for compatibility and future use. V2 accepts this field, but it does not start language servers yet.

{
  "lsp": {
    "typescript": {
      "command": ["typescript-language-server", "--stdio"],
      "extensions": [".ts", ".tsx"]
    }
  }
}

See the LSP guide for accepted fields and current limitations.

Attachments

Control how oversized images loaded by the read tool are resized or rejected before they are sent to a model.

{
  "attachments": {
    "image": {
      "auto_resize": true,
      "max_width": 2000,
      "max_height": 2000,
      "max_base64_bytes": 5242880
    }
  }
}

See the attachments guide for image processing and limits.

Tool output

Set the maximum number of lines and bytes retained from a tool result.

{
  "tool_output": {
    "max_lines": 2000,
    "max_bytes": 51200
  }
}

MCP

Configure local and remote Model Context Protocol servers. Global timeouts can be overridden by an individual server.

{
  "mcp": {
    "servers": {
      "playwright": {
        "type": "local",
        "command": ["bunx", "@playwright/mcp"]
      }
    }
  }
}

See the MCP guide for remote servers, OAuth, environment variables, and timeouts.

Compaction

Control automatic context compaction and how much recent context it preserves.

{
  "compaction": {
    "auto": true,
    "keep": {
      "tokens": 8000
    },
    "buffer": 20000
  }
}

See the compaction guide for automatic context management.

Session warming

Keep recently active model sessions warm with periodic transient requests. Warming is disabled by default; set it to true to use the four-minute idle interval and 30-minute active window.

{
  "warming": {
    "prompt": "Do not perform any work. Reply with exactly: OK",
    "interval": "4 minutes",
    "duration": "30 minutes"
  }
}

See the session warming guide for request behavior, customization, and cost considerations.

Skills

Add directories or URLs that OpenCode should search for agent skills.

{
  "skills": ["./team-skills", "https://example.com/.well-known/skills/"]
}

See the skills guide for skill structure and automatic discovery under .opencode/skills/.

Commands

Define reusable slash commands as named prompt templates.

{
  "commands": {
    "review": {
      "description": "Review the current changes",
      "template": "Review the current diff for correctness and missing tests."
    }
  }
}

See the commands guide for arguments, models, agents, and file-based commands.

Instructions

Declare additional instruction files, globs, or URLs. V2 accepts this field, but does not load these entries yet; use AGENTS.md for active instructions.

{
  "instructions": ["CONTRIBUTING.md", "docs/guidelines/*.md"]
}

See the instructions guide for project instructions and AGENTS.md.

References

Make local directories or Git repositories available as named supporting context.

{
  "references": {
    "docs": {
      "path": "../product-docs",
      "description": "Product behavior and terminology"
    },
    "effect": {
      "repository": "Effect-TS/effect",
      "branch": "main"
    }
  }
}

See the references guide for shorthand, visibility, and path resolution.

Plugins

Load plugins from packages or local files. Use the object form when a plugin accepts options.

{
  "plugins": [
    "opencode-example-plugin",
    {
      "package": "./plugins/local.ts",
      "options": {
        "enabled": true
      }
    }
  ]
}

See the plugins guide for plugin development and configuration.

Providers

Configure providers and add or override their models, request settings, headers, and model variants.

{
  "providers": {
    "openai": {
      "models": {
        "gpt-5.2-custom": {
          "modelID": "gpt-5.2",
          "name": "GPT-5.2 Custom",
          "limit": {
            "context": 200000,
            "output": 32000
          }
        }
      }
    }
  }
}

See the providers guide for credentials, custom endpoints, provider packages, and model configuration.

​Format

​Locations

​Schema

​Shell

​Model

​Default agent

​Autoupdate

​Sharing

​Username

​Permissions

​Agents

​Snapshots

​Watcher

​Formatter

​LSP

​Attachments

​Tool output

​MCP

​Compaction

​Session warming

​Skills

​Commands

​Instructions

​References

​Plugins

​Providers

Format

Locations

Schema

Shell

Model

Default agent

Autoupdate

Sharing

Username

Permissions

Agents

Snapshots

Watcher

Formatter

LSP

Attachments

Tool output

MCP

Compaction

Session warming

Skills

Commands

Instructions

References

Plugins

Providers