Skip to main content
This command also takes -h, --help.

​
console

Open an interactive branch console
​
string
Organization ID
​
string
Project ID
​
string
Branch ID
​
string
Database name
​
primary | primary-or-replica | replica | pooler
default:"primary"
Connection type: primary (direct access to the primary), primary-or-replica (routed access to primary or replicas), replica (read-only access to replicas only), pooler (pooled access to the primary)
​
string
The profile to use
​
boolean
Print where each resolved value came from
​
boolean
Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.