Runnable examples

Open a small project, run cms-lab, and inspect the report. These examples are backed by folders in the public repository so they can be checked in CI and kept honest.

Run in a browser workspace

StackBlitz opens the GitHub example folder directly. GitHub stays the source of truth, and each example includes the commands and expected diagnostics in its README.

ExampleWhat it showsOpen
Broken Prismic demo
examples/broken-prismic-demo
A no-secret Next.js fixture that scans a public Prismic starter and intentionally produces useful route, field, SEO, and image diagnostics.Run in StackBlitz
Next Prismic config
examples/next-prismic
A compact App Router reference for copying cms-lab config into an existing Next.js + Prismic project.Run in StackBlitz

Run locally

Local runs are still the most accurate way to test a project that needs private CMS tokens, staging URLs, or a real Next.js server.

cd examples/broken-prismic-demo
npx @cms-lab/cli doctor
npx @cms-lab/cli scan --ci --report --markdown --junit --fail-on never

Config examples

Some examples are documentation-first because they need a real CMS and a real frontend before they can be runnable in a browser workspace.

Use it in GitHub Actions

The Marketplace Action uses the same CLI. Start with the browser examples, then wire the same config into CI when the project scan is useful.

- uses: i-afaqrashid/cms-lab@v1
  with:
    config: cms-lab.config.ts
    report: true

See CI setup for artifact upload and threshold options.