x402-print-mail
AGENTS.md8 starsChanged 22 days agoApache-2.0View on GitHub
Operating notes for AI coding agents (Claude Code, Codex, Cursor, Copilot and others) working in this repository. Everything here is derived from the files actually in the tree, so trust it over guesses, and update it when the facts change. Agents send physical letters and postcards via Lob's test environment - preview PDF returned in-response Run the test and lint commands above before you consider a change finished. If a command fails on code you did not touch, say so…
- Reads credentials
- Installs packages
We split this AGENTS.md into the rules it gives an agent
5 rules. About 0 are common, 4 are distinctive, and 1 is very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈4
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
- could be automatic: a setting could enforce it
- Distinctive: line 39
Run the test and lint commands above before you consider a change finished.
- Very specific: line 45
Commit messages follow Conventional Commits (type(scope): summary), matching the existing history.
- Distinctive: line 46
Read the surrounding code before adding to it, and match its naming, file organisation and error-handling style.
- Distinctive: line 47
Keep README.md accurate: if a change alters behaviour, commands or configuration, update the docs in the same commit.
- Distinctive: line 48
Do not leave TODO comments, stub functions, placeholder data or commented-out code behind.
≈ “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
Operating notes for AI coding agents (Claude Code, Codex, Cursor, Copilot and others) working in this repository. Everything here is derived from the files actually in the tree, so trust it over guesses, and update it when the facts change.
What this repository is
Agents send physical letters and postcards via Lob's test environment - preview PDF returned in-response
- Homepage: https://nirholas.github.io/x402-print-mail/
- Source: https://github.com/nirholas/x402-print-mail
- Primary language: TypeScript
- License: Apache License 2.0 (see the LICENSE file)
Repository layout
docs/examples/public/src/README.mdLICENSEpackage.json
Setup
npm installCommands
| Task | Command |
| dev | npm run dev |
| start | npm start |
| build | npm run build |
| typecheck | npm run typecheck |
Run the test and lint commands above before you consider a change finished. If a command fails on code you did not touch, say so in your report instead of silently skipping it.
Conventions
- TypeScript runs in strict mode; do not loosen
tsconfig.jsonto make an error go away. .envfiles are gitignored; never commit credentials, and read configuration from environment variables.- Commit messages follow Conventional Commits (
type(scope): summary), matching the existing history. - Read the surrounding code before adding to it, and match its naming, file organisation and error-handling style.
- Keep
README.mdaccurate: if a change alters behaviour, commands or configuration, update the docs in the same commit. - Do not leave TODO comments, stub functions, placeholder data or commented-out code behind. Finish what you start or leave it out.
- Small, focused commits with a subject line that describes the change, not the act of committing.
Where to raise things
- Bugs and feature requests: https://github.com/nirholas/x402-print-mail/issues
- Questions and ideas: https://github.com/nirholas/x402-print-mail/discussions
- Security issues: report privately at https://github.com/nirholas/x402-print-mail/security/advisories/new, never in a public issue.
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 repository5 other files it gives its agents.
- docs/agents.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- llms-full.txtllms.txt
- llms.txtllms.txt
- skill.mdSkill
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
Reviews can't be read right now.
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.