Install

To install the edgedb CLI, run the appropriate command in your terminal and follow the on-screen prompts.

Linux, macOS
Windows
$
curl --proto '=https' --tlsv1.2 -sSf https://sh.edgedb.com | sh
Copy
  • This command, inspired by rustup, detects your OS and downloads the appropriate build of the EdgeDB's open-source command line tool, edgedb.
  • Once installed, the edgedb CLI can be used to install EdgeDB, spin up instances, create and apply migrations, and more.
  • You can uninstall EdgeDB server or remove the edgedb command at any time.

Linux - Debian/Ubuntu LTS

Step 1. Import the EdgeDB packaging key:

Copy
sudo mkdir -p /usr/local/share/keyrings && \
sudo curl --proto '=https' --tlsv1.2 -sSf \
  -o /usr/local/share/keyrings/edgedb-keyring.gpg \
  https://packages.edgedb.com/keys/edgedb-keyring.gpg

Step 2. Add the EdgeDB package repository:

Copy
echo deb [signed-by=/usr/local/share/keyrings/edgedb-keyring.gpg]\
  https://packages.edgedb.com/apt \
  $(grep "VERSION_CODENAME=" /etc/os-release | cut -d= -f2) main \
  | sudo tee /etc/apt/sources.list.d/edgedb.list

Step 3. Install the EdgeDB package:

Copy
sudo apt-get update && sudo apt-get install edgedb-3

Step 4. Follow the quickstart.

Linux - CentOS/RHEL 7/8/9

Step 1. Add the EdgeDB package repository:

Copy
sudo curl --proto '=https' --tlsv1.2 -sSfL \
  https://packages.edgedb.com/rpm/edgedb-rhel.repo \
  > /etc/yum.repos.d/edgedb.repo

Step 2. Install the EdgeDB package:

Copy
sudo yum install edgedb-3

Step 3. Follow the quickstart.

macOS - Homebrew

Step 1. Add the EdgeDB tap to your Homebrew:

Copy
brew tap edgedb/tap

Step 2. Install EdgeDB CLI:

Copy
brew install edgedb-cli

Step 3. Follow the quickstart.

Windows - Command Prompt

Step 1. Download the CLI

Step 2. Navigate to the download location in the command prompt

Step 3. Run the installation command

Copy
edgedb-cli.exe _self_install