agentleFS
timmo001timmo001/skills/AGENTS.md

skills

AGENTS.md1 starsChanged 20 days agoApache-2.0View on GitHub

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

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 12

    Very specific

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

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

    Do not create checked-in copies under .agents/, .claude/, .cursor/, or .opencode/.

    line 8
  2. Very specific:

    Keep agent-specific packaging as metadata around the canonical skills, not forks of their content.

    line 9
  3. Very specific:

    Import only context-cli and notes-cli here, as external imports with no local content edits.

    line 14
  4. Very specific:

    Update order: source repository commit and push -> ./dist/skill-maintenance import <name> --apply here -> catalogue regeneration and …

    line 16
  5. Very specific:

    Keep name equal to the containing directory name.

    line 21
  6. Very specific:

    Write description for reliable selection: say what the skill does and when to use it.

    line 22
  7. Very specific:

    Use only Agent Skills frontmatter fields unless a vendor-specific extension is deliberately documented.

    line 23
  8. Very specific:

    Keep supporting files within the skill and link to them relatively from SKILL.md.

    line 24
  9. Very specific:

    Update PORTABILITY.md and skills.sh.json when a skill is added, removed, or changes runtime, tool, repository, or machine assumptions.

    line 25
  10. Very specific:

    Commit imported skills only when they contain documented local edits.

    line 27
  11. Very specific:

    Never duplicate canonical skill content for a client.

    line 31
  12. Distinctive:

    Run before committing repository setup or skill metadata changes:

    line 36
  13. Very specific:

    Every change here only reaches this machine through dot update, so offer "Run dot update" in the next-steps question alongside commit and …

    line 48

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

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

Repository Guidance

Scope

  • <name>/ at the repository root holds authored skills and distributed imported snapshots. Authored skills are edited here; imported skills are edited in their owning repositories. This preserves direct stow consumers that use the repository root as ~/.agents/skills.
  • dotfiles has no submodule pin. dot update fetches main into its own checkout and links it into ~/.agents/skills, so a push to main reaches every machine on its next dot update. Only push skills that are ready to use.
  • Preserve imported history, provenance records in skills.yml, and upstream licence material.
  • Do not create checked-in copies under .agents/, .claude/, .cursor/, or .opencode/.
  • Keep agent-specific packaging as metadata around the canonical skills, not forks of their content.

Tool-Owned Skills

  • timmo001/context owns .agents/skills/context-cli/ and .agents/skills/context-mcp/; timmo001/notes owns .agents/skills/notes-cli/ and .agents/skills/notes-mcp/.
  • Import only context-cli and notes-cli here, as external imports with no local content edits. Do not import either MCP skill. git-context and handoff own the surrounding Git and handoff workflows and route CLI operations to those imports.
  • skills.yml records each origin and reviewed source commit; imported SKILL.md files carry no provenance comments.
  • Update order: source repository commit and push -> ./dist/skill-maintenance import <name> --apply here -> catalogue regeneration and validation -> skills commit and push. Machines pick up the new main on their next dot update.
  • New imports need a published source revision containing the skill. Do not invent a revision or point at a commit that predates the skill. Commit and push steps require explicit user authorisation.

Skill Changes

  • Keep name equal to the containing directory name.
  • Write description for reliable selection: say what the skill does and when to use it.
  • Use only Agent Skills frontmatter fields unless a vendor-specific extension is deliberately documented.
  • Keep supporting files within the skill and link to them relatively from SKILL.md.
  • Update PORTABILITY.md and skills.sh.json when a skill is added, removed, or changes runtime, tool, repository, or machine assumptions.
  • Regenerate SKILLS.md and .claude-plugin/marketplace.json with mise run catalogue (or ./dist/skill-maintenance catalogue) after skill, grouping or import changes; validate fails on drift.
  • Commit imported skills only when they contain documented local edits. Mark unchanged imports external in skills.yml; never commit their content. skill-maintenance install installs them at the pinned SHA, and dot update runs it.
  • Keep adapted imports as top-level reviewed snapshots. skills.yml is the single maintenance record: it owns origin, reviewed SHA, licence, local-edit metadata, and distribution mode. skills.schema.json specifies it and is generated from the CLI's schema with mise run schema; validate fails when either is stale or skills.yml is not in canonical form. Skills keep only Agent Skills frontmatter, with the local name and license written in by the CLI.
  • Build dist/skill-maintenance, then run ./dist/skill-maintenance import <name> --metadata-only after editing skills.yml by hand: it rewrites the file in canonical form and writes the name and licence into SKILL.md. Compare upstream changes with import <name>.
  • A skills.yml entry's tools list records the tool releases a skill was last reviewed against. skill-maintenance skill-reviews reports skills whose tools have a newer release, --reviewed <skill> records the latest tags after a review, and --format rewrites a hand-edited file in canonical form. check-skill-updates owns the review workflow.
  • Never duplicate canonical skill content for a client. The generated Claude plugin marketplace points at the top-level skills and pins each external import to its reviewed SHA.
  • consumers.yml lists the repositories that receive project copies of skills from here. Only committed skills and licensed external imports that keep their upstream name can be listed. skill-maintenance consumers add adds skills to an entry, creating it if needed, and consumers remove takes them out; both push consumers.yml to skills main and sync that repository straight away, so they need explicit authorisation to push. skill-maintenance consumers pushes to those repositories, so run it with --dry-run unless the user asked for the push.

Verification

Run before committing repository setup or skill metadata changes:

bun install --frozen-lockfile
mise run validate
mise exec npm:skills -- skills add . --list

mise run validate runs the checks in parallel. For a narrow change, run only the tasks it touches, for example mise run validate:skills after editing a skill.

After Committing

  • Every change here only reaches this machine through dot update, so offer "Run dot update" in the next-steps question alongside commit and push. dot update reads main from the remote, so it needs the push first; say so when the user picks it without pushing.

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.

Reviews can't be read right now.

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.