Setup & health
Install Sunboard, check the wiring, and validate 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 and publishable key, 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 for fast local feedback. The spec is read
from stdin (an explicit [file] is supported for scripts). Treat any reported
issue as a blocker before deploying.
sunboard validate --json <<'YAML'
key: trial-activation
name: Trial activation
title: Welcome
type: guide
checklist:
steps:
- key: first-step
title: First step
YAML| Argument / Option | Description |
|---|---|
[file] | Optional path to a spec. Defaults to reading the spec from stdin. |
--json | Print machine-readable JSON output. |
To see a spec running, deploy it to the sandbox and open your app on the
pk_test_ key. See Deploy & promote and
Environments.