-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4489a72
commit 6c5ae71
Showing
1 changed file
with
76 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
# Command-Line Help for `sqruff` | ||
|
||
This document contains the help content for the `sqruff` command-line program. | ||
|
||
**Command Overview:** | ||
|
||
* [`sqruff`↴](#sqruff) | ||
* [`sqruff lint`↴](#sqruff-lint) | ||
* [`sqruff fix`↴](#sqruff-fix) | ||
|
||
## `sqruff` | ||
|
||
sqruff is a sql formatter and linter | ||
|
||
**Usage:** `sqruff <COMMAND>` | ||
|
||
###### **Subcommands:** | ||
|
||
* `lint` — lint files | ||
* `fix` — fix files | ||
|
||
|
||
|
||
## `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 | ||
|
||
Possible values: `true`, `false` | ||
|
||
* `-f`, `--format <FORMAT>` | ||
|
||
Default value: `human` | ||
|
||
Possible values: `human`, `github-annotation-native` | ||
|
||
|
||
|
||
|
||
<hr/> | ||
|
||
<small><i> | ||
This document was generated automatically by | ||
<a href="https://crates.io/crates/clap-markdown"><code>clap-markdown</code></a>. | ||
</i></small> | ||
|