Light
Dark
System
v4latest
v5dev
v4latest
v3
v2
v1

edgedb instance link

Authenticate a connection to a remote EdgeDB instance and assign an instance name to simplify future connections.

edgedb instance link [options] name

edgedb instance link is a terminal command used to bind a set of connection credentials to an instance name. This is typically used as a way to simplify connecting to remote EdgeDB database instances. Usually there’s no need to do this for local instances as edgedb project init will already set up a named instance.

Unlike other edgedb instance sub-commands, edgedb instance link is recommended to link self-hosted instances. This can make other operations like migrations, dumps, and restores more convenient.

Linking is not required for EdgeDB Cloud instances. They can always be accessed via CLI using <org-name>/<instance-name>.

The instance link command uses the standard connection options for specifying the instance to be linked.

name

Specifies a new instance name to associate with the connection options. If not present, the interactive mode will ask for the name.

--non-interactive

Run in non-interactive mode (accepting all defaults).

--quiet

Reduce command verbosity.

--trust-tls-cert

Trust peer certificate.

--overwrite

Overwrite existing credential file if any.

Light
Dark
System

We use ChatGPT with additional context from our documentation to answer your questions. Not all answers will be accurate. Please join our Discord if you need more help.