Skip to content

Docs

pipeleek docs

Generate CLI documentation

Synopsis

Generates documentation for all commands. Must be run in an environment where 'mkdocs' is installed.

1
pipeleek docs [flags]

Examples

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

Options

1
2
3
  -g, --github-pages   Build for GitHub Pages
  -h, --help           help for docs
  -s, --serve          Serve documentation after building

Options inherited from parent commands

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
      --color                   Enable colored log output (auto-disabled when using --logfile) (default true)
      --config string           Config file path. Example: ~/.config/pipeleek/pipeleek.yaml
      --http-timeout duration   HTTP request timeout, e.g. 30s or 2m (default: no timeout)
      --ignore-proxy            Ignore HTTP_PROXY environment variable
      --json                    Use JSON as log output format
      --log-level string        Set log level globally (debug, info, warn, error). Example: --log-level=warn
  -l, --logfile string          Log output to a file
      --proxy string            Proxy URL, e.g. http://127.0.0.1:8080 or socks5://127.0.0.1:1080 (takes precedence over HTTP_PROXY)
      --tls-verification        Enable TLS certificate verification (by default verification is skipped to support self-signed certificates)
  -v, --verbose                 Enable debug logging (shortcut for --log-level=debug)

SEE ALSO

  • pipeleek - Scan job logs and artifacts for secrets