What is pi-rules AGENTS.md?

Repository instructions for pi-rules, a TypeScript extension that manages coding rules, including its code style, tests, architecture, and process for adding rule sources.

Use them when modifying pi-rules, writing its Vitest tests, or adding a new place from which rules are loaded.

They reduce inconsistent changes by defining formatting, type-safety, testing, filesystem, and network restrictions.

How code-yeongyu/pi-rules configures Codex and OpenCode

Reuse

Borrowing it

Nothing to install: this file belongs to code-yeongyu/pi-rules. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file

curl -O https://raw.githubusercontent.com/code-yeongyu/pi-rules/main/AGENTS.md

Clone the repo

git clone --depth 1 https://github.com/code-yeongyu/pi-rules

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/code-yeongyu/pi-rules/agents-md/github.svg)](https://agentmods.dev/instructions/code-yeongyu/pi-rules/agents-md)

Your own site

<a href="https://agentmods.dev/instructions/code-yeongyu/pi-rules/agents-md"><img src="https://agentmods.dev/badge/instructions/code-yeongyu/pi-rules/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/code-yeongyu/pi-rules/agents-md"><img src="https://agentmods.dev/badge/instructions/code-yeongyu/pi-rules/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 790 This file is loaded in full into every session.

When invoked 790 The same file — it is already loaded in full.

Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.

Origin original No closer match found in the catalogue.

Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

Model	Per session	Once invoked
Fable 5.1	$0.00790	$0.00790
Opus 5.5	$0.00316	$0.00316
Sonnet 5.5	$0.00158	$0.00158
Haiku 4.5	$0.00079	$0.00079

Measured 2d ago against content hash 6ca733acefe6, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

pi-rules AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 57 lines

How it starts

The opening of the file, as written. The whole thing — 57 lines — stays where its author put it; the contents beside it link to each section on GitHub.

AGENTS.md

Project rules for pi-rules itself.

Code style

TypeScript strict mode (noUncheckedIndexedAccess, strict: true).
NO any in src/ (production). Use unknown and narrowing.
Imports use .js extension for project files (Node16 module resolution).
Tabs (indentWidth: 3), 120-char line width, biome-formatted.
ESM only ("type": "module").

Test conventions

Vitest, real temp filesystem via test/helpers/temp-fs.ts for fs-touching tests.
Naming: it("#given X #when Y #then Z") with // given / // when / // then body comments.
NO test deletion or skipping.
NO writes to real ~/.pi. Use injectable home dir.
NO network access.

Architecture

src/rules/ — pure logic units (parser, matcher, scanner, finder, ordering, cache, formatter, truncator, project-root, tool-paths) and orchestrating engine.ts (uses dependency injection).
src/ui/ — TUI components (rules-banner, dynamic-border).
src/commands.ts — slash command handlers.
src/index.ts — default function piRulesExtension(pi: ExtensionAPI): void factory; registers flags + hooks + commands.

When adding a new rule source

Add the path/extension to src/rules/constants.ts (PROJECT_RULE_SUBDIRS or PROJECT_SINGLE_FILES or USER_HOME_RULE_SUBDIRS).
Update RuleSource union in src/rules/types.ts.
Add SOURCE_PRIORITY entry.
Update findRuleCandidates in src/rules/finder.ts if discovery semantics differ.
Add tests covering the new source in test/finder.test.ts and the integration tests.
Update README.md "What gets loaded" section.

Hook contract reminders

before_agent_start: return { systemPrompt: event.systemPrompt + block }. NEVER mutate event.systemPrompt in place. Use event.systemPromptOptions.contextFiles to dedup against pi's native loader.
tool_result: return { content: [...event.content, { type: "text", text: block }] }. NEVER mutate event.content in place.
session_start: reset state, but never throw.
All hooks are idempotent: dedup via cache keys (cwd+realPath+hash for static, toolCallId+realPath+hash for dynamic).

Read the full file on GitHub · 57 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

2d ago Changed 6ca733acefe6
20d ago Changed · +62 tokens per session f35c48915cec
1mo ago Changed · +2 lines · +58 tokens per session 1876c1a19529
1mo ago First seen · 55 lines · 670 tokens per session scan A 9faaacc38082

Subscribe to this mod's changes

pi-rules AGENTS.md is an instructions file published in the GitHub repository code-yeongyu/pi-rules (15 stars, last pushed 2d ago), licensed MIT. It adds 790 tokens to every session, about $0.0032 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

agent-rules agents-md claude-md context-injection extension oh-my-openagent

ruleProb copilot-instructions.md

Instructions for canblmz1/ruleProb, a project described as: Test whether your CLAUDE.md, AGENTS.md and .cursor/rules actually survive AI agent execution. Extract rules, generate sandbox scenarios, score compliance.

canblmz1/ruleProb · 19 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 9,715 tokens

pi-rules: Instructions file for Codex