Verso Blueprint
Quick Start
Prefer the project-local helper:
lake exe vbp discover
lake exe vbp build
lake exe vbp query labels
Read references/vbp.md when you need exact command behavior, JSON shapes, serve behavior, or fallback commands.
Read references/authoring-patterns.md before editing Blueprint source, adding nodes, changing dependencies, or diagnosing authoring syntax.
Workflow
- Run
lake exe vbp discoverfirst to identify the package, generator, top-level Blueprint module, output paths, and chapter candidates. - Build with
lake exe vbp buildbefore querying unless generated output already exists and the user only asks to inspect it. - Query with
lake exe vbp query ...; do not ask users to inspect manifest/cache files directly for normal tasks. - Use
lake exe vbp query node <label>when you need the complete record for one Blueprint node. - Edit source conservatively when requested. Preserve stable labels, use existing chapter/module patterns, and keep dependency intent clear.
- Rebuild after source edits. Use
lake exe vbp checkwhen auditing persisted, copied, or externally supplied generated output. Report changed labels, changed dependency edges, and remaining diagnostics.
Guardrails
- Treat
_out/siteas the default generated site. Use--outputonly for build destinations and--siteonly for reading an alternate generated site. - Do not expose
blueprint-manifest.jsonorblueprint-html-cache.jsonas the normal interface;vbp queryandvbp checkare the normal interface. - Treat all
vbp queryJSON shapes as unstable. They are for current agent consumption, not a compatibility promise. - Use
usesonly for mathematical dependency edges. Usebpreffor prose links that should not affect the graph. - Keep statement and proof dependencies separate. Statement blocks use statement-side
uses;:::proofblocks use proof-sideuses. - Prefer small, explicit source patches over broad rewrites. Do not rename labels unless the user asks for a migration and validation plan.
- If
vbpis unavailable, fall back to the generator commands inreferences/vbp.mdand explain that the project predates the helper.