Command-Line Help for `sqruff`

This document contains the help content for the sqruff command-line program.

Command Overview:

sqruff↴
sqruff lint↴
sqruff fix↴
sqruff lsp↴

`sqruff`

sqruff is a sql formatter and linter

Usage: sqruff [OPTIONS] <COMMAND>

Subcommands:

lint — lint files
fix — fix files
lsp — Run an LSP server

Options:

--config <CONFIG> — Path to a configuration file

`sqruff lint`

lint files

Usage: sqruff lint [OPTIONS] [PATHS]...

Arguments:

<PATHS>

Options:

-f, --format <FORMAT>

Default value: human

Possible values: human, github-annotation-native

`sqruff fix`

fix files

Usage: sqruff fix [OPTIONS] [PATHS]...

Arguments:

<PATHS>

Options:

--force — Skip the confirmation prompt and go straight to applying fixes
-f, --format <FORMAT>

Default value: human

Possible values: human, github-annotation-native

`sqruff lsp`

Run an LSP server

Usage: sqruff lsp

This document was generated automatically by clap-markdown.