aspy
AGENTS.md2 starsChanged 12 months agoMITView on GitHub
Read CLAUDE.md first. This file provides supplementary quick-reference for AI agents. Where does new code go? 1. Does the app work without it? No → Core | Yes → Extension 2. UI behavior multiple components need? → tui/traits/[name].rs 3. Reusable UI widget? → tui/components/[name]_panel.rs 4. Full-screen layout? → tui/views/[name].rs 5. Stream modification? → proxy/augmentation/ or proxy/transformation/ + config 6. Feature-local helper? → [feature]/helpers/[name].rs Where does state live? - Component-specific → inside component struct - Cross-cutting → app.rs - Extension state…
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 repository2 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- context-recoverySkill
The file
We split this AGENTS.md into the rules it gives an agent
1 rule. About 0 are common, 0 are distinctive, and 1 is 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.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 36
Add to view in tui/views/
≈ “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.
Files
Agent Guidelines
Read CLAUDE.md first. This file provides supplementary quick-reference for AI agents.
Quick Decision Tree
Where does new code go?
- Does the app work without it? No → Core | Yes → Extension
- UI behavior multiple components need? →
tui/traits/[name].rs - Reusable UI widget? →
tui/components/[name]_panel.rs - Full-screen layout? →
tui/views/[name].rs - Stream modification? →
proxy/augmentation/orproxy/transformation/+ config - Feature-local helper? →
[feature]/helpers/[name].rs
Where does state live?
- Component-specific → inside component struct
- Cross-cutting →
app.rs - Extension state (augmentors) → inside the extension struct, NOT global
Common Scenarios
Adding scrolling to a panel:
- Add
scroll: ScrollStatefield impl Scrollable for YourPanel- Handle in
tui/mod.rs:panel.as_scrollable_mut()
Adding an augmentor:
- Create
proxy/augmentation/[name].rs impl Augmentertrait- Register in pipeline builder
- Add config flag
Adding a panel:
- Create
tui/components/[name]_panel.rs - Implement needed traits (Scrollable, Copyable, etc.)
- Add to view in
tui/views/
Pre-Commit Checklist
- No component state added to
app.rs - Components own state; views compose
- Userland features have config toggles
cargo fmt && cargo clippy- Tests pass
References
See CLAUDE.md for architecture philosophy, mental model, anti-patterns, and documentation index.
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.

