Back to top
Documentation Command-line tool Validate command

Validate command

This command validates a SurrealQL query files.

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

Command options

Argument Description
[PATTERN] Required Glob pattern for the files to validate [default: **/* .surql]

Example usage

To perform validation on a SurrealQL local file, in a terminal run the surreal validate command with the required argument.

user@localhost % surreal validate [PATTERN]

Command help

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

user@localhost % surreal validate --help
Validating SurrealQL query files

USAGE:
    surreal validate [PATTERN]

ARGS:
  [PATTERN] Glob pattern for the files to validate [default: **/* .surql]

OPTIONS:
    -h, --help           Print help information