GuideShot docs
One workflow from local review to CI.
You will be able to run the full pipeline locally, focus on selected recipes, consume JSON reports, and verify generated output in CI.
Commands
| Command | What it gives you |
|---|---|
guideshot validate | Validate configuration, recipes, and references. |
guideshot schema | Write editor-friendly recipe and manifest schemas. |
guideshot plan | Inspect expanded jobs, variants, and cache identities. |
guideshot capture | Prepare, capture, compose, and atomically publish. |
guideshot compose | Re-render valid sanitized captures without the app. |
guideshot verify | Check the manifest, files, hashes, dimensions, and alt text. |
Focused and automated runs
Use filters during development, JSON output in automation, and cached composition when only the explanatory layer changed.
pnpm exec guideshot plan --recipe release.create
pnpm exec guideshot capture --recipe release.create --json > report.json
pnpm exec guideshot compose --recipe release.create
pnpm exec guideshot verify --jsonCI should fail on validation, capture, composition, or verification errors. Publication completes only when every requested variant has succeeded, so the manifest never points at a partial run.