.agents
AGENTS.md19 starsChanged 4 days agoApache-2.0View on GitHub
Centralized configuration repository for AI coding agents. Manages shared and agent-specific configs for Claude Code, Pi, and Codex via symlinks. This public repo is the control plane (all scripts + shareable config). Agent settings and private skills live in the required private companion repo ~/.agents-private (ivanrvpereira/agents-private), which is data only. Override its location with AGENTSPRIVATEDIR. bin/sync creates symlinks from this repo and from ~/.agents-private into each agent's config directory. It exits with an error if ~/.agents-private (or $AGENTSPRIVATEDIR) is missing.
We split this AGENTS.md into the rules it gives an agent
10 rules. About 1 is common, 0 are distinctive, and 9 are very specific to this project.
≈1
Common · estimate
Many files like this have a rule of this kind.
≈0
Distinctive · estimate
This author's own choices. Worth a look.
9
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 85
Private/company config and skills: do not belong here — put them in ~/.agents-private
- Very specific: line 86
After adding or moving files, run bin/sync to update symlinks
- Very specific: line 91
GitHub content: Always use gh CLI for github.com — never crawl/scrape GitHub URLs.
- Very specific: line 96
Verify sync state: ls -la ~/.claude/settings.json ~/.pi/agent/APPEND_SYSTEM.md (both should be symlinks into ~/.agents-private or this repo)
- Very specific: line 101
Run bin/sync --dry-run before bin/sync to preview changes
- Very specific: line 102
Keep pi/APPEND_SYSTEM.md concise — every line is appended to every Pi session's system prompt
- Common: line 110
Commit secrets or API keys
- Very specific: line 116
Never add/remove package-provided skills by editing ~/.agents-private/pi/settings.json skills arrays
- Very specific: line 118
Add a skill: copy/author it into the right bucket, then run bin/add-skill <name> and bin/sync
- Very specific: line 119
Update vendored skills: follow the update workflow in skills/VENDORED.md
≈ “Common” is an estimate: at least 1 in 5 of the 36,368 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
.agents — Project Knowledge Base
Centralized configuration repository for AI coding agents. Manages shared and agent-specific configs for Claude Code, Pi, and Codex via symlinks.
This public repo is the control plane (all scripts + shareable config). Agent settings and private skills live in the required private companion repo ~/.agents-private (ivanrvpereira/agents-private), which is data only. Override its location with AGENTS_PRIVATE_DIR.
Structure
AGENTS.md # Project knowledge base (read by every agent)
bin/sync # Symlink manager (creates all links below)
bin/add-skill # Validate a local skill before syncing
bin/link-skill # Link a scoped skill into one project
skills/ # Shared skills; auto/ (model-invocable) + on-demand/ (manual)
skills/VENDORED.md # Registry of copied upstream skills + their sources
skills/private # Gitignored symlink to ~/.agents-private/skills (created by bin/sync)
skills/rex # Gitignored; installed and updated by `rex skill setup` (tool-owned, not synced)
claude/ # Claude Code: scripts, statusline, plugin installer
pi/ # Pi: APPEND_SYSTEM.md, keybindings, sandbox, extensions, skills
~/.agents-private/ # Private repo (data only, required by bin/sync)
claude/settings.json
pi/settings.json, pi/mcp.json
codex/config.toml, codex/hooks.json
skills/ # Private skills (via skills/private)
skills-scoped/ # Project-scoped skills (via bin/link-skill)Commands
| Action | Command |
| Sync configs | bin/sync |
| Preview sync | bin/sync --dry-run |
| Sync + install plugins + Rex skill/hooks | bin/sync --bootstrap |
| Remove stale links | bin/sync --prune |
| Validate local skill | bin/add-skill skill-name |
| Enable scoped skill in a project | bin/link-skill skill-name [project-dir] |
| Disable scoped skill in a project | bin/link-skill --remove skill-name [project-dir] |
| Add vendored skill | Copy upstream skill into skills/auto/ or skills/on-demand/, add a row to skills/VENDORED.md |
| Update vendored skills | Ask an AI agent to follow the update workflow in skills/VENDORED.md |
| Update vendored Pi extensions | Ask an AI agent to follow the update workflow in pi/extensions/VENDORED.md |
How Syncing Works
bin/sync creates symlinks from this repo and from ~/.agents-private into each agent's config directory. It exits with an error if ~/.agents-private (or $AGENTS_PRIVATE_DIR) is missing.
Core links:
- Each skill directory under
skills/auto/,skills/on-demand/, andskills/private/→~/.claude/skills/(flattened; Pi reads shared skills recursively from~/.agents/skills) - Each skill directory under the same buckets →
~/.codex/skills/; conflicting non-symlink Codex skills are backed up first - Other top-level folders under
skills/are tool-owned and never linked (see Conventions)
Claude Code (~/.claude/):
~/.agents-private/claude/settings.json→ settings (permissions, hooks, plugins, model config)claude/scripts/→ automation scripts (sleep management)claude/statusline-command.sh→ status bar display
Pi (~/.pi/agent/):
pi/APPEND_SYSTEM.md→ behavioral instructions appended to Pi's system prompt (Pi only; not loaded by Claude/Codex)~/.agents-private/pi/settings.json→ model config, packages,subagents(role overrides, watchdog)pi/WATCHDOG.md→ standing rules for the pi-subagents watchdogpi/subagents-config.json→extensions/subagent/config.json, pi-subagents extension config (worktree defaults)~/.agents-private/pi/mcp.json→ MCP serverspi/extensions/→ per-extension symlinkspi/skills/→ Pi-only skills
Codex (~/.codex/):
~/.agents-private/codex/config.toml→ model, approvals, permission profile, plugins~/.agents-private/codex/hooks.json→ Codex lifecycle hooksskills/→ shared skills, backing up conflicting non-symlink Codex skills
The sync script backs up existing non-symlink files as .bak before replacing them. It's idempotent — safe to run repeatedly.
Conventions
- Shared config goes at root or in
skills/— all agents get it - Agent-specific config goes in
claude/orpi/— only that agent gets it - Agent settings and private config (
claude/settings.json,pi/settings.json,pi/mcp.json,codex/config.toml,codex/hooks.json, private/company skills) live in~/.agents-privateunder the same relative paths, never here (gitignored in this repo).bin/syncrequires~/.agents-privateto exist - Skills are bucketed by invocation:
skills/auto/<name>/= model may auto-invoke (nodisable-model-invocation);skills/on-demand/<name>/= manual-only (disable-model-invocation: true).bin/syncflattens the bucket folders away, so skill folder names must be globally unique and the folder must match the flag. - Tool-installed skills: a top-level
skills/<name>/folder outside the buckets is installed and updated by an external tool (for exampleskills/rex/fromrex skill setup). It is gitignored,bin/syncdoes not link it, and the tool owns its copies in each agent directory. Pi and Codex read it from~/.agents/skillsdirectly. Do not vendor or edit it; use the tool's own commands (rex skill setup|status|remove).bin/sync --bootstraprunsrex skill setupwhenrexis installed. - Project-scoped skills live in
~/.agents-private/skills-scoped/<name>/(outsideskills/, so they are never synced globally). Enable per project withbin/link-skill <name> <project-dir>, which symlinks into the project's.claude/skills/and.pi/skills/and ignores the links via.git/info/exclude. They auto-invoke only where linked — zero context cost elsewhere.bin/link-skillalso picks up a localskills-scoped/in this repo if one exists. - Vendored skills are copied from upstream into a bucket and recorded in
skills/VENDORED.md(source + pinned ref). We own the copies and may customize them; update them via the workflow in that file. - Vendored Pi extensions are copied from upstream repos into
pi/extensions/and recorded inpi/extensions/VENDORED.md(source + pinned ref + update workflow). - Private/company config and skills do not belong here — put them in
~/.agents-private - After adding or moving files, run
bin/syncto update symlinks
Web Content & Research
- Save agent research and session reports under
.scratch/at the repository root. This folder is globally ignored. Keepdocs/for maintained documentation, and keep research reports out of commits. - GitHub content: Always use
ghCLI for github.com — never crawl/scrape GitHub URLs. Usegh api,gh repo view,gh pr view,gh issue view, etc.
Validation
- Preview symlink changes:
bin/sync --dry-run - Verify sync state:
ls -la ~/.claude/settings.json ~/.pi/agent/APPEND_SYSTEM.md(both should be symlinks into~/.agents-privateor this repo)
Boundaries
Always
- Run
bin/sync --dry-runbeforebin/syncto preview changes - Keep
pi/APPEND_SYSTEM.mdconcise — every line is appended to every Pi session's system prompt
Ask First
- Running
bin/sync --prune(deletes stale symlinks) - Modifying
~/.agents-private/claude/settings.json(affects permissions across all projects) - Editing
pi/APPEND_SYSTEM.md(appended to the system prompt of every Pi session)
Never
- Commit secrets or API keys
- Edit symlink targets directly — edit source files in this repo or
~/.agents-privateinstead
Plugins & Skills
- Some plugins are disabled globally — enable per-project in
.claude/settings.jsonunderenabledPlugins - Never add/remove package-provided skills by editing
~/.agents-private/pi/settings.jsonskillsarrays - Skills live in
skills/auto/orskills/on-demand/; vendored copies are tracked inskills/VENDORED.md - Add a skill: copy/author it into the right bucket, then run
bin/add-skill <name>andbin/sync - Update vendored skills: follow the update workflow in
skills/VENDORED.md
Key Files
~/.agents-private/claude/settings.json— permissions (allow/deny/ask), hooks, plugins, model defaults. This is the most complex file; changes affect what Claude Code can do across all projects.claude/install-plugins.sh— declarative plugin installation from multiple marketplaces. Run viabin/sync --bootstrap.~/.agents-private/codex/config.toml— Codex model, permission profile, network allowlist, plugins, and trusted projects.~/.agents-private/codex/hooks.json— Codex lifecycle hooks.pi/APPEND_SYSTEM.md— Pi-only behavioral instructions, appended to Pi's system prompt via~/.pi/agent/APPEND_SYSTEM.md. Keep concise — every line applies to all Pi sessions.AGENTS.md— repository knowledge for this config repo.
Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 28,693 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository64 other files it gives its agents.
- skills/on-demand/vercel-composition-patterns/AGENTS.mdAGENTS.md
- adr-writingSkill
- codebase-designSkill
- code-reviewSkill
- crwlSkill
- dev-browserSkill
- diagnosing-bugsSkill
- domain-modelingSkill
- git-commitSkill
- grillingSkill
- implementSkill
- librarianSkill
- liteparseSkill
- prototypeSkill
- prSkill
- researchSkill
- simple-englishSkill
- skill-dietSkill
- tddSkill
- wizardSkill
- writing-for-agentsSkill
- architecture-scanSkill
- brandkitSkill
- broSkill
- cavemanSkill
- coding-standardsSkill
- design-taste-frontendSkill
- diagram-designSkill
- fable-safe-promptSkill
- grill-for-unknownsSkill
- grill-meSkill
- grill-with-docsSkill
- handoffSkill
- high-end-visual-designSkill
- humanizerSkill
- i-have-adhdSkill
- imagegen-frontend-mobileSkill
- imagegen-frontend-webSkill
- image-to-codeSkill
- implementation-orchestratorSkill
- improve-codebase-architectureSkill
- marpSkill
- minimalist-uiSkill
- oss-repo-reviewSkill
- pretty-mermaidSkill
- redesign-existing-projectsSkill
- reducing-entropySkill
- retroSkill
- rpiSkill
- sentrySkill
- setup-matt-pocock-skillsSkill
- setup-ts-deep-modulesSkill
- show-meSkill
- suggest-skillsSkill
- supervisorSkill
- teachSkill
- tech-specSkill
- to-questionnaireSkill
- to-specSkill
- to-ticketsSkill
- The first 60 shown.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

