agentleFS
aspenkitaspenkit/aspens/AGENTS.md

aspens

AGENTS.md100 starsChanged 6 months agoMITView on GitHub

The file

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

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

  • 3

    Very specific

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

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

    Prefer CliError from command handlers.

    line 39
  2. Very specific:

    Keep target/backend semantics straight: target is output format/location.

    line 41
  3. Very specific:

    Do not duplicate base-skill guidance here.

    line 42

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

aspens

Skills

  • .agents/skills/base/SKILL.md — Base repo skill; load whenever working in this repo.
  • .agents/skills/agent-customization/SKILL.md — LLM-powered injection of project context into installed agent templates via aspens customize agents
  • .agents/skills/claude-runner/SKILL.md — Claude/Codex CLI execution layer — prompt loading, stream-json parsing, file output extraction, path sanitization, skill file writing, and skill rule generation
  • .agents/skills/cli-shell/SKILL.md — Top-level Commander wiring, welcome screen, missing-hook warning, CliError exit handling, and the public programmatic API surface
  • .agents/skills/codex-support/SKILL.md — Multi-target output system — target abstraction, backend routing, content transforms for Codex CLI and future targets
  • .agents/skills/doc-impact/SKILL.md — Context health analysis — freshness, domain coverage, hub surfacing, drift detection, LLM-powered interpretation, and auto-repair for generated agent context
  • .agents/skills/doc-sync/SKILL.md — Incremental skill updater that maps git diffs to affected skills and optionally auto-syncs via a post-commit hook
  • .agents/skills/import-graph/SKILL.md — Static import analysis that builds dependency graphs, domain clusters, hub files, git churn hotspots, and file priority rankings
  • .agents/skills/repo-scanning/SKILL.md — Deterministic repo analysis — language/framework detection, structure mapping, domain discovery, health checks, and import graph integration
  • .agents/skills/save-tokens/SKILL.md — Token-saving session automation — statusline, prompt guard, precompact handoffs, session rotation, and handoff commands for Claude Code
  • .agents/skills/skill-generation/SKILL.md — LLM-powered generation pipeline for Claude Code skills and CLAUDE.md — doc-init command, prompt system, context building, and output parsing
  • .agents/skills/template-library/SKILL.md — Bundled agents, commands, hooks, and settings that users install via aspens add, aspens doc init, and aspens save-tokens into their .claude/ directories
  • .agents/skills/architecture/SKILL.md — Import graph and code-map reference for structural changes.

Commands

  • npm test — run Vitest (vitest run)
  • npm start — run the CLI (node bin/cli.js)
  • npm run lint — no-op check (echo 'No linter configured yet' && exit 0)
  • aspens scan [path] — deterministic repo scan
  • aspens doc init [path] — generate skills, hooks, and instructions file (--target claude|codex|all, --recommended for full recommended setup including save-tokens, agents, and doc-sync hook)
  • aspens doc impact [path] — show freshness, coverage, drift, and LLM interpretation of generated context (interactive apply for repairs)
  • aspens doc sync [path] — update docs from recent diffs
  • aspens doc graph [path] — rebuild .agents/skills/architecture/references/code-map.md
  • aspens add <type> [name] — install bundled templates
  • aspens save-tokens [path] — install token-saving session settings (--recommended, --remove)

Release

  • Release workflow: /Users/MV/aspenkit/dev/release.md

Conventions

  • ESM only: use import/export; never require().
  • Prefer CliError from command handlers; top-level handling lives in bin/cli.js.
  • es-module-lexer must be initialized before parse().
  • Keep target/backend semantics straight: target is output format/location; backend is the generating CLI. Persist config in .aspens.json.
  • Do not duplicate base-skill guidance here; consult .agents/skills/base/SKILL.md for deeper repo context.

Behavior

  • Verify before claiming — Never state that something is configured, running, scheduled, or complete without confirming it first. If you haven't verified it in this session, say so rather than assuming.
  • Make sure code is running — If you suggest code changes, ensure the code is running and tested before claiming the task is done.
  • Ask clarifying questions — If the task is ambiguous, ask for clarification rather than making assumptions. Don't imply or guess at requirements or constraints that aren't explicitly stated.
  • Simplicity first — Write the minimum code that solves the problem. No speculative features, abstractions for single-use code, or error handling for impossible scenarios.
  • Surgical changes — Touch only what the task requires. Don't refactor adjacent code, fix unrelated formatting, or "improve" things that aren't broken.

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.