The surreal fmt command reformats .surql files to follow a consistent style. It adjusts whitespace, indentation, and keyword casing so that SurrealQL code is easy to read and review.
Usage
Pass one or more .surql files and the formatter will rewrite them in place. Without arguments it reads from standard input and writes to standard output, which makes it easy to integrate with editor "format on save" features or CI pipelines.
When to use the formatter
Before committing — run
surreal fmton any.surqlmigration or seed files to keep diffs clean.In CI — add a formatting check to catch inconsistencies early.
During development — pipe ad-hoc queries through the formatter for readability.
For the full list of command-line options, see the CLI reference.