Command-line tool
The SurrealDB command-line tool can be used to export a dataset as SurrealQL from a local or remote SurrealDB database, import SurrealQL data into a local or remote database, and start a single SurrealDB instance or distributed cluster.
Start command
Start a SurrealDB server in memory, on disk, or in a distributed setup
Import command
Import a SurrealQL script file into a local or remote SurrealDB database server
Export command
Export a SurrealQL script file from a local or remote SurrealDB database server
Backup command
Backup data to or from an exisiting database
Version command
Display the current version of the installed command-line tool, and the machine architecture
Isready command
Confirm whether a SurrealDB server can receive connections, and accept queries
SQL command
Start a SurrealQL REPL for running SQL queries on a local or remote SurrealDB server
Upgrade command
Upgrade SurrealDB to the latest version, nightly or a specified version
Help command
Display help information and instructions on the command-line tool and its arguments