konstraint_doc.md

konstraint doc

Generate documentation from Rego policies

konstraint doc <dir> [flags]

Examples

Generate the documentation
	konstraint doc

Save the documentation to a specific directory
	konstraint doc --output docs/policies.md
	
Set the URL where the policies are hosted at
	konstraint doc --url https://github.com/plexsystems/konstraint

Options

  -h, --help               help for doc
      --include-comments   Include comments from the rego source in the documentation
      --no-rego            Do not include the Rego in the policy documentation
  -o, --output string      Output location (including filename) for the policy documentation (default "policies.md")
      --url string         The URL where the policy files are hosted at (e.g. https://github.com/policies)

SEE ALSO

• konstraint - Konstraint