edgedb CLI supports a standard set of connection flags used to specify
the target of a given command. The CLI always respects any connection
parameters passed explicitly using flags.
If no flags are provided, then environment variables will be used to determine the instance.
If no environment variables are present, the CLI will check if the working directory is within an instance-linked project directory.
If none of the above are present, the command fails.
For a detailed breakdown of how connection information is resolved, read the Connection Parameter Resolution docs.
Specifies the named instance to connect to. The actual connection
parameters are stored in
<edgedb_config_dir>/credentials and are
usually created by edgedb instance create or similar
edgedb info to see the location of
<edgedb_config_dir> on your machine.
This option overrides host and port.
Specifies the DSN for EdgeDB to connect to.
This option overrides all other options except password.
Path to JSON file containing credentials.
Specifies the host name of the machine on which the server is running.
If hostname begins with a slash (
/), it is used
as the directory where the command looks for the server Unix-domain
socket. Defaults to the value of the
Specifies the TCP port or the local Unix-domain socket file extension
on which the server is listening for connections. Defaults to the value
EDGEDB_PORT environment variable or, if not set, to
Connect to the database as the user username.
Defaults to the value of the
EDGEDB_USER environment variable, or,
if not set, to the login name of the current OS user.
Specifies the name of the database to connect to. Default to the value
EDGEDB_DATABASE environment variable, or, if not set, to
the calculated value of username.
If --password is specified, force
edgedb to prompt
for a password before connecting to the database. This is usually not
edgedb will prompt for a password automatically
if the server requires it.
Specifying --no-password disables all password prompts.
Use the first line of standard input as the password.
Certificate to match server against.
This might either be full self-signed server certificate or certificate authority (CA) certificate that server certificate is signed with.
Set the TLS security mode.
strict if no custom certificate is supplied via
--tls-ca-file, environment variable, etc. Otherwise,
Verify TLS certificate and hostname.
This allows using any certificate for any hostname. However, certificate must be present and match the root certificate specified with --tls-ca-file, credentials file, or system root certificates.
Disable all TLS security measures.
In case EdgeDB connection can’t be established, keep retrying up
to wait_time (e.g.
Specifies a timeout period. In case EdgeDB
doesn’t respond for this period the command will fail (or retry if
--wait-until-available is also specified). The
timeout value must be given using time units
ms, etc.). The default