Preview

Preview a Sunboard onboarding spec in the local app.

/sunboard.preview runs a spec against your real local app so you can walk the checklist and tours yourself before anyone sees them.

When to use it

  • After authoring or implementing a spec, to verify it looks and behaves right.
  • While iterating on copy, order, routes, or selectors.

What happens

  1. Validates the spec — every issue is a blocker.
  2. Checks install health with sunboard doctor.
  3. Starts the preview with sunboard preview and prints a URL. If your app is already running, it attaches with --no-start --url.
  4. Hands off to you to walk through the experience in the browser.
  5. Iterates without restarting — saving the spec hot-reloads the runtime in place.

A human check, not a test

Preview is a verification workflow, not automated testing — it confirms what you can see, not that anything "passes." It keeps running until you stop it (Ctrl+C). If the terminal shows [sunboard] spec change ignored, the YAML on disk didn't parse; fix it and save again — no restart needed. Preview never deploys.

On this page