Keptn v1 reached EOL December 22, 2023. For more information see https://bit.ly/keptn

Home / Keptn v1 Docs / Release 1.y.z / Reference / Keptn CLI / Commands / keptn generate cloud-events-spec

keptn generate cloud-events-spec

keptn generate cloud-events-spec

Generates the markdown documentation for the Keptn CloudEvents

Synopsis

Generates markdown documentation for the Keptn CloudEvents.

This command can be used to create an up-to-date documentation of the Keptn CloudEvents documentation at https://github.com/keptn/spec/blob/master/cloudevents.md

It creates one markdown file containing a description of the CloudEvents as well as examples and json schema definitions.

keptn generate cloud-events-spec [flags]

Examples

keptn generate cloud-events-spec

keptn generate cloud-events-spec --dir=/some/directory

Options

      --dir string   directory where the cloud events spec should be written to (default "./ce-docs")

Options inherited from parent commands

      --config-file string   Specify custom Keptn Config file path (default: ~/.keptn/config)
  -h, --help                 help
      --mock                 Disables communication to a Keptn endpoint
  -n, --namespace string     Specify the namespace where Keptn should be installed, used and uninstalled (default "keptn")
  -q, --quiet                Suppresses debug and info messages
  -v, --verbose              Enables verbose logging to print debug messages
  -y, --yes                  Assume yes for all user prompts

SEE ALSO

keptn generate - Generates the markdown CLI documentation or a support archive

Auto generated by spf13/cobra on 11-Jul-2022

keptn generate docs

Keptn is a CNCF Incubating Project. Initially created by Dynatrace in 2019.

© 2023 The Keptn Authors | Documentation Distributed under CC-BY-4.0
© 2023 The Linux Foundation. All rights reserved. The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our Trademark Usage page.

This website is powered by Netlify