DBStudio

Installation

Get DBStudio up and running on your machine.

Installation

The fastest way to get started with DBStudio is through our web-based dashboard and local CLI agent.

1. Create an Account

Head over to DBStudio Cloud and create your free account. Once logged in, you'll have access to your personal workspace.

2. Install the CLI

The DBStudio CLI acts as a secure bridge between your local database and the cloud interface. Install it globally using your favorite package manager:

# Using npm
npm install -g @dbstudio/cli

# Using bun (recommended)
bun add -g @dbstudio/cli

# Using pnpm
pnpm add -g @dbstudio/cli

or run it directly without installing by

# Using npm
npx @dbstudio/cli

# Using bun (recommended)
bunx @dbstudio/cli

# Using pnpm
pnpm dlx -g @dbstudio/cli

3. Connect your first Database

Once logged in, you can start a bridge to a local database. For example, to connect a local PostgreSQL database:

@dbstudio/cli connect --type postgresql --database my_local_db --user postgres

Next Steps

Now that you have the CLI installed and running, explore how to:

Having trouble? Check our Troubleshooting Guide or join our Discord Community.

On this page