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