agentleFS
Sign inStart free
WilliamBergaminWilliamBergamin/knacks/AGENTS.md

knacks

AGENTS.md1 starsChanged 5 months agoMITView on GitHub

Notes for working on the knacks repo itself. For what knacks are, read README.md; for the contract and its rules, read KNACK.md (the source of truth). Don't restate either here. The skills run inside another repo (one with knacks/ manifests and a skills directory), not on this one. When a skill says "the project," or mentions reads/writes, it means that consumer. - No build, no tests. To try changes: claude --plugin-dir ., then run /knacks, /knacks:create, /knacks:validate, /knacks:delete. - create…

  • 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 31,774 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 repository4 other files it gives its agents.

The file

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

2 rules. About 0 are common, 0 are distinctive, and 2 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    When a skill says "the project," or mentions reads/writes, it means that consumer.

    line 16
  2. Very specific:

    No build, no tests. To try changes: claude --plugin-dir ., then run /knacks, /knacks:create, /knacks:validate, /knacks:delete.

    line 20

≈ “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

AGENTS.md

Notes for working on the knacks repo itself. For what knacks are, read README.md; for the contract and its rules, read KNACK.md (the source of truth). Don't restate either here.

Layout

  • KNACK.md: the contract - what a knack is, its fields, the one rule. Source of truth.
  • skills/{knacks,create,validate,delete}/SKILL.md: the four control-plane skills (the slash commands).
  • examples/: a copyable example knack.

This plugin operates on a consuming project

The skills run inside another repo (one with knacks/ manifests and a skills directory), not on this one. When a skill says "the project," or mentions reads/writes, it means that consumer.

Working on it

  • No build, no tests. To try changes: claude --plugin-dir ., then run /knacks, /knacks:create, /knacks:validate, /knacks:delete.
  • create and validate read KNACK.md at runtime. If you change a field or path there, update the checks in skills/validate/SKILL.md to match: that's the one place the contract is duplicated.
  • Root KNACK.md is the single source. The three contract-reading skills (knacks, create, validate) reach it through a resources/KNACK.md symlink (-> ../../../KNACK.md) and refer to it as ${SKILL_DIR}/resources/KNACK.md, so a skills-only install (npx skills add) stays self-contained with no ${CLAUDE_PLUGIN_ROOT}. Don't edit a resources/KNACK.md; edit root KNACK.md.
  • The four control-plane skills are normal model-invocable skills. Only a manual user knack's entry skill carries disable-model-invocation: true (that's what create's template teaches), never these.
  • The plugin is versioned in .claude-plugin/plugin.json; bump version on each release. Pinning it (vs omitting it) is what controls when installed users pull updates.

Style

Match the dense, plain voice. In the skill bodies and these notes, wrap prose ~100 columns; the reference docs (README.md, KNACK.md) run one idea per line and may exceed that. Plain ASCII punctuation, no em/en dashes, no decorative symbols (use y/n in tables, -> for flow). Keep the set-union math in KNACK.md's effective-contract rule where it carries meaning.

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.

Check your setup, free