How to install

The latest version of SurrealDB is

v3.1.2

There are a number of ways to run SurrealDB. While the easiest way to get started is through SurrealDB Cloud, it can also be installed from a binary image, or it can be run from within Docker. Once installed, the surreal command is a single executable which can be used to back up, interact with, and run SurrealDB server instances.

Install on macOS

The quickest way to get going with SurrealDB on macOS is to use Homebrew. This will install both the command-line tools and the SurrealDB server as a single executable. If you don't use Homebrew, follow the instructions for Linux below to install SurrealDB. View the documentation for more information.

brew install surrealdb/tap/surreal

Install on Linux

The easiest and preferred way to get going with SurrealDB on Unix operating systems is to install and use the SurrealDB command-line tool. Run the following command in your terminal and follow the on-screen instructions. View the documentation for more information.

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

Install on Windows

The easiest and preferred way to get going with SurrealDB on Windows is to install and use the SurrealDB command-line tool. Run the following command in your terminal and follow the on-screen instructions. View the documentation for more information.

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

Alternatively, SurrealDB is available for installation on Windows via the Chocolatey package manager, from an administrative shell - enabling easy installation and upgrading.

choco install surreal

Alternatively, SurrealDB is available for installation on Windows via the Scoop package manager, from an administrative shell - enabling easy installation and upgrading.

scoop install surrealdb

Install on Docker

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

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

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