SurrealDB Docs Logo

Enter a search query

Help command

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

BEFORE YOU START

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.

surreal help

The output of the above command:

.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' 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 [OPTIONS] <COMMAND> Commands: start Start the database server import Import a SurrealQL script into an existing database export Export an existing database as a SurrealQL script version Output the command-line tool and remote server version information upgrade Upgrade to the latest stable version sql Start an SQL REPL in your terminal with pipe support ml Manage SurrealML models within an existing database is-ready Check if the SurrealDB server is ready to accept connections [aliases: isready] validate Validate SurrealQL query files fix Fix database storage issues help Print this message or the help of the given subcommand(s) Options: --online-version-check Whether to allow web check for client version upgrades at start [env: SURREAL_ONLINE_VERSION_CHECK=] -h, --help Print help -V, --version Print version

On this page

© SurrealDB GitHub Discord Community Cloud Features Releases Install