Skip to content

Commit aee5173

Browse files
Add line in docs for usage of --format (#171)
Co-authored-by: Gaurav Nelson <[email protected]>
1 parent d9ff5bb commit aee5173

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/using-kubelinter.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,12 @@ kube-linter lint /path/to/directory/containing/Chart.yaml-file/
2727

2828
<!-- tabs:end -->
2929

30+
31+
> [!NOTE] To get structured output, use the `--format` option.
32+
> For example,
33+
> - Use `--format=json` to get the output in JSON format.
34+
> - Use `--format=sarif` to get the output in the [SARIF spec](https://github.com/microsoft/sarif-tutorials).
35+
3036
## Using KubeLinter with the pre-commit framework
3137

3238
If you are using the [pre-commit framework](https://pre-commit.com/) for

0 commit comments

Comments
 (0)