EdgeDB includes the all-encompassing edgedb command-line tool. It provides an idiomatic way to do just about everything: install EdgeDB, spin up a local instance, open a REPL, execute queries, manage auth roles, introspect a database schema, create migrations, and more.

You can install it with one shell command.

Installation

On Linux or MacOS, run the following in your terminal and follow the on-screen instructions:

Copy
$ 
curl --proto '=https' -sSf1 https://sh.edgedb.com | sh

For Windows, the installation script is:

Copy
PS> 
iwr https://ps1.edgedb.com -useb | iex
  • The script, inspired by rustup, will detect the OS and download the appropriate build of the EdgeDB CLI tool, edgedb.

  • The edgedb command is a single executable (it’s open source!)

  • Once installed, the edgedb command can be used to install, uninstall, upgrade, and interact with EdgeDB server instances.

  • You can uninstall EdgeDB server or remove the edgedb command at any time.

With command-line tools installed see server installation or connection options to connect to a remote server.

To install the nightly version of the command-line tools (that’s not the same as the nightly version of the EdgeDB server) use this command:

Copy
$ 
  
curl --proto '=https' --tlsv1.2 -sSf https://sh.edgedb.com | \
sh -s -- --nightly

Uninstallation

Command-line tools contain just one binary, so to remove it on Linux or macOS run:

Copy
$ 
rm "$(which edgedb)"

To also remove configuration files:

Copy
$ 
rm -rf ~/.edgedb

If the command-line tool was installed by the user (recommended) then it will also remove the binary.

If you’ve used edgedb server commands you can also delete instances and server packages, prior to removing the tool:

Copy
$ 
edgedb server destroy <instance_name>
Copy
$ 
edgedb server uninstall --version=<ver>

To list instances and server versions use the following commands respectively:

Copy
$ 
edgedb server status
Copy
$ 
edgedb server list-versions --installed

Notes on network usage

Light
Dark
System