agents-md-wizard¶
agents-md-wizard is a terminal UI for composing AGENTS.md and CLAUDE.md agent instruction files. It presents a browsable library of pre-built guidelines; you pick what fits your project, and it renders the result as clean markdown.
The TUI renders on stderr so stdout is free for piping — no extra flags needed to write to a file.
Why AGENTS.md?¶
Coding agents (Claude, Copilot, Cursor, etc.) read instruction files at the project root to understand how you want them to behave — commit style, testing expectations, database conventions, and so on. Writing these from scratch is repetitive. agents-md-wizard gives you a menu of well-phrased, battle-tested rules to pick from.
Feature highlights¶
- 100+ built-in guidelines across code style, testing, version control, architecture, databases, CI/CD, secrets, and more
- Stack-specific wording — select TypeScript or Python and relevant guidelines use language-appropriate phrasing
- Variables — some guidelines have configurable values (e.g. max function length); you're prompted to confirm or change the defaults
- Conflict detection — mutually exclusive guidelines (e.g. "No ORM" vs "Use an ORM") are flagged so you can't accidentally select both
- Custom guidelines — point the tool at your own YAML directory to add or replace guidelines
Navigation¶
- Getting Started — install and run your first
AGENTS.md - Custom Guidelines — write and use your own guideline files
- CLI Reference — all flags and options
- YAML Schema — complete field reference for guideline files