Skip to main content
Scaffold a full-stack AI agent app, develop locally, and deploy to Yboard’s infrastructure — all from the terminal.

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):
See the CLI Reference for detailed plugin setup instructions. Or install globally with Bun:

2. Authenticate

Log in to your Yboard account:
This opens your browser for device-code authentication. Once approved, your credentials are stored locally at ~/.yboard/auth.json.

3. Create a project

Scaffold a new project from the starter template:
This clones the template, removes the git history, re-initializes git, and installs dependencies.

4. Initialize the app

From inside your project directory, provision a database and secrets:
This creates a Neon Postgres database branch and stores the configuration in .yboard.json.

5. Deploy

Build and deploy your application:
The CLI will:
  1. Fetch your database URL.
  2. Push the database schema with drizzle-kit push.
  3. Build the application with Vite.
  4. Upload client and server files to Yboard.
Once complete, you’ll see your live URL in the terminal.

Next steps