Skip to main content
Version: 1.2.x

Upgrade command

Upgrade command

This command upgrades SurrealDB to the latest version, nightly or a specified version

BEFORE YOU START : Make sure you’ve installed SurrealDB — it should only take a second!

Command options

ArgumentsDescription
--nightlyOPTIONALinstalls the latest nightly version of SurrealDB
--betaOPTIONALinstalls the latest beta version of SurrealDB
--versionOPTIONALinstalls a specific version of SurrealDB
--dry-runOPTIONALDoes not actually replace the currently installed version of SurrealDB.

Example usage

This example shows how you can use the upgrade command to upgrade to the latest version of SurrealDB

surreal upgrade

Global install

If SurrealDB is installed globally on your system, you might need to run the upgrade command with elevated permissions.

sudo surreal upgrade

Install nightly

Use the --nightly flag to upgrade to the latest nightly version of SurrealDB.

surreal upgrade --nightly

Install specific version

Use the --version flag to upgrade to the a specific version of SurrealDB.

surreal upgrade --version v1.0.0-beta.10

Command help

To see the help information and usage instructions, in a terminal run the surreal upgrade --help command without any further arguments. This command gives general information on the arguments, inputs, and additional options for the upgrade command.

surreal upgrade --help
Upgrade to the latest stable version

USAGE:
surreal upgrade [OPTIONS]

ARGS:
[PATTERN] Glob pattern for the files to validate [default: **/* .surql]

OPTIONS:
--nightly Install the latest nightly version

--beta Install the latest beta version

--version <VERSION> Install a specific version

--dry-run Don't actually replace the executable

-h, --help Print help