VibeDB CLI

Command-line interface for VibeDB - instant database provisioning for AI-assisted development.

Installation

Via NPX (Recommended)

npx @vibedb/cli signup

Global Installation

npm install -g @vibedb/cli
vibedb signup

Local Development

git clone <repo>
cd cli
npm install
node bin/vibedb.js --help

Quick Start

1. Create an Account

npx @vibedb/cli signup

You'll be prompted for:

• Email address
• Password (minimum 8 characters)
• Password confirmation

Your API key will be saved to ~/.vibedb

2. Or Login to Existing Account

npx @vibedb/cli login

3. Initialize Your Project

cd your-project
npx @vibedb/cli init

This downloads VIBEDB.md to your current directory. This file tells your AI assistant how to provision databases.

4. Tell Your AI to Create a Database

Open your AI coding assistant (Claude, Cursor, etc.) and say:

"I need a PostgreSQL database for my blog app"

The AI will read VIBEDB.md, use your API key from ~/.vibedb, and provision a database automatically!

Commands

vibedb signup

Create a new VibeDB account.

Interactive prompts:

• Email
• Password
• Confirm password

Output:

• Account ID
• API key (saved to ~/.vibedb)

vibedb login

Login to existing account.

Interactive prompts:

• Email
• Password

Output:

• API key (saved to ~/.vibedb)

vibedb init

Download the VIBEDB.md prompt file to your project.

Requirements:

• Must be logged in (run vibedb signup or vibedb login first)

Output:

• Downloads VIBEDB.md to current directory
• Shows your configured API key

vibedb list (alias: ls)

List all your databases.

Requirements:

• Must be logged in

Output:

• Table showing all databases with ID, Name, Type, and Status
• Note: Shows databases for your current team only

vibedb teams list (alias: teams ls)

List all teams you belong to.

Requirements:

• Must be logged in

Output:

• Table showing team ID, name, role, type, and current indicator
• Shows which team is currently selected

vibedb teams switch <team_id>

Switch to a different team.

Requirements:

• Must be logged in
• Team ID from vibedb teams list

Example:

vibedb teams switch team_abc123

Output:

• Confirmation of team switch
• All subsequent commands use this team context

vibedb teams current

Show currently selected team.

Requirements:

• Must be logged in

Output:

• Current team details (ID, name, role, type)

vibedb usage

Show current usage and costs.

Requirements:

• Must be logged in

Output:

• Storage breakdown (database + backup storage)
• Estimated charges for current period
• Pricing information

Example:

vibedb usage

📊 Usage & Costs

Storage Usage:
  Database Storage: 45.23 MB
  Backup Storage: 12.67 MB
  ─────────────────
  Total Storage: 57.90 MB

Estimated Charges:
  Current Period: $0.0823 USD

Pricing:
  Storage: $0.00014 per GB-hour
  Compute: $0.000167 per minute

vibedb backup list <database_id>

List all backups for a database.

Requirements:

• Must be logged in
• Valid database ID

Output:

• List of backups with ID, type (auto/manual), size, and creation date

Example:

vibedb backup list db_abc123

💾 Backups

Found 3 backup(s):

1. d4339369-a3bb-492c-afe3-2124265e9b56
   Type: [Manual]
   Size: 12.34 MB
   Created: 1/12/2026, 8:30:06 PM

2. a1234567-b8cd-9012-efgh-345678901234
   Type: [Auto]
   Size: 11.98 MB
   Created: 1/12/2026, 2:00:00 AM

vibedb backup create <database_id>

Create a manual backup.

Requirements:

• Must be logged in
• Valid database ID

Output:

• Backup ID and creation timestamp

Example:

vibedb backup create db_abc123

✓ Backup created successfully!

Backup ID: d4339369-a3bb-492c-afe3-2124265e9b56
Type: [Manual]
Created: 1/12/2026, 8:30:06 PM
Size: 12.34 MB

Restore this backup with:
vibedb backup restore db_abc123 d4339369-a3bb-492c-afe3-2124265e9b56

vibedb backup restore <database_id> <backup_id>

Restore a database from a backup.

Requirements:

• Must be logged in
• Valid database ID and backup ID
• Confirmation required (interactive)

Warning: This will replace ALL current data in the database!

Example:

vibedb backup restore db_abc123 d4339369-a3bb-492c-afe3-2124265e9b56

🔄 Restore Backup

⚠️  WARNING:
This will replace ALL current data in the database with the backup.
This action cannot be undone.

Database ID: db_abc123
Backup ID: d4339369-a3bb-492c-afe3-2124265e9b56

