mirror of
https://github.com/openai/codex.git
synced 2025-12-03 18:35:00 +00:00
2.0 KiB
2.0 KiB
Execpolicy quickstart
Codex can enforce your own rules-based execution policy before it runs shell commands. Policies live in Starlark .codexpolicy files under ~/.codex/policy.
Create a policy
- Create a policy directory:
mkdir -p ~/.codex/policy. - Add one or more
.codexpolicyfiles in that folder. Codex automatically loads every.codexpolicyfile in there on startup. - Write
prefix_ruleentries to describe the commands you want to allow, prompt, or block:
prefix_rule(
pattern = ["git", ["push", "fetch"]],
decision = "prompt", # allow | prompt | forbidden
match = [["git", "push", "origin", "main"]], # examples that must match
not_match = [["git", "status"]], # examples that must not match
)
patternis a list of shell tokens, evaluated from left to right; wrap tokens in a nested list to express alternatives (for example, match bothpushandfetch).decisionsets the severity; Codex picks the strictest decision when multiple rules match (forbidden > prompt > allow).matchandnot_matchact as optional unit tests. Codex validates them when it loads your policy, so you get feedback if an example has unexpected behavior.
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.
Preview decisions
Use the codex execpolicy check subcommand to preview decisions before you save a rule (see the codex-execpolicy README for syntax details):
codex execpolicy check --policy ~/.codex/policy/default.codexpolicy git push origin main
Pass multiple --policy flags to test how several files combine, and use --pretty for formatted JSON output. See the codex-rs/execpolicy README for a more detailed walkthrough of the available syntax.
Status
execpolicy commands are still in preview. The API may have breaking changes in the future.