CLI Commands

The DBStudio CLI (@dbstudio/cli) is your primary tool for connecting local databases to the cloud dashboard.

Commands

@dbstudio/cli connect

Establish a secure bridge between a local database and DBStudio.

Required Flags:

• -t, --token <token>: Your DBStudio connection token (generate this in the dashboard).

Configuration Flags:

• --type <type>: Database engine (postgresql, mysql, sqlite, libsql).
• -u, --user <user>: Database username.
• -d, --database <name>: Database name.
• -h, --host <host>: Database host (default: localhost).
• -p, --port <port>: Database port.
• --password <pass>: Database password.
• -f, --file <path>: Path to database file (SQLite only).
• --url <url>: Full connection string (overrides other params).
• --ssl: Enable SSL encryption for the connection.

SSH Tunneling:

• --ssh-host <host>: SSH tunnel host.
• --ssh-user <user>: SSH tunnel username.
• --ssh-password <password>: SSH tunnel password.
• --ssh-key <path>: Path to SSH private key.

@dbstudio/cli status

View the status of the local agent and active connections.

@dbstudio/cli disconnect

Terminate all active database bridges and stop the local agent.

---