CLI

The EdgeDB command-line interface (CLI) provides an idiomatic interface for installing EdgeDB, spinning up local instances, opening a REPL, executing queries, interacting with EdgeDB Cloud, creating migrations, and more.

Installation

First let's install the EdgeDB CLI. Open a terminal and run the appropriate command below.

Linux/macOS

Copy

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

Windows (Powershell)

EdgeDB on Windows requires WSL 2 because the EdgeDB server runs on Linux.

Copy

PS>

iwr https://ps1.edgedb.com -useb | iex

Check out our additional installation methods for various Linux distros, via Homebrew on macOS, and for the Windows Command Prompt.

Nightly

Use this command to install the latest nightly build of the CLI (not to be confused with the nightly build of EdgeDB itself):

Copy

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

Usage

Using the CLI is as simple as typing the appropriate command. Explore this section of the documentation for information on what each available command and option does. For a more convenient way to discover the CLI, try adding --help to any CLI command or sub-command for a brief description of its function, sub-commands, and options right in your command line!