主题
策略引擎
Gemini CLI 包含一个强大的策略引擎,提供对工具执行的细粒度控制。它允许用户和管理员定义规则,确定工具调用应该被允许、拒绝还是需要用户确认。
快速开始
创建你的第一个策略:
- 创建策略目录(如果不存在):bash
mkdir -p ~/.gemini/policies - 创建新的策略文件(例如
~/.gemini/policies/my-rules.toml)。你可以使用任何以.toml结尾的文件名;此目录中的所有此类文件都将被加载和合并:toml[[rule]] toolName = "run_shell_command" commandPrefix = "git status" decision = "allow" priority = 100 - 运行触发策略的命令(例如,要求 Gemini CLI 执行
git status)。该工具现在将自动执行,无需提示确认。
核心概念
策略引擎基于一组规则运行。每个规则是条件和结果决策的组合。当大型语言模型想要执行工具时,策略引擎评估所有规则以找到与工具调用匹配的最高优先级规则。
规则由以下主要组件组成:
- 条件:工具调用必须满足的标准才能使规则适用。这可以包括工具的名称、提供给它的参数或当前的批准模式。
- 决策:如果规则匹配要采取的操作(
allow、deny或ask_user)。 - 优先级:确定规则优先顺序的数字。数字越高优先级越高。
例如,此规则将在执行任何 git 命令之前请求用户确认。
toml
[[rule]]
toolName = "run_shell_command"
commandPrefix = "git "
decision = "ask_user"
priority = 100条件
条件是工具调用必须满足的标准才能使规则适用。主要条件是工具的名称及其参数。
工具名称
规则中的 toolName 必须与被调用工具的名称匹配。
- 通配符:对于 Model-hosting-protocol (MCP) 服务器,你可以使用通配符。
toolName为my-server__*将匹配来自my-serverMCP 的任何工具。
参数模式
如果指定了 argsPattern,工具的参数将被转换为稳定的 JSON 字符串,然后针对提供的正则表达式进行测试。如果参数不匹配模式,规则不适用。
决策
规则可以执行三种可能的决策:
allow:工具调用自动执行,无需用户交互。deny:工具调用被阻止且不执行。ask_user:提示用户批准或拒绝工具调用。(在非交互模式下,这被视为deny。)
优先级系统和层级
策略引擎使用复杂的优先级系统来解决多个规则匹配单个工具调用时的冲突。核心原则很简单:优先级最高的规则获胜。
为提供清晰的层次结构,策略被组织成三个层级。每个层级有一个指定的数字,构成最终优先级计算的基础。
| 层级 | 基数 | 描述 |
|---|---|---|
| Default | 1 | Gemini CLI 附带的内置策略。 |
| User | 2 | 用户定义的自定义策略。 |
| Admin | 3 | 由管理员管理的策略(例如在企业环境中)。 |
在 TOML 策略文件中,你分配一个从 0 到 999 的优先级值。引擎使用以下公式将其转换为最终优先级:
final_priority = tier_base + (toml_priority / 1000)
此系统保证:
- Admin 策略始终覆盖 User 和 Default 策略。
- User 策略始终覆盖 Default 策略。
- 你仍然可以在单个层级内以细粒度控制排序规则。
例如:
- Default 策略文件中的
priority: 50规则变为1.050。 - User 策略文件中的
priority: 100规则变为2.100。 - Admin 策略文件中的
priority: 20规则变为3.020。
批准模式
批准模式允许策略引擎根据 CLI 的操作模式应用不同的规则集。规则可以与一个或多个模式关联(例如 yolo、autoEdit)。只有当 CLI 在其指定模式之一中运行时,规则才会激活。如果规则没有指定模式,它始终激活。
规则匹配
当进行工具调用时,引擎从最高优先级开始检查所有活动规则。第一个匹配的规则决定结果。
如果满足所有条件,规则匹配工具调用:
- 工具名称:规则中的
toolName必须与被调用工具的名称匹配。- 通配符:对于 Model-hosting-protocol (MCP) 服务器,你可以使用通配符。
toolName为my-server__*将匹配来自my-serverMCP 的任何工具。
- 通配符:对于 Model-hosting-protocol (MCP) 服务器,你可以使用通配符。
- 参数模式:如果指定了
argsPattern,工具的参数将被转换为稳定的 JSON 字符串,然后针对提供的正则表达式进行测试。如果参数不匹配模式,规则不适用。
配置
策略在 .toml 文件中定义。CLI 从 Default、User 和(如果配置)Admin 目录加载这些文件。
TOML 规则模式
以下是 TOML 策略规则中可用字段的细分:
toml
[[rule]]
# 工具的唯一名称,或名称数组。
toolName = "run_shell_command"
# (可选)MCP 服务器的名称。可以与 toolName 组合
# 形成复合名称如 "mcpName__toolName"。
mcpName = "my-custom-server"
# (可选)用于匹配工具参数的正则表达式。
argsPattern = '"command":"(git|npm)'
# (可选)shell 命令必须以其开头的字符串或字符串数组。
# 这是 `toolName = "run_shell_command"` 和 `argsPattern` 的语法糖。
commandPrefix = "git "
# (可选)用于匹配整个 shell 命令的正则表达式。
# 这也是 `toolName = "run_shell_command"` 的语法糖。
# 注意:此模式针对参数的 JSON 表示进行测试(例如 `{"command":"<your_command>"}`),
# 因此像 `^` 或 `$` 这样的锚点将应用于完整的 JSON 字符串,而不仅仅是命令文本。
# 你不能在同一规则中使用 commandPrefix 和 commandRegex。
commandRegex = "^git (commit|push)"
# 要采取的决策。必须是 "allow"、"deny" 或 "ask_user"。
decision = "ask_user"
# 规则的优先级,从 0 到 999。
priority = 10
# (可选)此规则激活的批准模式数组。
modes = ["autoEdit"]使用数组(列表)
要将同一规则应用于多个工具或命令前缀,你可以为 toolName 和 commandPrefix 字段提供字符串数组。
示例:
此单一规则将应用于 write_file 和 replace 工具。
toml
[[rule]]
toolName = ["write_file", "replace"]
decision = "ask_user"
priority = 10run_shell_command 的特殊语法
为简化为 run_shell_command 编写策略,你可以使用 commandPrefix 或 commandRegex 代替更复杂的 argsPattern。
commandPrefix:如果command参数以给定字符串开头则匹配。commandRegex:如果command参数匹配给定的正则表达式则匹配。
示例:
此规则将在执行任何 git 命令之前请求用户确认。
toml
[[rule]]
toolName = "run_shell_command"
commandPrefix = "git "
decision = "ask_user"
priority = 100MCP 工具的特殊语法
你可以使用 mcpName 字段或通配符模式创建针对 Model-hosting-protocol (MCP) 服务器工具的规则。
1. 使用 mcpName
要针对特定服务器上的特定工具,组合 mcpName 和 toolName。
toml
# 允许 `my-jira-server` MCP 上的 `search` 工具
[[rule]]
mcpName = "my-jira-server"
toolName = "search"
decision = "allow"
priority = 2002. 使用通配符
要创建适用于特定 MCP 服务器上_所有_工具的规则,只需指定 mcpName。
toml
# 拒绝来自 `untrusted-server` MCP 的所有工具
[[rule]]
mcpName = "untrusted-server"
decision = "deny"
priority = 500默认策略
Gemini CLI 附带一组默认策略,以提供安全的开箱即用体验。
- 只读工具(如
read_file、glob)通常被允许。 - 代理委托(如
delegate_to_agent)被允许(子代理操作单独检查)。 - 写入工具(如
write_file、run_shell_command)默认为ask_user。 - 在
yolo模式下,高优先级规则允许所有工具。 - 在
autoEdit模式下,规则允许某些写操作无需提示即可执行。