ruler: Instructions file for Codex

AGENTS.md

ruler AGENTS.md is an instructions file for Codex, OpenCode from intellectronica/ruler. It costs 279 tokens per session, scanned A, original, MIT.

A set of instructions for an AI coding assistant covering how to develop, test, format, commit, and review code.

In plain words
What is it for?
It helps with test-driven development (writing tests before implementation), unit, integration, and end-to-end testing, code formatting, CI checks, commits, and pull requests.
Why use it?
It gives the assistant consistent project rules, such as writing tests first where possible, formatting code, and using feature branches and pull requests.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md. Also seen: mentions AGENTS.md.

This is intellectronica/ruler's own configuration. It tells Codex and OpenCode how to work on ruler itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything ruler configures →

About the project

Ruler is a tool that keeps coding-agent instructions in one central location and distributes them into the configuration files used by supported agents. Teams use it to apply consistent, context-specific guidance across tools such as Copilot, Claude, Cursor, and Aider. The catalogue entries provide an instruction and MCP configuration for using Ruler.

intellectronica/ruler · 2,952 stars · on GitHub

Reuse

Borrowing it

Nothing to install: this file belongs to intellectronica/ruler. 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/intellectronica/ruler/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/intellectronica/ruler

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.

agentmods badge for ruler AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/intellectronica/ruler/agents-md/github.svg)](https://agentmods.dev/instructions/intellectronica/ruler/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/intellectronica/ruler/agents-md"><img src="https://agentmods.dev/badge/instructions/intellectronica/ruler/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.

agentmods 80×15 button for ruler AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/intellectronica/ruler/agents-md"><img src="https://agentmods.dev/badge/instructions/intellectronica/ruler/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 279 This file is loaded in full into every session.
When invoked 279 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.

ModelPer sessionOnce invoked
Fable 5.1 $0.00279 $0.00279
Opus 5.5 $0.00112 $0.00112
Sonnet 5.5 $0.00056 $0.00056
Haiku 4.5 $0.00028 $0.00028

Measured 1mo ago against content hash 010293e2b4b1, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

ruler 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 1mo 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 · 33 lines

What it actually says

Ruler

Development Process

Testing

  • Always follow TDD where possible - first adding or adjusting tests, verifying that they fail, then making the minimal changes to pass the tests.
  • Everything in this repository should be covered by tests. That always includes:
    • Unit tests
    • Integration tests
    • End-to-end tests

Code Formatting

  • Always ensure that the code is formatted correctly by running prettier before committing changes.

Branches and Pull Requests

  • Unless specifically instructed otherwise, all changes should be made in a feature branch and submitted as a pull request for review.
  • Pull requests should be descriptive and clearly explain the changes being made, including the rationale behind the change, the functional changes, the specific files and modules affected.
  • Before declaring a pull request ready for review, you must ensure that all the CI tests pass. These include:
    • npm ci
    • npm run lint
    • npm test
    • npm run build
  • IMPORTANT: Before committing, always use Prettier to ensure that the code is formatted correctly.
  • IMPORTANT: When committing yourself with git commit, always pass --author="AI <[email protected]>" so that your commits can be easily identified.
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.

  1. 1mo ago First seen · 33 lines · 279 tokens per session scan A 010293e2b4b1

Subscribe to this mod's changes

ruler AGENTS.md is an instructions file published in the GitHub repository intellectronica/ruler (2,952 stars, last pushed 5d ago), licensed MIT. It adds 279 tokens to every session, about $0.0011 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-30.

Related

Other instructions, from other repositories

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

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,786 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,680 tokens

vscode copilot-instructions.md

Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).

microsoft/vscode · 2,731 tokens

deno copilot-instructions.md

Copilot instructions for denoland/deno, covering deno development guide for github copilot, network access, high level overview, key directories and key files to understand first.

denoland/deno · 3,077 tokens