agentleFS
sainzssainzs/santiagosainz-skills/AGENTS.md

santiagosainz-skills

AGENTS.md1 starsChanged 3 months agoMITView on GitHub

Portable catalog of maintainer-workflow skills for codex/opencode/pi — not an application. Definition of done: make check passes. Real install (writes to ~/.codex/skills, ~/.agents/skills, ~/.pi/agent/skills): scripts/validate-catalog.sh requires jq. It checks: catalog.json is valid JSON; every skill entry has non-empty name, group, status, path, provenance, runtimeBehavior; targets is a non-empty array drawn only from codex/opencode/pi; name matches ^[a-z0-9]+(-[a-z0-9]+)*$; the skill's path directory exists; and that directory contains a SKILL.md. scripts/publish-public.sh [owner] creates and pushes the public GitHub repo via gh — requires…

  • Deletes or force-pushes
  • 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 32,671 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 repository9 other files it gives its agents.

The file

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

6 rules. About 0 are common, 0 are distinctive, and 6 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.

  • 6

    Very specific

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

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

    Create skills/<group>/<name>/SKILL.md with frontmatter name + description and the workflow body (contract, use cases, numbered steps), …

    line 65
  2. Very specific:

    Add skills/<group>/<name>/agents/openai.yaml with a matching name, short description, and a prompt invoking the skill.

    line 66
  3. Very specific:

    Add a corresponding entry to catalog.json's skills[] array: name, group, status, path: "skills/<group>/<name>", targets (which runtimes), …

    line 67
  4. Very specific:

    If a runtime needs special handling notes, update the relevant adapters/<runtime>/README.md.

    line 68
  5. Very specific:

    Run make check (or at minimum scripts/validate-catalog.sh) to confirm the catalog entry and SKILL.md are well-formed.

    line 69
  6. Very specific:

    Run scripts/install.sh --dry-run to confirm the new skill's copy plan targets the intended runtime skill roots.

    line 70

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

santiagosainz-skills Agent Notes

Portable catalog of maintainer-workflow skills for codex/opencode/pi — not an application. Definition of done: make check passes.

Commands

# Full check: regenerate assets, validate catalog, dry-run install
make check

# Validate catalog.json + skill layout only
make validate
# equivalent: bash scripts/validate-catalog.sh

# Dry-run the installer (prints copy plan, writes nothing)
make dry-run
# equivalent: bash scripts/install.sh --dry-run

# Default target (validate + dry-run, no asset regen)
make
# equivalent: make all

# Regenerate Random Access-themed SVG assets (wordmark, workflow-spine, social preview)
make assets
# equivalent: python3 scripts/render_assets.py

Real install (writes to ~/.codex/skills, ~/.agents/skills, ~/.pi/agent/skills):

scripts/install.sh                    # all targets, all skills
scripts/install.sh --target codex     # one runtime
scripts/install.sh --target opencode
scripts/install.sh --target pi
scripts/install.sh --core-only        # skip non-core groups

scripts/validate-catalog.sh requires jq. It checks: catalog.json is valid JSON; every skill entry has non-empty name, group, status, path, provenance, runtimeBehavior; targets is a non-empty array drawn only from codex/opencode/pi; name matches ^[a-z0-9]+(-[a-z0-9]+)*$; the skill's path directory exists; and that directory contains a SKILL.md.

scripts/publish-public.sh [owner] creates and pushes the public GitHub repo via gh — requires a clean working tree and runs validate-catalog.sh first. Not a routine dev command.

CI (.github/workflows/validate.yml) runs exactly scripts/validate-catalog.sh and scripts/install.sh --dry-run on every PR and push to main — same as make validate dry-run. A second workflow, .github/workflows/skill-review.yml, dogfoods this repo's own requirements-review and architecture-review skills against each PR diff via opencode run and posts the result as a PR comment (read-only tool permissions; see docs/codex-automation.md).

There is no test suite beyond catalog/install validation — skills are markdown instructions, not executable code.

Architecture

This repo is a portable catalog of maintainer-workflow skills, not an application. Four pieces:

  • skills/<group>/<skill-name>/ — the canonical, runtime-agnostic definition of each skill. Two groups today: core (seven maintainer-workflow skills) and design (webgl-scroll-site). Each skill directory holds SKILL.md (YAML frontmatter with name + description, then the actual workflow instructions: contract, when to use it, numbered steps) and agents/openai.yaml (a short Codex/agents-SDK-style wrapper: name, one-line description, and a prompt that tells the agent to "use the <skill> skill" and restates the gist). SKILL.md is the source of truth; agents/openai.yaml is a thin pointer at it for tooling that expects that shape.
  • catalog.json — the index. Top-level installDestinations maps each runtime to its skill root (codex → ~/.codex/skills, opencode → ~/.agents/skills, pi → ~/.pi/agent/skills). Each entry in skills[] declares name, group/status (e.g. core or design), path (pointing into skills/<group>/...), targets (which of codex/opencode/pi get it), provenance, and runtimeBehavior (a one-line note on how the skill's behavior differs per runtime). This is the only place that decides which skills ship to which runtimes — skill directories themselves are runtime-agnostic.
  • adapters/<runtime>/README.md — per-runtime usage notes (codex, opencode, pi), not code. Each documents how that runtime should track state and verify work while running a skill (Codex: conversation/tool checklist, shell-first; OpenCode: native todowrite + /plan//verify; Pi: file-backed PLAN.md/STATE.md/VERIFY.md/TODO.md) and restates that runtime's install destination. Adapters do not contain skill logic — they are operating notes for whoever (human or agent) is running skills under that tool.
  • scripts/ — the only executable layer:
    • validate-catalog.sh enforces the catalog schema described above and that every referenced path/SKILL.md exists.
    • install.sh reads catalog.json with jq, filters by --target and --core-only, and copies each selected skill's path directory into the destination for each target runtime (skip-if-unchanged via diff -qr, otherwise rm -rf + cp -R). --dry-run only prints the copy plan.
    • render_assets.py regenerates the SVGs in assets/ from the Random Access theme tokens — unrelated to skill packaging.
    • publish-public.sh is a one-time/occasional repo-publish helper (validate → gh repo create → push), not part of the authoring loop.

Authoring workflow — adding a new skill:

  1. Create skills/<group>/<name>/SKILL.md with frontmatter name + description and the workflow body (contract, use cases, numbered steps), following the existing skills as the template. Workflow skills go in core; design skills go in design.
  2. Add skills/<group>/<name>/agents/openai.yaml with a matching name, short description, and a prompt invoking the skill.
  3. Add a corresponding entry to catalog.json's skills[] array: name, group, status, path: "skills/<group>/<name>", targets (which runtimes), provenance, runtimeBehavior.
  4. If a runtime needs special handling notes, update the relevant adapters/<runtime>/README.md.
  5. Run make check (or at minimum scripts/validate-catalog.sh) to confirm the catalog entry and SKILL.md are well-formed.
  6. Run scripts/install.sh --dry-run to confirm the new skill's copy plan targets the intended runtime skill roots; run scripts/install.sh (optionally --target <runtime>) to actually surface it under ~/.codex/skills, ~/.agents/skills, or ~/.pi/agent/skills.

CI re-runs steps 5–6 on every PR, and a second workflow exercises two of the published skills directly (requirements-review, architecture-review) against the PR diff via OpenCode as a live correctness check.

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.