edgedb instance create​

Initialize a new EdgeDB instance.

edgedb instance create [options] name

Description​

edgedb instance create is a terminal command for making a new EdgeDB instance and creating a corresponding credentials file in <edgedb_config_dir>/credentials. Run edgedb info to see the path to <edgedb_config_dir> on your machine.

Options​

name

The new EdgeDB instance name.

-i, —interactive

Performs the installation in interactive mode, similar to how downloading and installing works.

--nightly

Use the nightly server for this instance.

--overwrite

Overwrite data directory and credential file if any of these exist. This is mainly useful for recovering from interrupted initializations.

--default-database=default-database

Specifies the default database name (created during initialization, and saved in credentials file). Defaults to edgedb.

--default-user=default-user

Specifies the default user name (created during initialization, and saved in credentials file). Defaults to: edgedb.

--method=method

Specifies which EdgeDB server should be used to run the new instance: package or docker. To list the currently available options use edgedb server list-versions.

--port=port

Specifies which port should the instance be configured on. By default a random port will be used and recorded in the credentials file.

--start-conf=start-conf

Configures how the new instance should start: auto for automatic start with the system or user session, manual to turn that off so that the instance can be manually started with edgedb instance start on demand. Defaults to: auto.

--version=version

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.