Isready command

The isready command attempts to connect to a remote SurrealDB server to detect if it has successfully started and is ready to accept connections.

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 isready --conn http://localhost:8000

Command help

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

surreal isready --help

The output of the above command:

Check if the SurrealDB server is ready to accept connections

Usage: surreal is-ready [OPTIONS]

Options:
  -e, --endpoint <ENDPOINT>  Remote database server url to connect to [default: ws://localhost:8000] [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