Skip to content

Commit 25aed58

Browse files
committed
chore: update cli.md documentation
1 parent 849796d commit 25aed58

File tree

1 file changed

+30
-19
lines changed

1 file changed

+30
-19
lines changed

docs/docs/cli.md

Lines changed: 30 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -130,49 +130,60 @@ USAGE:
130130
squawk [FLAGS] [OPTIONS] [path]... [SUBCOMMAND]
131131
132132
FLAGS:
133-
--assume-in-transaction
133+
--assume-in-transaction
134134
Assume that a transaction will wrap each SQL file when run by a migration tool
135-
135+
136136
Use --no-assume-in-transaction to override any config file that sets this
137-
-h, --help
137+
-h, --help
138138
Prints help information
139139
140-
-V, --version
140+
--no-error-on-unmatched-pattern
141+
Do not exit with an error when provided path patterns do not match any files
142+
143+
-V, --version
141144
Prints version information
142145
143-
--verbose
146+
--verbose
144147
Enable debug logging output
145148
146149
147150
OPTIONS:
148-
-c, --config <config-path>
151+
-c, --config <config-path>
149152
Path to the squawk config file (.squawk.toml)
150153
151-
--debug <format>
152-
Output debug format [possible values: Lex, Parsed]
153-
154-
-e, --exclude <rule>...
154+
--debug <format>
155+
Output debug format [possible values: Lex, Parse, Ast]
156+
157+
--exclude-path <excluded-path>...
158+
Paths to exclude
159+
160+
For example:
161+
162+
`--exclude-path=005_user_ids.sql --exclude-path=009_account_emails.sql`
163+
164+
`--exclude-path='*user_ids.sql'`
165+
-e, --exclude <rule>...
155166
Exclude specific warnings
156-
167+
157168
For example: --exclude=require-concurrent-index-creation,ban-drop-database
158-
159-
--pg-version <pg-version>
169+
--pg-version <pg-version>
160170
Specify postgres version
161-
171+
162172
For example: --pg-version=13.0
163-
--reporter <reporter>
164-
Style of error reporting [possible values: Tty, Gcc, Json]
173+
--reporter <reporter>
174+
Style of error reporting [possible values: Tty, Gcc, Json, Gitlab]
165175
166-
--stdin-filepath <filepath>
176+
--stdin-filepath <filepath>
167177
Path to use in reporting for stdin
168178
169179
170180
ARGS:
171-
<path>...
172-
Paths to search
181+
<path>...
182+
Paths or patterns to search
173183
174184
175185
SUBCOMMANDS:
176186
help Prints this message or the help of the given subcommand(s)
187+
server Run the language server
177188
upload-to-github Comment on a PR with Squawk's results
178189
```

0 commit comments

Comments
 (0)