zarubinvibezarubinvibe/athena/AGENTS.md

athena

AGENTS.md2 starsChanged 5 months agoMITView on GitHub

Athena is a macOS bootstrap repository. Read CLAUDE.md and the relevant file in specs/ before changing behavior. Run these after behavior or documentation changes: The smoke suite must finish with SMOKE OK. Do not describe work as complete when a required check fails. - README.md and README.ru.md follow the shared family anatomy: promise, badges, wide hero, table of contents, and the ten beginner headings with the ASCII workflow diagram inside How It Works. - Workflow stages live in .github/pantheon.json. Change…

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 repository11 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- claude-starter/CLAUDE.mdCLAUDE.md
- .github/copilot-instructions.mdCopilot instructions
- .cursor/rules/olympuz.mdcCursor rule
- athena-setupSkill
- athena-updateSkill
- agent-session-reviewSkill
- athena-updateSkill
- bootstrap-projectSkill
- organizeSkill
- setup-osSkill

The file

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

9 rules. About 1 is common, 2 are distinctive, and 6 are very specific to this project.

≈1
Common · estimate
Many files like this have a rule of this kind.
≈2
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

Very specific:
Keep paths relative to the repository or based on $HOME.
line 7
Common:
Keep real manifests, credentials, private overlays, logs, sessions, and runtime state out of Git.
line 8
Very specific:
Treat rules/structure.md as the filesystem layout contract.
line 9
Very specific:
Keep root skills and their chezmoi/dot_claude/skills/ copies in sync.
line 10
Very specific:
Do not apply the repository to a live ~/.claude while testing.
line 11
Distinctive:
Keep English and Russian public documentation consistent in meaning.
line 12
Very specific:
Prefer shell, Node.js, and other tools already used by the repository.
line 13
Distinctive:
Run these after behavior or documentation changes:
line 17
Very specific:
Run public-repo-gate check --repo .
line 36

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

Agent guide

Athena is a macOS bootstrap repository. Read CLAUDE.md and the relevant file in specs/ before changing behavior.

Working rules

Keep paths relative to the repository or based on $HOME. Never add a literal user home path.
Keep real manifests, credentials, private overlays, logs, sessions, and runtime state out of Git.
Treat rules/structure.md as the filesystem layout contract.
Keep root skills and their chezmoi/dot_claude/skills/ copies in sync.
Do not apply the repository to a live ~/.claude while testing. Use dry runs and temporary homes.
Keep English and Russian public documentation consistent in meaning.
Prefer shell, Node.js, and other tools already used by the repository. Do not add a dependency for a small check.

Required checks

Run these after behavior or documentation changes:

shellcheck -S error bootstrap.sh preinstall.sh smoke/*.sh
./bootstrap.sh --dry-run
bash smoke/smoke.sh
ATHENA_PRIVATE_DIR="$(mktemp -d)" bash smoke/dry-validate.sh
git diff --check

The smoke suite must finish with SMOKE OK. Do not describe work as complete when a required check fails.

Public packaging

README.md and README.ru.md follow the shared family anatomy: promise, badges, wide hero, table of contents, and the ten beginner headings with the ASCII workflow diagram inside How It Works.
Workflow stages live in .github/pantheon.json. Change the stages there first, then the two READMEs.
AGENTS.md holds the rules; CLAUDE.md, GEMINI.md, .github/copilot-instructions.md, and .cursor/rules/*.mdc only point here.
Run public-repo-gate check --repo . --release-intent public before any push, and fix every blocker.
Agent work here is tracked by Entire, and its checkpoints go to the separate private repository zarubinvibe/athena-checkpoints. Session capture stays on: a public repository never stores its own checkpoints, and the release gate blocks a push when tracking is disabled or the checkpoint repository is public.

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