The EdgeDB CLI​

The edgedb command-line interface (CLI) provides an idiomatic way to install EdgeDB, spin up local instances, open a REPL, execute queries, manage auth roles, introspect 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:

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

For Windows, the installation script is:

  1. PS>
  1. 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.

Connection options

All commands respect a common set of connection options, which let you specify a target instance. This instance can be local to your machine or hosted remotely.

Nightly version

To install the nightly version of the CLI (not to be confused with the nightly version of EdgeDB itself!) use this command:

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

Uninstallation

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

  1. rm "$(which edgedb)"

To remove all configuration files, run edgedb info to list the directories where EdgeDB stores data, then use rf -rf <dir> to delete those directories.

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

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

  1. edgedb instance destroy <instance_name>
  1. edgedb server uninstall --version=<ver>

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

  1. edgedb instance status
  1. edgedb server list-versions --installed-only

Configure CLI and REPL

You can customize the behavior of the edgedb CLI and REPL with a global configuration file. The file is called cli.toml and its location differs between operating systems. Use edgedb info to find the “Config” directory on your system.

The cli.toml has the following structure. All fields are optional:

  1. [shell]
  2. expand-strings = true         # Stop escaping newlines in quoted strings
  3. history-size = 10000          # Set number of entries retained in history
  4. implicit-properties = false   # Print implicit properties of objects
  5. limit = 100                   # Set implicit LIMIT
  6.                               # Defaults to 100, specify 0 to disable
  7. input-mode = "emacs"          # Set input mode. One of: vi, emacs
  8. output-format = "default"     # Set output format.
  9.                               # One of: default, json, json-pretty,
  10.                               # json-lines
  11. print-stats = "off"           # Print statistics on each query.
  12.                               # One of: off, query, detailed
  13. verbose-errors = false        # Print all errors with maximum verbosity

Notes on network usage