Version command

The version command outputs the current version of the installed command-line tool, and the machine architecture.

BEFORE YOU START

Make sure you’ve installed SurrealDB — it should only take a second!

Command options

Example usage

To display the current command-line tool version, along with the platform and architecture, in a terminal run the surreal version command without any further arguments.

surreal version

Sample output:

2.2.1 for macos on aarch64

If an endpoint is specified, only the version number will be displayed.

surreal version --endpoint http://localhost:8000

Output:

2.2.1

Check version with CLI flags

Available since: v1.2.0

surreal -V

surreal --version

Sample output:

SurrealDB command-line interface and server 2.2.1 for macos on aarch64

Command help

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

surreal version --help

The output of the above command:

Output the command-line tool and remote server version information

Usage: surreal version [OPTIONS]

Options:
  -e, --endpoint <ENDPOINT>  Remote database server url to connect to [aliases: conn]
  -l, --log <LOG>            The logging level for the command-line tool [env: SURREAL_LOG=] [default: info] [possible values: none, full, error, warn, info, debug, trace]
  -h, --help                 Print help