Skip to content

Commit 63ef92f

Browse files
committed
usage information in the README
1 parent d3039d4 commit 63ef92f

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,20 @@ in the Open Policy Agent documentation.
1313

1414
## Usage
1515

16+
```console
17+
$ conftest --help
18+
Test your configuration files using Open Policy Agent
19+
20+
Usage:
21+
conftest <file> [file...] [flags]
22+
23+
Flags:
24+
--fail-on-warn return a non-zero exit code if only warnings are found
25+
-h, --help help for conftest
26+
-p, --policy string directory for Rego policy files (default "policy")
27+
--version version for conftest
28+
```
29+
1630
```console
1731
$ conftest deployment.yaml
1832
testdata/deployment.yaml

go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ require (
99
github.com/gobwas/glob v0.2.3 // indirect
1010
github.com/hashicorp/go-multierror v1.0.0
1111
github.com/inconshreveable/mousetrap v1.0.0 // indirect
12-
github.com/logrusorgru/aurora v0.0.0-20181002194514-a7b3b318ed4e // indirect
12+
github.com/logrusorgru/aurora v0.0.0-20181002194514-a7b3b318ed4e
1313
github.com/open-policy-agent/opa v0.10.6
1414
github.com/pkg/errors v0.8.1 // indirect
1515
github.com/rcrowley/go-metrics v0.0.0-20181016184325-3113b8401b8a // indirect

0 commit comments

Comments
 (0)