Light
Dark
System
v4latest
v5dev
v4latest
v3
v2
v1

Using EdgeDB Cloud via the CLI

To use EdgeDB Cloud via the CLI, first log in using edgedb cloud login. Once your login is successful, you will be able to create an instance using either edgedb instance create or edgedb project init, depending on whether you also want to create a local project linked to your instance.

  • edgedb instance create with an instance name of <org-name>/<instance-name>.

    Copy
    $ 
    edgedb instance create <org-name>/<instance-name>
  • edgedb project init with the --server-instance option. Set the server instance name to <org-name>/<instance-name>.

    Copy
    $ 
      
    edgedb project init \
    --server-instance <org-name>/<instance-name>

    Alternatively, you can run edgedb project init without the --server-instance option and enter an instance name in the <org-name>/<instance-name> format when prompted interactively.

Please be aware of the following restrictions on EdgeDB Cloud instance names:

  • can contain only Latin alpha-numeric characters or -

  • cannot start with a dash (-) or contain double dashes (--)

  • maximum instance name length is 61 characters minus the length of your organization name (i.e., length of organization name + length of instance name must be fewer than 62 characters)

To use edgedb instance create:

Copy
$ 
edgedb instance create <org-name>/<instance-name>

To use edgedb project init:

Copy
$ 
  
edgedb project init \
--server-instance <org-name>/<instance-name>

Alternatively, you can run edgedb project init without the --server-instance option and enter an instance name in the <org-name>/<instance-name> format when prompted interactively.

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.