Prerequisites
- Bun installed (or Node.js 18+).
- A Yboard account. Sign up at yboard.app.
1. Install the CLI
Via Claude Code plugin (recommended if you use Claude Code or OpenAI Codex):2. Authenticate
Log in to your Yboard account:~/.yboard/auth.json.
3. Create a project
Scaffold a new project from the starter template:4. Initialize the app
From inside your project directory, provision a database and secrets:.yboard.json.
5. Deploy
Build and deploy your application:- Fetch your database URL.
- Push the database schema with
drizzle-kit push. - Build the application with Vite.
- Upload client and server files to Yboard.
Next steps
- CLI Reference — Explore all available commands.
- Project Structure — Understand the scaffolded app layout.
- Secrets & Environment — Configure environment variables.
- Deploying — Learn about deployment environments and options.