You are viewing documentation of Keptn that is currently under development and subject to change.

keptn generate docs

keptn generate docs

Generates Markdown documentation for the keptn CLI.

Synopsis

Generates Markdown documentation for the keptn CLI.

This command can be used to create an up-to-date documentation of Keptn’s command-line interface for https://keptn.sh.

It creates one Markdown file per command, suitable for rendering in Hugo.

keptn generate docs [flags]

Examples

keptn generate docs
keptn generate docs --dir=/some/directory

Options

      --dir string   directory where the docs should be written to (default "./docs")
  -h, --help         help for docs

Options inherited from parent commands

      --mock                 mocking of server communication - ATTENTION: your commands will not be sent to the keptn server
  -q, --quiet                suppress debug and info output
      --suppress-websocket   disables websocket communication - use the ID of Keptn context (if provided) for checking the result of your command
  -v, --verbose              verbose logging

SEE ALSO

Auto generated by spf13/cobra on 29-Apr-2020