Skip to main content
The yboard CLI is a command-line tool that lets your team manage the full lifecycle of a yboard application — from initial setup to production deployment — all from the terminal.

What Can You Do With It?


Features at a Glance

1. Account & Authentication

Securely sign in using your browser — no passwords stored locally. How it works: When you run yboard login, a one-time code is displayed in the terminal. You confirm it in your browser, and the CLI securely stores your session credentials on your machine (~/.yboard/auth.json).

2. Project Setup

Get a new project up and running in seconds. After setup, a .yboard/config.json file is created in your project containing your app ID, database branch, and deployment target.

3. Secrets Management

Safely store API keys, database credentials, and other sensitive values that your app needs at runtime. Secrets are stored server-side and injected into your application at runtime — they never appear in your code or version control.

4. Deployment

Ship your application to production with a single command. What happens during a deploy: Once deployed, you receive a live URL where your application is accessible.

5. Production Logs

Monitor your deployed application in real time.

6. Version Info


How Everything Connects

The diagram below shows how the different areas of the CLI depend on each other: Key takeaways:
  • Authentication is required before any other command works.
  • Project configuration (from yboard init) tells the CLI which app and database to target.
  • Deployment builds and ships your app, then updates the project config with the deployment target.
  • Logs use the deployment target from your project config to show the right output.
  • Secrets are managed per-project and available to your app at runtime.