CLI
The sunboard command — every command, flag, and convention. Your agent runs these for you, but you can drive them directly too.
The sunboard CLI is the deterministic tool layer your AI agent drives through
skills. Most of the time you won't run it directly — but every
command works on its own when you want to script something or work outside an
agent.
Install
npm install -g sunboardRequires Node.js 18 or later. Authenticate once with sunboard login.
Conventions
A handful of flags work across many commands:
| Flag | Applies to | What it does |
|---|---|---|
--json | most commands | Print machine-readable JSON (stable, AI-friendly). |
--app <path> / --framework <next|vite> | project commands | Locate the app whose env holds your publishable key. |
--project <publicId> | project commands | Target a project directly, skipping the app env lookup. |
--dry-run | mutating commands | Print the proposed change without applying it. |
--yes, -y | mutating commands | Skip the confirmation prompt (required in --json mode). |
--no-update-check | all commands | Skip the non-blocking CLI update check. |
Mutations are explicit
Commands that change hosted state (segments and routing) prompt for
confirmation, support --dry-run, and require --yes when run with --json.