Ask AI

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.


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


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


Reduce command verbosity.


Trust peer certificate.


Overwrite existing credential file if any.