Setup & health
Install Sunboard, check the wiring, and validate or preview a spec locally.
sunboard init
Install Sunboard into a Next.js App Router or React/Vite app: adds the SDK, wires the runtime provider, scaffolds a starter spec, binds a project, and installs agent skills. Interactive by default. See the Quick start for the full walkthrough.
sunboard init [--app <path>] [--framework <next|vite>] [--harness <list>] [--no-login] [--yes]| Option | Description |
|---|---|
--app <path> | Path to the app root, relative to the current directory. |
--framework <next|vite> | Framework to install into (auto-detected when possible). |
--harness <list> | Harness(es) to install skills for. Repeat or comma-separate, e.g. --harness codex,claude. Valid: codex, claude, opencode. |
--no-login | Skip login and write a stub publishable key for offline dev. |
--yes, -y | Skip prompts, accept defaults, and overwrite generated files. |
sunboard doctor
Diagnose an installation — checks the runtime wrapper, publishable key, and specs directory, and reports anything missing.
sunboard doctor [--app <path>] [--framework <next|vite>] [--json]| Option | Description |
|---|---|
--app <path> | Path to the app root, relative to the current directory. |
--framework <next|vite> | Framework to check. |
--json | Print machine-readable JSON output. |
sunboard validate
Validate a spec against the schema. Treat any reported issue as a blocker before previewing or deploying.
sunboard validate [file] [--json]| Argument / Option | Description |
|---|---|
[file] | Path to a spec. Defaults to sunboard/specs/activation.yaml. |
--json | Print machine-readable JSON output. |
sunboard preview
Boot your dev server and serve a spec against the real app so you can walk the checklist and tours. The spec hot-reloads on save — no restart needed.
sunboard preview [file] [--app <path>] [--framework <next|vite>] [--url <url>] [--route <route>] [--no-start] [--preview-port <port>] [--open]| Argument / Option | Description |
|---|---|
[file] | Path to a spec. Defaults to sunboard/specs/activation.yaml. |
--app <path> | Path to the app root, relative to the current directory. |
--framework <next|vite> | Framework to preview. |
--url <url> | Preview against an already-running app at this URL. |
--route <route> | Route to open in the app. |
--no-start | Don't start the dev server (use with --url when the app is already running). |
--preview-port <port> | Port for the local Sunboard preview sidecar. |
--open | Open the preview URL in the browser. |