How to install

The latest version of SurrealDB is

v3.1.4

There are several ways to run SurrealDB. The easiest is SurrealDB Cloud, but you can also install the single surreal binary locally or run it inside Docker. Once installed, the surreal command can back up, interact with, and run SurrealDB server instances.

Installation guide View features

01 |INSTALL THE CLI

Choose your platform

Pick your operating system below - we've pre-selected the one you're on. Each command installs the surreal CLI and server as a single executable.

Install on macOS

The quickest way to get going on macOS is Homebrew, which installs the command-line tools and the SurrealDB server as a single executable. Without Homebrew, follow the Linux instructions instead.

Homebrew

brew install surrealdb/tap/surreal

Install on Linux

The preferred way to get going on Unix systems is the SurrealDB install script. Run the following in your terminal and follow the on-screen instructions.

Install script

curl -sSf https://install.surrealdb.com | sh

Install on Windows

On Windows, install the SurrealDB command-line tool with PowerShell, or use the Chocolatey or Scoop package managers from an administrative shell for easy installation and upgrades.

PowerShell

iwr https://windows.surrealdb.com -useb | iex

Chocolatey

choco install surreal

Scoop

scoop install surrealdb

Install on Docker

Docker lets you run SurrealDB without installing any CLI tools locally. The container includes the full CLI for import/export and for running a server.

Docker

docker run --rm --pull always -p 8000:8000 surrealdb/surrealdb:latest start

02 |VERIFY & RUN

Confirm the install, then start

Check the CLI is on your path, then start a local in-memory server to begin experimenting.

Check the version

surreal version

Start a local server

surreal start --user root --pass root memory

GET STARTED

Start building with SurrealDB

Get started with SurrealDB in minutes. Explore the documentation, try it in the cloud, or dive straight into building.

SOC 2 Type 2

GDPR

Cyber Essentials Plus

ISO 27001

Start building View documentation