Skip to content

Docs

pipeleak docs

Generate CLI documentation

Synopsis

Generate Markdown documentation for all commands in this CLI application and mkdocs.yml. Must be run in an environment where 'mkdocs' is installed.

1
pipeleak docs [flags]

Examples

1
2
# Generate docs and serve them at http://localhost:8000
pipeleak docs --serve

Options

1
2
3
  -g, --github-pages   Build for GitHub Pages
  -h, --help           help for docs
  -s, --serve          Run 'mkdocs build' in the output folder after generating docs

Options inherited from parent commands

1
2
3
      --coloredLog       Output the human-readable log in color (default true)
      --json             Use JSON as log output format
  -l, --logfile string   Log output to a file

SEE ALSO

  • pipeleak - Scan job logs and artifacts for secrets