EffectPatterns
AGENTS.md807 starsChanged 8 months agoMITView on GitHub
For architecture, agents, integration, config, testing, deployment, security, monitoring, and development guidelines, use: Run commands from the project root. Use Bun and workspace:\* dependencies; no TypeScript path aliases. Below: generated Effect Patterns rules (do not edit by hand). For Effect Patterns rules, see docs/Effect-Patterns-Rules.md.
We split this AGENTS.md into the rules it gives an agent
1 rule. About 0 are common, 1 is distinctive, and 0 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.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 8
Run commands from the project root.
≈ “Common” is an estimate: at least 1 in 5 of the 36,368 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
AGENTS.md
For architecture, agents, integration, config, testing, deployment, security, monitoring, and development guidelines, use:
- docs/Architecture.md – single source for all architecture and agent context.
- docs/Effect-Patterns-Rules.md – canonical Effect Patterns rules for all AI tools.
Run commands from the project root. Use Bun and workspace:* dependencies; no TypeScript path aliases.
Below: generated Effect Patterns rules (do not edit by hand).
<!-- EP_RULES_START -->For Effect Patterns rules, see docs/Effect-Patterns-Rules.md.
<!-- EP_RULES_END -->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 28,693 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 repository3 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- .github/copilot-instructions.mdCopilot instructions
- effect-patterns-services-agentsSkill
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.