GuideShot docs

Narrow packages, explicit boundaries.

You will know which package owns each part of the workflow and which dependencies belong in a standard project setup.

Package map

Most applications install the CLI, Playwright driver, and renderer. Core and schema are available directly when you build project adapters or tooling.

@guideshot/schema

Use this for JSON schemas, strict recipe validation, and manifest types.

@guideshot/core

Use this for configuration, planning, dimensions, scenarios, hashes, and safety checks.

@guideshot/playwright

Use this to prepare real application state, resolve targets, and capture Chromium.

@guideshot/renderer

Use this to compose annotations and publish final image assets offline.

@guideshot/cli

Use this for the validate, plan, capture, compose, and verify commands.