BoilerWorks

boilerworks / AGENTS.md
Source Blame History 26 lines
0cb4a5e… anonymous 1 # Agents — Boilerworks CLI
0cb4a5e… anonymous 2
0cb4a5e… anonymous 3 This file is for Cursor, Windsurf, and generic AI coding agents.
0cb4a5e… anonymous 4
0cb4a5e… anonymous 5 **Read `CLAUDE.md` for the full stack summary and conventions.**
0cb4a5e… anonymous 6
0cb4a5e… anonymous 7 ## Quick orientation
0cb4a5e… anonymous 8
0cb4a5e… anonymous 9 - This is the `boilerworks` Python CLI package, not a web app
0cb4a5e… anonymous 10 - Entry point: `boilerworks/cli.py` → `main()` Click group
0cb4a5e… anonymous 11 - Template data: `data/templates.yaml` (26 templates)
0cb4a5e… anonymous 12 - Manifest model: `boilerworks/manifest.py` → `BoilerworksManifest`
0cb4a5e… anonymous 13 - Registry: `boilerworks/registry.py` → `Registry`
0cb4a5e… anonymous 14 - Renderer: `boilerworks/renderer.py` → `render_directory`, `build_replacements`
0cb4a5e… anonymous 15
0cb4a5e… anonymous 16 ## Before writing code
0cb4a5e… anonymous 17
0cb4a5e… anonymous 18 1. Run `uv run boilerworks --help` to verify the CLI works
0cb4a5e… anonymous 19 2. Run `make lint` to check for style issues
0cb4a5e… anonymous 20 3. Run `make test` to ensure tests pass
0cb4a5e… anonymous 21
0cb4a5e… anonymous 22 ## After writing code
0cb4a5e… anonymous 23
0cb4a5e… anonymous 24 1. `make format` — fix style issues
0cb4a5e… anonymous 25 2. `make lint` — verify zero violations
0cb4a5e… anonymous 26 3. `make test` — verify tests pass and coverage ≥ 80%

Keyboard Shortcuts

Open search /
Next entry (timeline) j
Previous entry (timeline) k
Open focused entry Enter
Show this help ?
Toggle theme Top nav button