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 can be used to manage and run SurrealDB database
instances without the need to install any command-line
tools. The SurrealDB docker container contains the full command-line tools for importing and
exporting data from a running server, or for running a server
itself. View the documentation for more information.
docker run --rm --pull always -p 8000:8000 surrealdb/surrealdb:latest start