Skip to content

Commit 3b909e0

Browse files
zregvartzregvart
authored
Merge pull request #2103 from zregvart/issue/EC-940 
2 parents c65f0b5 + e874aa7 commit 3b909e0

34 files changed

+87
-30
lines changed

‎docs/modules/ROOT/pages/ec.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
= ec
22

3-
Enterprise Contract CLI== Synopsis
3+
Enterprise Contract CLI
4+
5+
== Synopsis
46

57
Enterprise Contract CLI
68

‎docs/modules/ROOT/pages/ec_fetch.adoc

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
= ec fetch
22

33
Fetch remote resources
4+
45
== Options
56

67
-h, --help:: help for fetch (Default: false)

‎docs/modules/ROOT/pages/ec_fetch_policy.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
= ec fetch policy
22

3-
Fetch policy rules from a git repository or other source== Synopsis
3+
Fetch policy rules from a git repository or other source
4+
5+
== Synopsis
46

57
Fetch policy rules (rego files) from a git repository or other source.
68

‎docs/modules/ROOT/pages/ec_init.adoc

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
= ec init
22

33
Initialize a directory for use
4+
45
== Options
56

67
-h, --help:: help for init (Default: false)

‎docs/modules/ROOT/pages/ec_init_policies.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
= ec init policies
22

3-
Initialize a directory with minimal EC scaffolding== Synopsis
3+
Initialize a directory with minimal EC scaffolding
4+
5+
== Synopsis
46

57
This command creates the necessary files for a minimal EC policy setup in the
68
specified destination directory.

‎docs/modules/ROOT/pages/ec_inspect.adoc

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
= ec inspect
22

33
Inspect policy rules
4+
45
== Options
56

67
-h, --help:: help for inspect (Default: false)

‎docs/modules/ROOT/pages/ec_inspect_policy-data.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
= ec inspect policy-data
22

3-
Read policy data from source urls and displays the data== Synopsis
3+
Read policy data from source urls and displays the data
4+
5+
== Synopsis
46

57
Read policy data from source urls and displays the data.
68

‎docs/modules/ROOT/pages/ec_inspect_policy.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
= ec inspect policy
22

3-
Read policies from source urls and show information about the rules inside them== Synopsis
3+
Read policies from source urls and show information about the rules inside them
4+
5+
== Synopsis
46

57
Read policies from a source url and show information about the rules inside them.
68

‎docs/modules/ROOT/pages/ec_opa.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
= ec opa
22

3-
Open Policy Agent (OPA) (embedded)== Synopsis
3+
Open Policy Agent (OPA) (embedded)
4+
5+
== Synopsis
46

57
An open source project to policy-enable your service.
68
[source,shell]

‎docs/modules/ROOT/pages/ec_opa_bench.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
= ec opa bench
22

3-
Benchmark a Rego query== Synopsis
3+
Benchmark a Rego query
4+
5+
== Synopsis
46

57
Benchmark a Rego query and print the results.
68

‎docs/modules/ROOT/pages/ec_opa_build.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
= ec opa build
22

3-
Build an OPA bundle== Synopsis
3+
Build an OPA bundle
4+
5+
== Synopsis
46

57
Build an OPA bundle.
68

‎docs/modules/ROOT/pages/ec_opa_capabilities.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
= ec opa capabilities
22

3-
Print the capabilities of OPA== Synopsis
3+
Print the capabilities of OPA
4+
5+
== Synopsis
46

57
Show capabilities for OPA.
68

‎docs/modules/ROOT/pages/ec_opa_check.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
= ec opa check
22

3-
Check Rego source files== Synopsis
3+
Check Rego source files
4+
5+
== Synopsis
46

57
Check Rego source files for parse and compilation errors.
68

‎docs/modules/ROOT/pages/ec_opa_deps.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
= ec opa deps
22

3-
Analyze Rego query dependencies== Synopsis
3+
Analyze Rego query dependencies
4+
5+
== Synopsis
46

57
Print dependencies of provided query.
68

‎docs/modules/ROOT/pages/ec_opa_eval.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
= ec opa eval
22

3-
Evaluate a Rego query== Synopsis
3+
Evaluate a Rego query
4+
5+
== Synopsis
46

57
Evaluate a Rego query and print the result.
68

‎docs/modules/ROOT/pages/ec_opa_exec.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
= ec opa exec
22

3-
Execute against input files== Synopsis
3+
Execute against input files
4+
5+
== Synopsis
46

57
Execute against input files.
68

‎docs/modules/ROOT/pages/ec_opa_fmt.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
= ec opa fmt
22

3-
Format Rego source files== Synopsis
3+
Format Rego source files
4+
5+
== Synopsis
46

57
Format Rego source files.
68

‎docs/modules/ROOT/pages/ec_opa_inspect.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
= ec opa inspect
22

