Skip to content

Commit 6302377

Browse files
authored
chore: add exit code section (#898)
* chore: add exit code section * chore: apply rabbit review
1 parent b44e6c6 commit 6302377

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

website/reference/cli/run.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,4 +199,10 @@ This is equivalent to providing both the -B/--before and -A/--after flags with t
199199
[default: 0]
200200

201201
### `-h, --help`
202-
Print help (see a summary with '-h')
202+
Print help (see a summary with '-h')
203+
204+
## Exit codes
205+
206+
The program exits with status code:
207+
- **0**: at least one line matches
208+
- **1**: no matches found

website/reference/cli/scan.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -211,4 +211,10 @@ Turn off rule
211211
This flag turns off the specified RULE_ID. You can disable multiple rules by using the flag multiple times. If no RULE_ID is provided, all rules will be turned off. Note, this flag must use `=` to specify its value.
212212

213213
### `-h, --help`
214-
Print help (see a summary with '-h')
214+
Print help (see a summary with '-h')
215+
216+
## Exit codes
217+
218+
The program exits with status code:
219+
- **1**: if at least one rule matches
220+
- **0**: if no rules match

0 commit comments

Comments
 (0)