Initialize a new EdgeDB instance.
edgedb instance create [options] name
edgedb instance create is a terminal command for making a new EdgeDB
instance and creating a corresponding credentials file in
edgedb info to see the path to
<edgedb_config_dir> on your machine.
The new EdgeDB instance name.
Use the nightly server for this instance.
Specifies the default database name (created during
initialization, and saved in credentials file). Defaults to
Specifies the default user name (created during initialization,
and saved in credentials file). Defaults to:
Specifies which port should the instance be configured on. By default a random port will be used and recorded in the credentials file.
Configures how the new instance should start:
automatic start with the system or user session,
turn that off so that the instance can be manually started with
edgedb instance start on demand. Defaults to:
Specifies the version of the EdgeDB server to be used to run the new instance. To list the currently available options use edgedb server list-versions.
By default, when you specify a version, the CLI will use the latest release in the major version specified. This command, for example, will install the latest 2.x release:
edgedb instance create --version 2.6 demo26
You may pin to a specific version by prepending the version number with an equals sign. This command will install version 2.6:
edgedb instance create --version =2.6 demo26
Some shells like ZSH may require you to escape the equals sign (e.g.,
\=2.6) or quote the version string (e.g.,