Are you sure you want to restore this backup? (y/N): y

✓ Backup restored successfully!

vibedb backup delete <database_id> <backup_id>

Delete a backup.

Requirements:

• Must be logged in
• Valid database ID and backup ID
• Confirmation required (interactive)

Example:

vibedb backup delete db_abc123 d4339369-a3bb-492c-afe3-2124265e9b56

🗑️  Delete Backup

Database ID: db_abc123
Backup ID: d4339369-a3bb-492c-afe3-2124265e9b56

Are you sure you want to delete this backup? (y/N): y

✓ Backup deleted successfully!

Configuration

The CLI stores your credentials in ~/.vibedb:

{
  "api_key": "vdb_xxx...",
  "email": "[email protected]",
  "api_url": "https://api.vibedb.dev",
  "current_team_id": "team_abc123"
}

Team Context: The CLI remembers your current team selection. Use vibedb teams switch to change teams.

Security Note: Keep this file secure. Anyone with your API key can manage your databases.

Examples

Complete Workflow

# 1. Sign up
$ npx @vibedb/cli signup
? Email: [email protected]
? Password: ********
? Confirm password: ********

✓ Account created successfully!
Email: [email protected]
API Key: vdb_abc123...

# 2. Initialize project
$ cd my-project
$ npx @vibedb/cli init

✓ VIBEDB.md downloaded successfully!
Location: /path/to/my-project/VIBEDB.md

# 3. Tell your AI assistant
> "I need a Postgres database for user authentication"

# 4. Check your databases
$ npx @vibedb/cli list

┌─────────────────┬───────────┬──────────┬────────┐
│ ID              │ Name      │ Type     │ Status │
├─────────────────┼───────────┼──────────┼────────┤
│ db_abc123       │ auth-db   │ postgres │ ready  │
└─────────────────┴───────────┴──────────┴────────┘

Total: 1 database

Working with Teams

# List all your teams
$ vibedb teams list

┌──────────────────┬──────────────┬────────┬──────────┬─────────┐
│ ID               │ Name         │ Role   │ Type     │ Current │
├──────────────────┼──────────────┼────────┼──────────┼─────────┤
│ team_abc123      │ John's Team  │ owner  │ Personal │ ✓       │
│ team_xyz789      │ Acme Corp    │ member │ Team     │         │
└──────────────────┴──────────────┴────────┴──────────┴─────────┘

Total: 2 teams

# Switch to a different team
$ vibedb teams switch team_xyz789

✓ Successfully switched to team
Team: Acme Corp
Role: member

# List databases in the new team context
$ vibedb list

┌─────────────────┬────────────────┬──────────┬────────┐
│ ID              │ Name           │ Type     │ Status │
├─────────────────┼────────────────┼──────────┼────────┤
│ db_def456       │ production-db  │ postgres │ ready  │
│ db_ghi789       │ staging-cache  │ redis    │ ready  │
└─────────────────┴────────────────┴──────────┴────────┘

Total: 2 databases

# Check current team
$ vibedb teams current

📍 Current Team

ID: team_xyz789
Name: Acme Corp
Role: member
Type: Team

Supported Databases

• PostgreSQL - General purpose relational database
• MySQL - Traditional relational database
• Redis - In-memory cache and session store

Coming soon:

• MongoDB
• ClickHouse

Troubleshooting

"Not logged in" Error

Run vibedb login or vibedb signup first.

"Email already exists" During Signup

The email is already registered. Use vibedb login instead.

"Invalid credentials" During Login

Check your email and password. Passwords are case-sensitive.

API Connection Issues

• Check your internet connection
• Verify api.vibedb.dev is accessible
• Check firewall settings

Config File Issues

Your config is at ~/.vibedb. If corrupted:

rm ~/.vibedb
vibedb login

API Reference

The CLI interacts with these VibeDB API endpoints:

• POST /v1/auth/signup - Create account
• POST /v1/auth/login - Authenticate
• GET /v1/databases - List databases
• GET /v1/prompt-file - Download prompt file
• GET /v1/account - Get account info and usage
• GET /v1/teams - List teams
• GET /v1/databases/{id}/backups - List backups
• POST /v1/databases/{id}/backups - Create backup
• POST /v1/databases/{id}/backups/{backup_id}/restore - Restore backup
• DELETE /v1/databases/{id}/backups/{backup_id} - Delete backup

Full API docs: https://api.vibedb.dev/docs

Support

• Website: https://vibedb.dev
• Email: [email protected]
• Issues: https://github.com/vibedb/cli/issues

License

MIT