Choose a supported workflow#

You can use portable report processing without a browser, or connect Markdown tests to your own agent/runtime. The interactive reporting UI is an experimental example, not the required entry point for either path.

Establish the checkout#

Use a pinned SnagBadger repository checkout and its recorded Node/pnpm versions. Workspace setup is authoritative for installation:

pnpm worktree:setup
pnpm build

The setup helper performs a frozen install and installs the pinned browser used by repository checks. It does not install a product-runtime MCP, configure credentials, or grant browser isolation. These docs do not assume published npm packages.

Path A: portable bug reports#

Choose this path to capture your own observations as structured data, preserve revisions, review evidence, and create a local self-contained export. Use supported @snagbadger/reporting and /bundle entries from the built workspace. React, a server, and a tracker are unnecessary. Create your first bug report.

Your host supplies IDs, timestamps, actual evidence bytes, and review policy. The portable capture package supplies types, not a collector.

Path B: Markdown test execution#

Choose this path when your environment can delegate a fresh agent and create a new isolated browser context per browser attempt. Keep your catalog and runtime configuration in the adopting project; the runner may live in a separate SnagBadger checkout.

Verify installed tool capabilities, define review policy and hook bindings, and keep a coordinator active to service the filesystem bridge. First test run walks through selection and output. Runtime requirements identifies blockers before a run starts.

Path C: understand the demo#

Launch the sample site to compare buggy/fixed saves and inspect the simulated reporting interface. Follow its catalog or illustrative report to see the intended connection.

Real capture, universal embedding, hosted storage, automatic regression generation and live tracker adapters remain outside the supported first-use journeys. Check project status before planning an integration.