diff --git a/cmd/kosli/createEnvironment.go b/cmd/kosli/createEnvironment.go index f63dbaf77..8bb346180 100644 --- a/cmd/kosli/createEnvironment.go +++ b/cmd/kosli/createEnvironment.go @@ -45,7 +45,7 @@ kosli create environment yourEnvironmentName --api-token yourAPIToken \ --org yourOrgName - +# create a Kosli logical environment: kosli create environment yourLogicalEnvironmentName --type logical \ --included-environments realEnv1,realEnv2,realEnv3 diff --git a/cmd/kosli/detachPolicy.go b/cmd/kosli/detachPolicy.go index 73c7ccd87..c22096ede 100644 --- a/cmd/kosli/detachPolicy.go +++ b/cmd/kosli/detachPolicy.go @@ -19,7 +19,7 @@ const detachPolicyShortDesc = `Detach a policy from one or more Kosli environmen const detachPolicyLongDesc = `If the environment has no more policies attached to it, then its snapshots' status will become "unknown".` const detachPolicyExample = ` -# detach policy from multiple environment: +# detach policy from multiple environments: kosli detach-policy yourPolicyName \ --environment yourFirstEnvironmentName \ --environment yourSecondEnvironmentName \ diff --git a/cmd/kosli/docs.go b/cmd/kosli/docs.go index 697d7c526..52743dcfd 100644 --- a/cmd/kosli/docs.go +++ b/cmd/kosli/docs.go @@ -208,7 +208,7 @@ func KosliGenMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(st // Some titles have a trailing colon, some don't title := strings.Trim(exampleLines[0], ":") if len(title) > 0 { - buf.WriteString(fmt.Sprintf("**%s**\n\n", strings.TrimSpace(title[1:]))) + buf.WriteString(fmt.Sprintf("##### %s\n\n", strings.TrimSpace(title[1:]))) buf.WriteString(fmt.Sprintf("```shell\n%s\n```\n\n", strings.Join(exampleLines[1:], "\n"))) } } diff --git a/cmd/kosli/fingerprint.go b/cmd/kosli/fingerprint.go index 00d55e64e..0eee34637 100644 --- a/cmd/kosli/fingerprint.go +++ b/cmd/kosli/fingerprint.go @@ -49,13 +49,13 @@ kosli fingerprint --artifact-type file file.txt # fingerprint a dir kosli fingerprint --artifact-type dir mydir -# fingerprint a dir while excluding paths ^mydir/logs^ and ^mydir/*exe^ +# fingerprint a dir while excluding paths ` + "`" + `mydir/logs` + "`" + ` and ` + "`" + `mydir/*.exe` + "`" + ` kosli fingerprint --artifact-type dir --exclude logs --exclude *.exe mydir -# fingerprint a dir while excluding all ^.pyc^ files +# fingerprint a dir while excluding all ` + "`" + `.pyc` + "`" + ` files kosli fingerprint --artifact-type dir --exclude **/*.pyc mydir -# fingerprint a dir while excluding paths in .kosli_ignore file +# fingerprint a dir while excluding paths in ` + "`" + `.kosli_ignore` + "`" + ` file echo bar/file.txt > mydir/.kosli_ignore kosli fingerprint --artifact-type dir mydir @@ -66,7 +66,9 @@ kosli fingerprint --artifact-type docker nginx:latest kosli fingerprint --artifact-type oci nginx:latest # fingerprint a private image from a remote registry -kosli fingerprint --artifact-type oci private:latest --registry-username YourUsername --registry-password YourPassword +kosli fingerprint --artifact-type oci private:latest \\ + --registry-username YourUsername \\ + --registry-password YourPassword ` type fingerprintOptions struct { diff --git a/cmd/kosli/testdata/output/docs/snyk.md b/cmd/kosli/testdata/output/docs/snyk.md index 12b8f20b1..7b7a815fe 100644 --- a/cmd/kosli/testdata/output/docs/snyk.md +++ b/cmd/kosli/testdata/output/docs/snyk.md @@ -64,7 +64,7 @@ binding the attestation to the right artifact. These examples all assume that the flags `--api-token`, `--org`, `--host`, (and `--flow`, `--trail` when required), are [set/provided](https://docs.kosli.com/getting_started/install/#assigning-flags-via-environment-variables). -**report a snyk attestation about a pre-built docker artifact (kosli calculates the fingerprint)** +##### report a snyk attestation about a pre-built docker artifact (kosli calculates the fingerprint) ```shell kosli attest snyk yourDockerImageName @@ -74,7 +74,7 @@ kosli attest snyk yourDockerImageName ``` -**report a snyk attestation about a pre-built docker artifact (you provide the fingerprint)** +##### report a snyk attestation about a pre-built docker artifact (you provide the fingerprint) ```shell kosli attest snyk @@ -84,7 +84,7 @@ kosli attest snyk ``` -**report a snyk attestation about a trail** +##### report a snyk attestation about a trail ```shell kosli attest snyk @@ -93,7 +93,7 @@ kosli attest snyk ``` -**report a snyk attestation about an artifact which has not been reported yet in a trail** +##### report a snyk attestation about an artifact which has not been reported yet in a trail ```shell kosli attest snyk @@ -103,7 +103,7 @@ kosli attest snyk ``` -**report a snyk attestation about a trail with an attachment** +##### report a snyk attestation about a trail with an attachment ```shell kosli attest snyk @@ -113,7 +113,7 @@ kosli attest snyk ``` -**report a snyk attestation about a trail without uploading the snyk results file** +##### report a snyk attestation about a trail without uploading the snyk results file ```shell kosli attest snyk