agentleFS
christofferbergjchristofferbergj/agent-skills/AGENTS.md

agent-skills

AGENTS.md1 starsChanged 21 days agoMITView on GitHub

Skills are organized under skills/<category>/<skill-name>/. For project orientation, upstream ownership, or changes spanning skill families, read the library architecture. Read skills from this repository's skills/ tree, not from installed copies, which lag until a refresh. Whenever a PR in this repository merges, refresh the installed copies without asking first: run git fetch origin main, then python3 scripts/check-installs.py and the refresh command it prints, until it reports none stale. Vocabulary lives in GLOSSARY.md and decisions in docs/adr/; the docs index separates…

The file

We split this AGENTS.md into the rules it gives an agent

6 rules. About 0 are common, 5 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈5

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Every published skill must:

    line 9
  2. Distinctive:

    use a lowercase, hyphenated name that matches its directory.

    line 12
  3. Distinctive:

    keep conditional reference material inside its own directory.

    line 13
  4. Very specific:

    keep Codex metadata in agents/openai.yaml synchronized with its invocation mode.

    line 15
  5. Distinctive:

    Treat each skill as a predictable process.

    line 27
  6. Distinctive:

    Use terse imperative commit titles without conventional-commit prefixes.

    line 29

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 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.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

Repository guidance

Skills are organized under skills/<category>/<skill-name>/.

For project orientation, upstream ownership, or changes spanning skill families, read the library architecture.

Read skills from this repository's skills/ tree, not from installed copies, which lag until a refresh. Whenever a PR in this repository merges, refresh the installed copies without asking first: run git fetch origin main, then python3 scripts/check-installs.py and the refresh command it prints, until it reports none stale. Vocabulary lives in GLOSSARY.md and decisions in docs/adr/; the docs index separates current guidance from dated evidence. Before adding, moving, removing, or redescribing a skill, read the change set in Contributing.

Every published skill must:

  • contain a SKILL.md with string name and description fields;
  • use a lowercase, hyphenated name that matches its directory;
  • keep conditional reference material inside its own directory;
  • appear in both the top-level README.md and its category README.md;
  • keep Codex metadata in agents/openai.yaml synchronized with its invocation mode; and
  • pass pnpm check before publication, after formatting changed files with pnpm fmt <files> (oxfmt).

Invocation has two modes:

  • User-invoked skills set disable-model-invocation: true and policy.allow_implicit_invocation: false. Their description is a short human-facing summary.
  • Model-invoked skills omit both restrictions. Their description names the distinct branches that should trigger the skill.

Express dependencies as /skill-name prose invocation. Keep shared reference material with the skill that owns it; another skill reaches that material by invoking its owner. Because the Skills CLI does not install dependencies transitively, document required installation pairs in the top-level README.

For skills derived from external sources, maintain a skill-local UPSTREAM.md with source identity, tracking policy, imported and reviewed revisions, license attribution, local adaptations, and update decisions. /maintain-skills discovers these records; its provenance guidance describes how to add or repair one.

Treat each skill as a predictable process. Ordered steps end with checkable, exhaustive completion criteria. Keep one source of truth for each rule, disclose branch-specific reference behind a precise pointer, and remove instructions that do not change agent behavior.

Use terse imperative commit titles without conventional-commit prefixes.

Download now (ZIP)

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
What did you use it for? e.g. Reviewing pull requests in a Rails app

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.