Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/xxyoudeadpunkxx/canon-boundary-guard-codex/llms.txt

Use this file to discover all available pages before exploring further.

This guide walks through adding Canon Boundary Guard to Codex, enabling the optional PreToolUse hook, and starting your first session with the provenance frame active. The whole process takes a few minutes. The hook is optional but recommended for sessions where repository content, project rules, or AGENTS.md authority may matter.

​
Prerequisites

  • Codex is installed and running on your machine.
  • You have access to the Codex plugin marketplace or can add plugins by repository URL.

​
Installation

1

Add the repository to Codex

Run the following command to register the plugin repository with Codex:
codex plugin marketplace add XxYouDeaDPunKxX/canon-boundary-guard-codex
This makes the plugin available in your local Codex plugin list.
2

Install or enable the plugin

Open Codex and navigate to the plugin picker or plugin list. In Codex UIs that support slash commands, open it with:
/plugins
Find Canon Boundary Guard in the list and install or enable it.
3

Start a new thread and activate the frame

Start a new thread and ask Codex to use the plugin:
Use Canon Boundary Guard for this session.
You can also invoke the bundled skill directly by name:
Use $canon-boundary-guard for this session.
When the skill activates, Codex reads the full SKILL.md before responding and adopts the provenance frame silently for the rest of the session. No confirmation message is required.
4

Enable the hook (recommended)

The bundled PreToolUse hook re-surfaces the compact classification frame before matched write tools. To enable it, add the following to your Codex config.toml:
[features]
hooks = true
plugin_hooks = true
Then restart Codex. Plugin-bundled hooks are off by default and do not run until trusted.
  • If your Codex UI exposes a hook review view, open it with /hooks to review and trust the bundled hook.
  • In editor integrations where /hooks is not available, open the plugin details or approve the hook when Codex shows the trust prompt.
The hook fires for apply_patch, Write, and Edit tool calls. It emits the frame as model-visible context and as a systemMessage in the UI. It does not block or rewrite any operation.
The hook is recommended for sessions where repository content, project rules, naming conventions, workflows, or AGENTS.md authority may be relevant. The skill works without it — the hook is a reinforcement point, not the core mechanism.
If your system uses python3 instead of python, the default hook command will not resolve correctly. Adjust the command field in the hook definition inside your local plugin copy, or configure an equivalent hook in your Codex config.toml.

​
Standalone Skill Alternative

If you prefer not to use the plugin system, the older standalone skill layout is preserved in the standalone-skill-v1 branch of the repository. Check out that branch and copy the canon-boundary-guard/ folder into your Codex skills directory. Note that the hook is not available in the standalone layout — you would need to configure it manually.

Build docs developers (and LLMs) love

Get started for freeTalk to us