Back to top
  Back to overview

Help command

The help command displays help information and instructions on the command-line tool and its arguments.

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

Show the command-line help information

To see the general help information for the command-line tool, in a terminal run the surreal help command without any further arguments. This command gives general information on the other functionality which can be run with the command-line tool.

user@localhost % surreal help
 .d8888b.                                             888 8888888b.  888888b.
d88P  Y88b                                            888 888  'Y88b 888  '88b
Y88b.                                                 888 888    888 888  .88P
 'Y888b.   888  888 888d888 888d888  .d88b.   8888b.  888 888    888 8888888K.
	'Y88b. 888  888 888P'   888P'   d8P  Y8b     '88b 888 888    888 888  'Y88b
	  '888 888  888 888     888     88888888 .d888888 888 888    888 888    888
Y88b  d88P Y88b 888 888     888     Y8b.     888  888 888 888  .d88P 888   d88P
 'Y8888P'   'Y88888 888     888      'Y8888  'Y888888 888 8888888P'  8888888P'


SurrealDB command-line interface and server

To get started using SurrealDB, and for guides on connecting to and building applications
on top of SurrealDB, check out the SurrealDB documentation (https://surrealdb.com/docs).

If you have questions or ideas, join the SurrealDB community (https://surrealdb.com/community).

If you find a bug, submit an issue on Github (https://github.com/surrealdb/surrealdb/issues).

We would love it if you could star the repository (https://github.com/surrealdb/surrealdb).

----------

USAGE:
	surreal [SUBCOMMAND]

OPTIONS:
	-h, --help    Print help information

SUBCOMMANDS:
	start      Start the database server
	backup     Backup data to or from an existing database
	import     Import a SQL script into an existing database
	export     Export an existing database into a SQL script
	version    Output the command-line tool version information
	sql        Start an SQL REPL in your terminal with pipe support
	help       Print this message or the help of the given subcommand(s)

Show the start command help information

To see the help information and usage instructions for the start command, in a terminal run the surreal help start command without any further arguments. This command gives general information on the arguments, inputs, and additional options for starting a SurrealDB database server instance.

user@localhost % surreal start --help
Start the database server

USAGE:
    surreal start [OPTIONS] [--] [path]

ARGS:
    <path>    Database path used for storing data [default: memory]

OPTIONS:
        --addr <addr>          The allowed networks for master authentication [default:
                               127.0.0.1/32]
    -b, --bind <bind>          The hostname or ip address to listen for connections on [default:
                               0.0.0.0:8000]
    -h, --help                 Print help information
    -k, --key <key>            Encryption key to use for on-disk encryption
        --kvs-ca <kvs-ca>      Path to the CA file used when connecting to the remote KV store
        --kvs-crt <kvs-crt>    Path to the certificate file used when connecting to the remote KV
                               store
        --kvs-key <kvs-key>    Path to the private key file used when connecting to the remote KV
                               store
    -l, --log <log>            The logging level for the database server [default: info] [possible
                               values: warn, info, debug, trace, full]
    -p, --pass <pass>          The master password for the database
    -s, --strict               Whether strict mode is enabled on this database instance
    -u, --user <user>          The master username for the database [default: root]
        --web-crt <web-crt>    Path to the certificate file for encrypted client connections
        --web-key <web-key>    Path to the private key file for encrypted client connections

Show the import command help information

To see the help information and usage instructions for the import command, in a terminal run the surreal help import command without any further arguments. This command gives general information on the arguments, inputs, and additional options for importing a SurrealQL script file into a local or remote SurrealDB database server instance.

user@localhost % surreal import --help
Import a SurrealQL script into an existing database

USAGE:
    surreal import [OPTIONS] <file>

ARGS:
    <file>    Path to the sql file to import

OPTIONS:
    -c, --conn <conn>    Remote database server url to connect to [default: https://cloud.surrealdb.com]
        --db <db>        The database to import the data into
    -h, --help           Print help information
        --ns <ns>        The namespace to import the data into
    -p, --pass <pass>    Database authentication password to use when connecting [default: root]
    -u, --user <user>    Database authentication username to use when connecting [default: root]

Show the export command help information

To see the help information and usage instructions for the export command, in a terminal run the surreal help export command without any further arguments. This command gives general information on the arguments, inputs, and additional options for export a SurrealQL script file from a local or remote SurrealDB database server instance.

user@localhost % surreal help export
Export an existing database as a SurrealQL script

USAGE:
    surreal export [OPTIONS] <file>

ARGS:
    <file>    Path to the sql file to export

OPTIONS:
    -c, --conn <conn>    Remote database server url to connect to [default: https://cloud.surrealdb.com]
        --db <db>        The database to export the data from
    -h, --help           Print help information
        --ns <ns>        The namespace to export the data from
    -p, --pass <pass>    Database authentication password to use when connecting [default: root]
    -u, --user <user>    Database authentication username to use when connecting [default: root]