Skip to content
This repository has been archived by the owner on Oct 22, 2021. It is now read-only.

Latest commit

 

History

History
48 lines (37 loc) · 2.51 KB

fissile_docs_markdown.md

File metadata and controls

48 lines (37 loc) · 2.51 KB
Raw

fissile docs markdown

Generates markdown documentation for fissile.

Synopsis

Generates markdown documentation for fissile.

fissile docs markdown [flags]

Options

  -h, --help                   help for markdown
  -O, --md-output-dir string   Specifies a location where markdown documentation will be generated. (default "./docs")

Options inherited from parent commands

  -c, --cache-dir string             Local BOSH cache directory. (default "~/.bosh/cache")
      --config string                config file (default is $HOME/.fissile.yaml)
  -d, --dark-opinions string         Path to a BOSH deployment manifest file that contains properties that should not have opinionated defaults.
      --docker-organization string   Docker organization used when referencing image names
      --docker-password string       Password for authenticated docker registry
      --docker-registry string       Docker registry used when referencing image names
      --docker-username string       Username for authenticated docker registry
      --final-releases-dir string    Local final releases directory. (default "~/.final-releases")
  -l, --light-opinions string        Path to a BOSH deployment manifest file that contains properties to be used as defaults.
  -M, --metrics string               Path to a CSV file to store timing metrics into.
  -o, --output string                Choose output format, one of human, json, or yaml (currently only for 'show properties') (default "human")
  -r, --release string               Path to final or dev BOSH release(s).
  -n, --release-name string          Name of a dev BOSH release; if empty, default configured dev release name will be used; Final release always use the name in release.MF
  -v, --release-version string       Version of a dev BOSH release; if empty, the latest dev release will be used; Final release always use the version in release.MF
  -p, --repository string            Repository name prefix used to create image names.
  -m, --role-manifest string         Path to a yaml file that details which jobs are used for each instance group.
  -V, --verbose                      Enable verbose output.
  -w, --work-dir string              Path to the location of the work directory. (default "/var/fissile")
  -W, --workers int                  Number of workers to use; zero means determine based on CPU count.

SEE ALSO

  • fissile docs - Has subcommands to create documentation for fissile.
Auto generated by spf13/cobra on 8-Oct-2019