agentleFS
iulianditaiuliandita/skills/AGENTS.md

skills

AGENTS.md12 starsChanged yesterdayMITView on GitHub

Agent Skills, installed one at a time with npx skills add or install.sh, so every skill must be self-contained. develop is the default and nightly branch, main is stable. If AGENTS.local.md exists beside this file, read it too. It holds local paths and preferences and never relaxes the rules here. Pre-push set mirroring .github/workflows/ci.yml and security.yml. Tools: shellcheck, markdownlint-cli2 (pinned in .github/tools/markdownlint/), lychee, actionlint, zizmor, gitleaks, semgrep. The last two regenerate files; commit their output. check-freshness-dates.sh and receipt age are…

The file

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

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    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. Very specific:

    If AGENTS.local.md exists beside this file, read it too.

    line 6
  2. Distinctive:

    No AI attribution in commits, PRs, tags, or files.

    line 49
  3. Distinctive:

    No private hosts, domains, IPs, machine paths, or work context in tracked files.

    line 50
  4. Distinctive:

    Keep protected overlays and private markers out of commits.

    line 54

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

skills

Agent Skills, installed one at a time with npx skills add or install.sh, so every skill must be self-contained. develop is the default and nightly branch, main is stable.

If AGENTS.local.md exists beside this file, read it too. It holds local paths and preferences and never relaxes the rules here.

Commands

Pre-push set mirroring .github/workflows/ci.yml and security.yml. Tools: shellcheck, markdownlint-cli2 (pinned in .github/tools/markdownlint/), lychee, actionlint, zizmor, gitleaks, semgrep.

./scripts/lint-skills.sh
./scripts/validate-spec.sh
for f in scripts/check-*.sh; do "$f" || echo "FAIL $f"; done
python3 .github/stack/stack-check.py
for f in scripts/test-*.sh; do "$f" || echo "FAIL $f"; done
python3 scripts/test-migrations.py
shellcheck install.sh scripts/*.sh skills/repo-audit/references/detect.sh
markdownlint-cli2
lychee --config lychee.toml README.md SECURITY.md CONTRIBUTING.md CHANGELOG.md INSTALL.md MIGRATION.md AGENTS.md 'skills/**/*.md' 'docs/**/*.md'
actionlint
zizmor .
gitleaks git --redact .
semgrep scan --metrics off --error --config p/ci --config p/github-actions install.sh scripts .github/workflows .github/stack skills/repo-audit/references/detect.sh
./scripts/gen-contract-refs.sh
python3 scripts/gen-ref-toc.py

The last two regenerate files; commit their output. check-freshness-dates.sh and receipt age are advisory. pre-commit install --hook-type pre-commit --hook-type pre-push wires the local hooks, which run a subset of this block (the list of what they skip heads .pre-commit-config.yaml).

Layout

  • skills/<name>/: one installable skill. Never reference paths outside it at runtime.
  • skills/_shared/: build-time sources only. Each skill's references/output-contract.md and agent-hygiene.md are generated from them; never hand-edit those copies.
  • scripts/: gates (check-*.sh, lint-skills.sh, validate-spec.sh) and their tests (test-*).
  • .refiner-runs.json, .refiner-ledger.md: skill-refiner history at the root by contract; append only, except that private paths are removed.
  • .github/stack/: vendored from agents; do not edit.
  • Details: CONTRIBUTING.md, INSTALL.md, MIGRATION.md.

Rules

  • Issue first, branch from develop, PR into develop, conventional commits, Closes #NN. Never commit to main or develop.
  • No AI attribution in commits, PRs, tags, or files.
  • No private hosts, domains, IPs, machine paths, or work context in tracked files.
  • SKILL.md stays at 500 lines or fewer; every reference is linked from it.
  • A new active skill needs repo-audit coverage (see CONTRIBUTING.md); renames and removals need a migrations.json entry and a MIGRATION.md change.
  • Keep protected overlays and private markers out of commits.

For agents

  • ./install.sh --json (installs, --list, --check, --detect, --doctor, --migrate, --update) prints one JSON object; keys and exit codes are in INSTALL.md.
  • There is no single all-checks command; the block above is the full set and CI is the source of truth.

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.