Skip to content
OpenCode
首页文档

配置

使用 OpenCode JSON 配置。

你可以使用 JSON 配置文件来配置 OpenCode。

格式

OpenCode 同时支持 JSON 和 JSONC（带注释的 JSON）格式。

opencode.jsonc
{
  "$schema": "https://opencode.ai/config.json",
  // 主题配置
  "theme": "opencode",
  "model": "anthropic/claude-sonnet-4-5",
  "autoupdate": true,
}

存放位置

你可以将配置文件放在几个不同的位置，它们具有不同的优先级顺序。

配置文件是合并在一起的，而不是被替换。来自以下配置位置的设置会被合并。只有在键冲突时，后加载的配置才会覆盖先前的配置。所有配置中的非冲突设置都会被保留。

例如，如果你的全局配置设置了 theme: "opencode" 和 autoupdate: true，而你的项目配置设置了 model: "anthropic/claude-sonnet-4-5"，那么最终的配置将包含所有这三个设置。

全局配置

将你的全局 OpenCode 配置放在 ~/.config/opencode/opencode.json 中。你可能希望将主题、提供商或快捷键绑定等设置放在全局配置中。

按项目配置

你也可以在你的项目中添加一个 opencode.json。此配置中的设置会与全局配置合并，并且可以覆盖全局配置。这对于配置特定于你项目的提供商或模式非常有用。

当 OpenCode 启动时，它会在当前目录中查找配置文件，或者向上遍历到最近的 Git 目录。

此文件也可以安全地提交到 Git 中，并且使用与全局配置相同的模式。

自定义路径

你也可以使用 OPENCODE_CONFIG 环境变量来指定一个自定义的配置文件路径。

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

此配置中的设置会与全局和项目配置合并，并且可以覆盖它们。

自定义目录

你可以使用 OPENCODE_CONFIG_DIR 环境变量来指定一个自定义配置目录。这个目录将像标准的 .opencode 目录一样被搜索，用于查找代理、命令、模式和插件，并且应该遵循相同的结构。

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

自定义目录在全局配置和 .opencode 目录之后加载，因此它可以覆盖它们的设置。

模式

配置文件有一个模式，定义在 opencode.ai/config.json。

你的编辑器应该能够根据该模式进行验证和自动补全。

TUI

你可以通过 tui 选项来配置 TUI 特定的设置。

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

可用选项：

  • scroll_acceleration.enabled - 启用 macOS 风格的滚动加速。优先级高于 scroll_speed。
  • scroll_speed - 自定义滚动速度乘数（默认值：1，最小值：1）。如果 scroll_acceleration.enabled 为 true，则此选项被忽略。
  • diff_style - 控制差异渲染。"auto" 根据终端宽度自适应，"stacked" 始终显示单列。

在此处了解更多关于使用 TUI 的信息。

服务器

你可以通过 server 选项来配置 opencode serve 和 opencode web 命令的服务器设置。

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

可用选项：

  • port - 要监听的端口。
  • hostname - 要监听的主机名。当启用了 mdns 且未设置主机名时，默认为 0.0.0.0。
  • mdns - 启用 mDNS 服务发现。这允许网络上的其他设备发现你的 OpenCode 服务器。
  • cors - 当从基于浏览器的客户端使用 HTTP 服务器时，允许的额外 CORS 来源。值必须是完整的来源（协议 + 主机 + 可选端口），例如 https://app.example.com。

在此了解更多关于服务器的信息。

工具

你可以通过 tools 选项来管理 LLM 可以使用的工具。

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

在此了解更多关于工具的信息。

模型

您可以通过 provider、model 和 small_model 选项在 OpenCode 配置中配置您想要使用的提供商和模型。

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

small_model 选项用于为标题生成等轻量级任务配置一个单独的模型。默认情况下，如果您的提供商有更便宜的模型可用，OpenCode 会尝试使用它，否则将回退到您的主模型。

提供商选项可以包括 timeout 和 setCacheKey：

opencode.json
{
  "$schema": "https://opencode.ai/config.json",
  "provider": {
    "anthropic": {
      "options": {
        "timeout": 600000,
        "setCacheKey": true
      }
    }
  }
}
  • timeout - 请求超时时间（单位：毫秒，默认值：300000）。设置为 false 以禁用。
  • setCacheKey - 确保始终为指定的提供商设置缓存键。

您也可以配置本地模型。了解更多。

主题

您可以通过 theme 选项在 OpenCode 配置中配置您想要使用的主题。

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

在此处了解更多。

代理

您可以通过 agent 选项为特定任务配置专门的代理。

opencode.jsonc
{
  "$schema": "https://opencode.ai/config.json",
  "agent": {
    "code-reviewer": {
      "description": "审查代码以遵循最佳实践并发现潜在问题",
      "model": "anthropic/claude-sonnet-4-5",
      "prompt": "你是一名代码审查员。专注于安全性、性能和可维护性。",
      "tools": {
        // 为仅用于审查的代理禁用文件修改工具
        "write": false,
        "edit": false,
      },
    },
  },
}

