Skip to content

Commit 74a7567

Browse files
authored
update execpolicy quickstart readme (#6952)
1 parent 92e3046 commit 74a7567

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,12 +69,12 @@ Codex can access MCP servers. To configure them, refer to the [config docs](./do
6969

7070
Codex CLI supports a rich set of configuration options, with preferences stored in `~/.codex/config.toml`. For full configuration options, see [Configuration](./docs/config.md).
7171

72-
### Execpolicy quickstart
72+
### Execpolicy Quickstart
7373

7474
Codex can enforce your own rules-based execution policy before it runs shell commands.
7575

7676
1. Create a policy directory: `mkdir -p ~/.codex/policy`.
77-
2. Create one or more `.codexpolicy` files into that folder. Codex automatically loads every `.codexpolicy` file in there on startup.
77+
2. Create one or more `.codexpolicy` files in that folder. Codex automatically loads every `.codexpolicy` file in there on startup.
7878
3. Write `prefix_rule` entries to describe the commands you want to allow, prompt, or block:
7979

8080
```starlark
@@ -87,14 +87,12 @@ prefix_rule(
8787
```
8888

8989
- `pattern` is a list of shell tokens, evaluated from left to right; wrap tokens in a nested list to express alternatives (e.g., match both `push` and `fetch`).
90-
- `decision` sets the severity; Codex picks the strictest decision when multiple rules match.
90+
- `decision` sets the severity; Codex picks the strictest decision when multiple rules match (forbidden > prompt > allow).
9191
- `match` and `not_match` act as (optional) unit tests. Codex validates them when it loads your policy, so you get feedback if an example has unexpected behavior.
9292

9393
In this example rule, if Codex wants to run commands with the prefix `git push` or `git fetch`, it will first ask for user approval.
9494

95-
Note: If Codex wants to run a command that matches with multiple rules, it will use the strictest decision among the matched rules (forbidden > prompt > allow).
96-
97-
Use the [`execpolicy2` CLI](./codex-rs/execpolicy2/README.md) to preview decisions before you save a rule:
95+
Use [`execpolicy2` CLI](./codex-rs/execpolicy2/README.md) to preview decisions for policy files:
9896

9997
```shell
10098
cargo run -p codex-execpolicy2 -- check --policy ~/.codex/policy/default.codexpolicy git push origin main

0 commit comments

Comments
 (0)