Skip to main content
The Yboard CLI (@yboard/cli) manages authentication, project setup, deployment, secrets, and logs.

​
Install

​
Option 1: Install via Claude Code Plugin

If you use Claude Code (or OpenAI Codex), install the Yboard plugin to get CLI access directly inside your AI coding agent. The plugin lets you log in and use all Yboard services without leaving your editor. Install the plugin from the repository:
See the plugins repository for full setup instructions.

​
Option 2: Install globally with Bun

Or run directly without installing:

​
Commands

​
login

Authenticate with Yboard using device-code flow.
Opens your browser to complete authentication. Credentials are stored at ~/.yboard/auth.json. Options:
  • --code-only — Print the device code and verification URL as JSON, then exit. Useful for CI or headless environments.
  • --device-code <code> — Poll for authentication using an existing device code.

​
logout

Remove stored credentials.

​
whoami

Display the currently authenticated user.

​
setup

Create a new project from the Yboard starter template.
Arguments:
  • [directory] — Override the folder name (defaults to the template repo name).
What it does:
  1. Verifies your subscription.
  2. Clones the private starter template.
  3. Removes .git and re-initializes.
  4. Installs dependencies with bun install.

​
init

Provision a database and secrets for the current project.
Creates a Neon Postgres database branch and writes the configuration to .yboard.json in your project root. Must be run from a project directory. Requires authentication.

​
deploy

Build and deploy the application.
Options:
  • --skip-db — Skip the database schema push step.
What it does:
  1. Fetches the database URL from Yboard.
  2. Pushes the database schema using drizzle-kit push.
  3. Builds the application with bun vite build.
  4. Uploads client and server files to Yboard.
  5. Prints the deployment URL.
Must be run from the project root (expects apps/web directory).

​
logs

View runtime logs for the deployed application.
Fetches and displays recent logs from your deployed worker. Requires a prior deployment (yboard deploy).

​
secrets

Manage application secrets (environment variables).

​
secrets list

List all secret names for the current app.

​
secrets set

Set one or more secrets.
Options:
  • -f, --env-file <path> — Read secrets from a .env file.

​
secrets delete

Delete a secret by name.

​
Configuration

​
Global config

Auth credentials are stored at ~/.yboard/auth.json. The API endpoint defaults to https://worker.yboard.app/cli and can be overridden with the YBOARD_API_URL environment variable.

​
Project config

Project-level configuration is stored in .yboard.json at the project root:
This file is created by yboard init and updated by yboard deploy.