sunboard
v0.3.0
Published
The Sunboard CLI: agent-native onboarding for SaaS apps.
Downloads
1,365
Maintainers
Readme
sunboard
Turn your AI coding agent into your customer success agent.
Sunboard helps you plan, build, and improve onboarding inside your real product. Instead of guessing what new users need or maintaining onboarding in a separate editor, you work through it with the coding agent that already understands your app.
Your agent can:
- study the product and identify the actions that lead users to value,
- plan different onboarding paths for different customers,
- build surveys, checklists, product tours, and in-app guidance,
- wire the experience into the real application,
- test everything safely before customers see it,
- analyze where users get stuck and improve the flow with you.
Install
npm i -g sunboard
sunboard login
cd your-app
sunboard initRequires Node.js 18 or later. sunboard init supports Next.js, TanStack Start,
React Router, and Vite, and installs skills for Codex, Claude Code, or opencode.
Plan and build onboarding with your agent
Start a conversation with the onboarding skill:
Claude Code / opencode: /sunboard.onboarding
Codex: $sunboard-onboardingThen describe the outcome you want:
Help me plan onboarding for new trial users. I want them to understand the
product and publish their first workflow as quickly as possible.Your agent acts like a customer success partner. It talks through who your users are, what success looks like, which actions predict activation, and whether different customers need different paths. Once you agree on the plan, it builds the onboarding in your app and deploys it to a safe sandbox for you to try.
You do not need to start with a finished funnel, a perfect event taxonomy, or a pile of YAML. Start with what you know about your customers and work it out together.
Analyze and improve onboarding together
Once users are moving through the product, ask your agent to analyze the data:
Claude Code / opencode: /sunboard.analyze
Codex: $sunboard-analyzeFor example:
Analyze our onboarding. Where are trial users dropping off, and what should we
change to help more of them reach activation?The agent reads the real onboarding funnel, step completion, segment, and tour data. It explains what appears to be happening, proposes concrete changes, and can help you implement and test the next iteration. The point is not another analytics dashboard to stare at. It is a working session with an agent that can both diagnose the problem and change the product.
A safe path from idea to production
Sunboard gives every project a sandbox and a production environment.
- Your agent builds and deploys changes to the sandbox.
- You run the app locally and experience the real onboarding flow.
- You reset test users and repeat the journey as often as needed.
- When it feels right, you promote the tested version to production.
/sunboard.analyzeuses production data to guide the next improvement.
The sandbox uses a pk_test_... key and production uses a separate
pk_live_... key. Sandbox users never count toward billable MAU, and CLI writes
to production are blocked. Production changes only through an explicit promotion.
What sunboard init sets up
The installer handles the plumbing so you can stay in the conversation with your agent. It:
- installs
@sunboard/react, - creates or connects a Sunboard project,
- adds the runtime provider to your application,
- writes the sandbox key for local development,
- creates a starter
sunboard/specs/directory, - installs the Sunboard skills for your coding-agent harness.
Agent skills
Most users only need the two front doors:
| Skill | Use it when... |
|---|---|
| sunboard-onboarding | You want to plan, build, or substantially change onboarding. |
| sunboard-analyze | You want to understand real user behavior and improve an existing flow. |
The other skills are focused tools that those workflows can call, or that you can use directly when you already know the exact job:
| Skill | Purpose |
|---|---|
| sunboard-spec | Author or revise one onboarding experience. |
| sunboard-tour | Add or refine a product tour. |
| sunboard-implement | Wire selectors and completion events into the app. |
| sunboard-deploy | Validate and activate a change in the sandbox. |
| sunboard-segment | Define customer groups and their onboarding paths. |
| sunboard-survey | Build the onboarding survey that personalizes the journey. |
| sunboard-checklist-ui / sunboard-survey-ui | Match onboarding UI to the host application's design system. |
Claude Code and opencode expose these as slash commands such as
/sunboard.onboarding. Codex exposes $sunboard-onboarding-style skills.
Direct CLI reference
You usually let the agent drive these commands. They are also available directly for scripting and debugging.
| Command | What it does |
|---|---|
| sunboard login / whoami / logout | Authenticate this machine. |
| sunboard init | Install the SDK, project connection, runtime wrapper, and agent skills. |
| sunboard doctor | Diagnose installation and runtime wiring problems. |
| sunboard validate [spec] | Validate an onboarding specification. |
| sunboard deploy [spec] | Upload and activate a version in the sandbox. |
| sunboard promote <experience> | Show the production diff, confirm it, and synchronize the tested experience, including removed routing. |
| sunboard promote --survey | Synchronize the tested onboarding survey, including clearing it. |
| sunboard env clear | Clear sandbox users and runtime progress so onboarding can be replayed. |
| sunboard env clone | Preview the replacement counts, then rebuild the sandbox from production's active content. |
| sunboard pull --environment <key> | Export active hosted specs to local YAML files. |
| sunboard experiences list\|get | Inspect hosted experiences. |
| sunboard segments list\|get\|create\|update\|delete | Inspect or change sandbox segments. |
| sunboard routing list\|attach\|detach\|pause\|resume | Manage which segments receive an experience. |
| sunboard survey show\|set\|clear | Manage the active onboarding survey. |
| sunboard analytics experience <key> | Inspect an experience's production analytics. |
| sunboard state | Print experiences, segments, and routing for one environment. |
| sunboard skills update | Refresh installed skills after upgrading the CLI. |
Inspection commands support --json. Mutating commands that expose --dry-run
and --yes use them for machine-readable previews and explicit confirmation.
Links
- Learn more: https://sunboardhq.com
- Documentation: https://sunboardhq.com/docs
- Create an account: https://app.sunboardhq.com/register
License
MIT. See LICENSE.
