Skip to main content

CLI 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.

Getting Started‚Äč

To start using the SurrealDB CLI, you can install it globally using npm or yarn. Once installed, you can run the CLI commands from your terminal or command prompt. The CLI documentation provides detailed information on each command, including usage examples and options.

We hope that the SurrealDB CLI simplifies your interactions with SurrealDB and empowers you to efficiently manage your databases and clusters. Let's dive into the CLI section and explore its capabilities!