您也可以在 ~/.config/opencode/agent/ 或 .opencode/agent/ 目录中使用 markdown 文件定义代理。在此了解更多。

默认代理

您可以使用 default_agent 选项设置默认代理。这决定了在未明确指定时使用哪个代理。

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

默认代理必须是主代理（而非子代理）。这可以是内置代理如 "build" 或 "plan"，也可以是您定义的自定义代理。如果指定的代理不存在或是子代理，OpenCode 将回退到 "build" 并发出警告。

此设置适用于所有界面：TUI、CLI (opencode run)、桌面应用和 GitHub Action。

分享

您可以通过 share 选项配置分享功能。

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

此选项接受：

  • "manual" - 允许通过命令手动分享（默认）
  • "auto" - 自动分享新对话
  • "disabled" - 完全禁用分享

默认情况下，分享设置为手动模式，您需要使用 /share 命令显式分享对话。

命令

您可以通过 command 选项为重复性任务配置自定义命令。

opencode.jsonc
{
  "$schema": "https://opencode.ai/config.json",
  "command": {
    "test": {
      "template": "运行完整的测试套件并生成覆盖率报告，显示任何失败的测试。\n重点关注失败的测试并建议修复方案。",
      "description": "运行测试并生成覆盖率报告",
      "agent": "build",
      "model": "anthropic/claude-haiku-4-5",
    },
    "component": {
      "template": "创建一个名为 $ARGUMENTS 的新 React 组件，支持 TypeScript。\n包含适当的类型定义和基本结构。",
      "description": "创建一个新组件",
    },
  },
}

您也可以在 ~/.config/opencode/command/ 或 .opencode/command/ 目录下使用 markdown 文件定义命令。在此了解更多。

快捷键绑定

您可以通过 keybinds 选项自定义快捷键绑定。

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

在此了解更多。

自动更新

OpenCode 在启动时会自动下载任何新更新。您可以使用 autoupdate 选项禁用此功能。

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

如果您不希望自动更新，但希望在有新版本可用时收到通知，请将 autoupdate 设置为 "notify"。

格式化器

您可以通过 formatter 选项配置代码格式化器。

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

在此了解更多关于格式化器的信息。

权限

默认情况下，opencode 允许所有操作，无需显式批准。您可以使用 permission 选项来更改此设置。

例如，要确保 edit 和 bash 工具需要用户批准：

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

在此处了解更多关于权限的信息。

压缩

您可以通过 compaction 选项控制上下文压缩行为。

opencode.json
{
  "$schema": "https://opencode.ai/config.json",
  "compaction": {
    "auto": true,
    "prune": true
  }
}
  • auto - 当上下文已满时自动压缩会话（默认值：true）。
  • prune - 移除旧的工具输出以节省 token（默认值：true）。

文件监视器

您可以通过 watcher 选项配置文件监视器的忽略模式。

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

模式遵循 glob 语法。使用此选项可以从文件监视中排除嘈杂的目录。

MCP 服务器

您可以通过 mcp 选项配置要使用的 MCP 服务器。

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

在此处了解更多信息。

插件

插件 通过自定义工具、钩子和集成来扩展 OpenCode。

将插件文件放置在 .opencode/plugin/ 或 ~/.config/opencode/plugin/ 目录下。您也可以通过 plugin 选项从 npm 加载插件。

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

在此处了解更多信息。

指令

你可以通过 instructions 选项为你正在使用的模型配置指令。

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

该选项接受一个包含文件路径和 glob 模式的数组，用于指定指令文件。在此了解更多关于规则的信息。

禁用的提供者

你可以通过 disabled_providers 选项禁用那些会自动加载的提供者。当你希望即使某些提供者的凭证可用也阻止其加载时，这很有用。

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

disabled_providers 选项接受一个提供者 ID 的数组。当一个提供者被禁用时：

  • 即使环境变量已设置，它也不会被加载。
  • 即使通过 /connect 命令配置了 API 密钥，它也不会被加载。
  • 该提供者的模型将不会出现在模型选择列表中。

启用的提供者

你可以通过 enabled_providers 选项指定一个允许列表。设置后，只有指定的提供者会被启用，所有其他提供者将被忽略。

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

当你希望限制 OpenCode 仅使用特定提供者，而不是逐个禁用它们时，这很有用。

如果一个提供者同时出现在 enabled_providers 和 disabled_providers 中，为了向后兼容性，disabled_providers 的优先级更高。

实验性功能

experimental 键包含正在积极开发中的选项。

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

变量

你可以在配置文件中使用变量替换来引用环境变量和文件内容。

环境变量

使用 {env:VARIABLE_NAME} 来替换环境变量：

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

如果环境变量未设置，它将被替换为空字符串。

文件

使用 {file:path/to/file} 来替换文件的内容：

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

文件路径可以是：

  • 相对于配置文件目录的路径
  • 或以 / 或 ~ 开头的绝对路径

这些功能对于以下情况非常有用：

  • 将敏感数据（如 API 密钥）保存在单独的文件中。
  • 包含大型指令文件而不会使配置文件变得杂乱。
  • 在多个配置文件之间共享通用配置片段。