中文
文档
权限

权限

控制哪些操作需要审批才能运行。

OpenCode 使用 permission 配置来决定给定操作是自动运行、提示你确认还是被阻止。

v1.1.1 开始,旧版 tools 布尔配置已弃用并合并到 permission 中。旧的 tools 配置仍然支持向后兼容。


操作类型

每个权限规则解析为以下之一:

  • "allow" — 无需审批直接运行
  • "ask" — 提示审批
  • "deny" — 阻止操作

配置

你可以全局设置权限(使用 *),并覆盖特定工具。

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

你也可以一次性设置所有权限:

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

细粒度规则(对象语法)

对于大多数权限,你可以使用对象根据工具输入应用不同的操作。

opencode.json
{
  "$schema": "https://opencode.ai/config.json",
  "permission": {
    "bash": {
      "*": "ask",
      "git *": "allow",
      "npm *": "allow",
      "rm *": "deny",
      "grep *": "allow"
    },
    "edit": {
      "*": "deny",
      "packages/web/src/content/docs/*.mdx": "allow"
    }
  }
}

规则按模式匹配进行评估,最后匹配的规则优先。常见模式是将通配符 "*" 规则放在前面,更具体的规则放在后面。

通配符

权限模式使用简单的通配符匹配:

  • * 匹配零个或多个任意字符
  • ? 匹配恰好一个字符
  • 所有其他字符按字面匹配

主目录展开

你可以在模式开头使用 ~$HOME 来引用你的主目录。这对于 external_directory 规则特别有用。

  • ~/projects/* -> /Users/username/projects/*
  • $HOME/projects/* -> /Users/username/projects/*
  • ~ -> /Users/username

外部目录

使用 external_directory 允许工具调用访问 OpenCode 启动时工作目录之外的路径。这适用于任何以路径作为输入的工具(例如 readeditlistglobgrep 以及许多 bash 命令)。

主目录展开(如 ~/...)只影响模式的书写方式。它不会使外部路径成为当前工作区的一部分,因此工作目录之外的路径仍必须通过 external_directory 允许。

例如,这允许访问 ~/projects/personal/ 下的所有内容:

opencode.json
{
  "$schema": "https://opencode.ai/config.json",
  "permission": {
    "external_directory": {
      "~/projects/personal/**": "allow"
    }
  }
}

此处允许的任何目录都继承与当前工作区相同的默认值。由于 read 默认为 allowexternal_directory 下的条目也允许读取,除非被覆盖。当工具在这些路径中应受限制时,添加显式规则,例如阻止编辑但保留读取:

opencode.json
{
  "$schema": "https://opencode.ai/config.json",
  "permission": {
    "external_directory": {
      "~/projects/personal/**": "allow"
    },
    "edit": {
      "~/projects/personal/**": "deny"
    }
  }
}

将列表集中在受信任的路径上,并根据需要为其他工具(例如 bash)添加额外的允许或拒绝规则。


可用权限

OpenCode 权限按工具名称键入,外加几个安全保护:

  • read — 读取文件(匹配文件路径)
  • edit — 所有文件修改(涵盖 editwritepatchmultiedit
  • glob — 文件通配(匹配通配模式)
  • grep — 内容搜索(匹配正则表达式模式)
  • list — 列出目录中的文件(匹配目录路径)
  • bash — 运行 shell 命令(匹配解析后的命令如 git status --porcelain
  • task — 启动子代理(匹配子代理类型)
  • skill — 加载技能(匹配技能名称)
  • lsp — 运行 LSP 查询(目前非细粒度)
  • todoreadtodowrite — 读取/更新待办列表
  • webfetch — 获取 URL(匹配 URL)
  • websearchcodesearch — 网络/代码搜索(匹配查询)
  • external_directory — 当工具访问项目工作目录之外的路径时触发
  • doom_loop — 当相同的工具调用以相同输入重复 3 次时触发

默认值

如果你不指定任何内容,OpenCode 从宽松的默认值开始:

  • 大多数权限默认为 "allow"
  • doom_loopexternal_directory 默认为 "ask"
  • read"allow",但 .env 文件默认被拒绝:
opencode.json
{
  "permission": {
    "read": {
      "*": "allow",
      "*.env": "deny",
      "*.env.*": "deny",
      "*.env.example": "allow"
    }
  }
}

"Ask" 的作用

当 OpenCode 提示审批时,UI 提供三种结果:

  • once — 仅批准此次请求
  • always — 批准匹配建议模式的未来请求(在当前 OpenCode 会话的剩余时间内)
  • reject — 拒绝请求

always 将批准的模式集由工具提供(例如,bash 审批通常会将安全的命令前缀如 git status* 加入白名单)。


代理

你可以按代理覆盖权限。代理权限与全局配置合并,代理规则优先。了解更多关于代理权限的信息。

注意: 有关更详细的模式匹配示例,请参阅上面的细粒度规则(对象语法)部分。

opencode.json
{
  "$schema": "https://opencode.ai/config.json",
  "permission": {
    "bash": {
      "*": "ask",
      "git *": "allow",
      "git commit *": "deny",
      "git push *": "deny",
      "grep *": "allow"
    }
  },
  "agent": {
    "build": {
      "permission": {
        "bash": {
          "*": "ask",
          "git *": "allow",
          "git commit *": "ask",
          "git push *": "deny",
          "grep *": "allow"
        }
      }
    }
  }
}

你也可以在 Markdown 中配置代理权限:

~/.config/opencode/agents/review.md
---
description: Code review without edits
mode: subagent
permission:
  edit: deny
  bash: ask
  webfetch: deny
---
 
Only analyze code and suggest changes.

提示: 对带参数的命令使用模式匹配。"grep *" 允许 grep pattern file.txt,而单独的 "grep" 会阻止它。像 git status 这样的命令适用于默认行为,但在传递参数时需要显式权限(如 "git status *")。