Skip to content

Commit a74626f

Browse files
committed
add readme section about CLI options
1 parent 4a228fc commit a74626f

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ Expect more docs soon...
2929
1. [Getting started](getting-started.md)
3030
1. [How does it work?](how-does-it-work.md)
3131
1. [Configuration — codechecks.yml/json/ts/js](configuration.md)
32+
1. CLI options
3233
1. [Checks (plugins) development](developing-checks.md)
3334
1. Developing reusable checks
3435
1. Testing checks

configuration.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,3 +81,8 @@ It's the same as YML config but written in JSON.
8181
If you want to execute arbitrary logic this is the way to go. The only thing you need to do is
8282
export async function from your module. We support es6 named export `main`, default export and
8383
commonjs export.
84+
85+
## CLI
86+
87+
- `--fail-fast` — stops running checks after the first failure, works only in local mode. CLI exits
88+
with non-zero code. This might be useful for executing codechecks in precommit hooks.

0 commit comments

Comments
 (0)