Skip to content

docs: document the agent hooks and their trust requirement #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mjun0812 merged 1 commit into from
Sep 8, 2026
Merged

docs: document the agent hooks and their trust requirement #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,10 @@ your-project/
- `.codex/hooks.json`: the same `PostToolUse` hook for Codex
- `.agents/hooks/format-python.sh`: the hook script, runs `ruff format` and `ruff check --fix` on the edited file

Both tools apply this configuration only in a trusted project. Claude Code asks once when you open the
project; Codex additionally requires reviewing and trusting the hook with `/hooks`, and silently skips it
until then.

## Q&A

### How do I run type checking?
Expand Down
16 changes: 16 additions & 0 deletions template/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,22 @@ uv run ruff check .
uv run ruff check . --fix
```

### AI Coding Agents

Rules for agents live in `AGENTS.md` (`CLAUDE.md` imports it). A shared hook formats and lints every Python
file right after Claude Code or Codex edits it, and reports the remaining diagnostics back to the agent:

- `.agents/hooks/format-python.sh`: the hook script, runs `ruff format` and `ruff check --fix`
- `.claude/settings.json`: Claude Code permissions and the `PostToolUse` hook (committed; put personal
overrides in `.claude/settings.local.json`, which is git-ignored)
- `.codex/hooks.json`: the same `PostToolUse` hook for Codex

Both tools require the project to be trusted before they apply its configuration:

- Claude Code: accept the trust prompt the first time you open the project.
- Codex: trust the project, then review and trust the hook with `/hooks`. Until you do, Codex skips the
hook without reporting an error.

### Docker Development

The template includes a complete Docker setup:
Expand Down