3-
Inspect OPA bundle(s) or Rego files.== Synopsis
3+
Inspect OPA bundle(s) or Rego files.
4+
5+
== Synopsis
46

57
Inspect OPA bundle(s) or Rego files.
68

‎docs/modules/ROOT/pages/ec_opa_parse.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
= ec opa parse
22

3-
Parse Rego source file== Synopsis
3+
Parse Rego source file
4+
5+
== Synopsis
46

57
Parse Rego source file and print AST.
68
[source,shell]

‎docs/modules/ROOT/pages/ec_opa_run.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
= ec opa run
22

3-
Start OPA in interactive or server mode== Synopsis
3+
Start OPA in interactive or server mode
4+
5+
== Synopsis
46

57
Start an instance of the Open Policy Agent (OPA).
68

‎docs/modules/ROOT/pages/ec_opa_sign.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
= ec opa sign
22

3-
Generate an OPA bundle signature== Synopsis
3+
Generate an OPA bundle signature
4+
5+
== Synopsis
46

57
Generate an OPA bundle signature.
68

‎docs/modules/ROOT/pages/ec_opa_test.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
= ec opa test
22

3-
Execute Rego test cases== Synopsis
3+
Execute Rego test cases
4+
5+
== Synopsis
46

57
Execute Rego test cases.
68

‎docs/modules/ROOT/pages/ec_opa_version.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
= ec opa version
22

3-
Print the version of OPA== Synopsis
3+
Print the version of OPA
4+
5+
== Synopsis
46

57
Show version and build information for OPA.
68
[source,shell]

‎docs/modules/ROOT/pages/ec_sigstore.adoc

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
= ec sigstore
22

33
Perform certain sigstore operations
4+
45
== Options
56

67
-h, --help:: help for sigstore (Default: false)

‎docs/modules/ROOT/pages/ec_sigstore_initialize.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
= ec sigstore initialize
22

3-
Initializes Sigstore root to retrieve trusted certificate and key targets for verification== Synopsis
3+
Initializes Sigstore root to retrieve trusted certificate and key targets for verification
4+
5+
== Synopsis
46

57
Initializes Sigstore root to retrieve trusted certificate and key targets for verification.
68

‎docs/modules/ROOT/pages/ec_test.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
= ec test
22

3-
Test your configuration files using Open Policy Agent== Synopsis
3+
Test your configuration files using Open Policy Agent
4+
5+
== Synopsis
46

57

68
The 'ec test' command is a thin wrapper for the 'conftest test' command. This

‎docs/modules/ROOT/pages/ec_track.adoc

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
= ec track
22

33
Record resource references for tracking purposes
4+
45
== Options
56

67
-h, --help:: help for track (Default: false)

‎docs/modules/ROOT/pages/ec_track_bundle.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
= ec track bundle
22

3-
Record tracking information about Tekton bundles== Synopsis
3+
Record tracking information about Tekton bundles
4+
5+
== Synopsis
46

57
Record tracking information about Tekton bundles
68

‎docs/modules/ROOT/pages/ec_validate.adoc

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
= ec validate
22

33
Validate conformance with the Enterprise Contract
4+
45
== Options
56

67
-h, --help:: help for validate (Default: false)

‎docs/modules/ROOT/pages/ec_validate_image.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
= ec validate image
22

3-
Validate conformance of container images with the Enterprise Contract== Synopsis
3+
Validate conformance of container images with the Enterprise Contract
4+
5+
== Synopsis
46

57
Validate conformance of container images with the Enterprise Contract
68

‎docs/modules/ROOT/pages/ec_validate_input.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
= ec validate input
22

3-
Validate arbitrary JSON or yaml file input conformance with the Enterprise Contract== Synopsis
3+
Validate arbitrary JSON or yaml file input conformance with the Enterprise Contract
4+
5+
== Synopsis
46

57
Validate conformance of arbitrary JSON or yaml file input with the Enterprise Contract
68

‎docs/modules/ROOT/pages/ec_validate_policy.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
= ec validate policy
22

3-
Validate the provided EnterpriseContractPolicy spec== Synopsis
3+
Validate the provided EnterpriseContractPolicy spec
4+
5+
== Synopsis
46

57
Validate the provided EnterpriseContractPolicy spec against the EnterpriseContractPolicy spec schema used in this version of the ec CLI
68

‎docs/modules/ROOT/pages/ec_version.adoc

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
= ec version
22

33
Print version information
4+
45
== Options
56

67
-h, --help:: help for version (Default: false)

‎internal/documentation/asciidoc/cli/cli.tmpl

+2-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
= {{ .CommandPath }}
22

3-
{{ .Short -}}
4-
5-
{{ if .Long -}}
6-
3+
{{ .Short }}
4+
{{ if .Long }}
75
== Synopsis
86

97
{{ .Long }}

0 commit comments

Comments
 (0)