oh-my-claudeagent
AGENTS.md3 starsChanged 32 days agoMITView on GitHub
- Use Bun, not npm scripts: bun install --frozen-lockfile. CI pins Bun 1.4.4. just setup only installs pre-commit hooks; it does not install dependencies. - Run just ci before claiming full verification. Its order is lint -> typecheck -> validate -> test -> test-mod -> test-opencode -> smoke. Recipes use bash, including Git Bash on Windows. - just typecheck checks separate mod, Bun runtime and OpenCode projects. - just validate checks docs and runtime contracts. Focus with just validate --check…
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 repository22 other files it gives its agents.
- hooks/AGENTS.mdAGENTS.md
- opencode/AGENTS.mdAGENTS.md
- scripts/AGENTS.mdAGENTS.md
- servers/AGENTS.mdAGENTS.md
- skills/AGENTS.mdAGENTS.md
- statusline/AGENTS.mdAGENTS.md
- templates/AGENTS.mdAGENTS.md
- tests/AGENTS.mdAGENTS.md
- analyzerSkill
- build-fixerSkill
- consolidate-memorySkill
- debuggingSkill
- github-triageSkill
- git-masterSkill
- handoffSkill
- init-deepSkill
- omca-setupSkill
- planSkill
- refactorSkill
- remove-ai-slopsSkill
- reviewerSkill
- start-workSkill
The file
We split this AGENTS.md into the rules it gives an agent
5 rules. About 0 are common, 1 is distinctive, and 4 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.
4
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 5
Use Bun, not npm scripts: bun install --frozen-lockfile.
- Very specific: line 7
Run just ci before claiming full verification.
- Very specific: line 35
After OpenCode UI or RPC changes, run just build-opencode and include opencode/tui.generated.js with the source changes.
- Very specific: line 53
Read CONTRIBUTING.md for prose and prompt contracts.
- Distinctive: line 55
Update a directory's AGENTS.md when changing its structure.
≈ “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.
Files
Working in this repository
Commands and verification
- Use Bun, not npm scripts:
bun install --frozen-lockfile. CI pins Bun 1.4.4.just setuponly installs pre-commit hooks; it does not install dependencies. - Run
just cibefore claiming full verification. Its order islint -> typecheck -> validate -> test -> test-mod -> test-opencode -> smoke. Recipes use bash, including Git Bash on Windows. just typecheckchecks separate mod, Bun runtime and OpenCode projects.just validatechecks docs and runtime contracts. Focus withjust validate --check <group>:claims,formats,hooks,mod,tree,engine,mcp. The engine group skips withoutclaude; a passing validator can therefore be incomplete.- Bun specs are colocated
*.spec.ts. Run one withbun test --timeout=30000 ./servers/tools/ast.spec.ts, optionally-t '<test name>'.just testselects explicit roots; barebun testalso collects mod tests that needjust test-mod(claude plugin test .). OpenCode specs run separately withjust test-opencode. - Full checks need
ast-grep(orsg) and Claude Code (CI pins 2.1.316). OpenCode integration specs skip withoutopencodeon PATH; CI installs 2.2.5.just smokeuses a mock model;tests/plugin-evals/calls a real model and is manual.
Runtime boundaries
src/core/is shared with the Claude mod: keep it free ofnode:/bun:imports and Bun globals. Mod code uses the engine throughHostinhooks/host.ts.servers/,statusline/andscripts/run on Bun, outside the mod engine..mcp.jsonlaunchesservers/omca.ts. Settings hooks inhooks/hooks.jsoncall itsomca_hooktool;servers/hooks/registry.tsmust reach each handler. Mod features register throughhooks/register.ts, the only file that callson().- Hooks may deny, ask or steer, never allow. Keep
PermissionRequestunregistered; allow decisions belong to native permission settings. Seehooks/AGENTS.md. opencode/index.tsis the server plugin;opencode/rpc.tsis the import-safe contract for the optional TUI. Readopencode/AGENTS.mdbefore adapter work. OpenCode has no Stop veto; historical evidence is not current-checkout verification.- After OpenCode UI or RPC changes, run
just build-opencodeand includeopencode/tui.generated.jswith the source changes. Never edit it by hand.just test-opencodechecks artifact freshness before running specs. .claude-plugin/types/is an engine-generated snapshot. Refresh withjust typesusing the Claude CLI version pinned in CI; validation rejects a different generator version. Do not edit manually; pre-commit leaves these files byte-identical.
Prompts and instructions
- Query on-disk inventories rather than asserting counts. Agents are
agents/*.md:analyzer,architect,build-fixer,executor,explorer,orchestrator,planner,researcher,reviewer,viewer. When adding one, also updatetemplates/claudemd.md,docs/references.mdand this list. - Skills are
skills/*/SKILL.md. Keepplanandstart-workuser-only (disable-model-invocation: true) and inline (nocontext: fork) so orchestration retains the invoking session'sAgenttool. Seeskills/AGENTS.mdfor prompt boundaries. - Restrict agent tools with
disallowedTools, nottools: an allowlist blocks MCP inheritance. Use model tier aliases in frontmatter, not generation IDs. - Read
CONTRIBUTING.mdfor prose and prompt contracts. Keep model-facing text about current behavior; preserve machine-consumed headings, tokens and frontmatter. Update a directory'sAGENTS.mdwhen changing its structure.
Packaging
- Claude marketplace installs use the packaged
pluginbranch, not the development tree.scripts/package.tsships only git-tracked files and excludes dependencies, root manifests, tests,opencode/and most scripts. Keep shipped imports inside that tree;scripts/setup-statusline.tsis the script exception. - For an authorized release, use
just release <version>rather than manual version edits. It commits and tags both trees but never pushes; add the matching CHANGELOG heading first. Prerequisites and push order are inCONTRIBUTING.md.
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
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.

