Documentation¶
The Booley user guide. The first time, read Get started in order.
| Section | Page | What it covers |
|---|---|---|
| Get started | Features | Everything Booley does, and why. |
| Setup | Connect an installed Booley to your RTL project. | |
| Usage | Day-to-day work with the Developer Agent and waveforms. | |
| Goal Mode | Evidence-backed Goals, Goalsets, and review. | |
| Flows | Running Flows | What every Flow shares: Targets, options, and results. |
| Simulation | Run a Target's tests and report which ones passed. | |
| Tests | Declare a sim Target's tests, variants, and seeds. | |
| Coverage | Measure how much of the RTL your tests exercise. | |
| Lint | Check RTL for structural, semantic, and style problems. | |
| ASIC synthesis | Estimate ASIC area and timing while you iterate. | |
| FPGA implementation | Build for an FPGA and report resources and timing. | |
| Reference | Config | Project-wide booley.toml settings. |
| Targets | Describe how your design builds for every Flow. | |
| Sandbox | Configure the container Booley and its agents run in. | |
| Stealth Mode | Keep Booley out of your Git history. | |
| CLI reference | Every command, Flow, and Specialist. | |
| Supported EDA tools | Which tools each Flow drives, and where they come from. | |
| Help | Doctor | Check that Booley's setup and tools work. |
| Troubleshooting | Symptoms, causes, and fixes. | |
| Windows | Windows-only first-run traps. |
These pages track the main branch, so they can describe changes newer than
your installed release; the changelog
says what each release contains. The source is docs/user/ on GitHub.