helm-docs automatically generates markdown documentation for helm charts from requirements and values files Usage: helm-docs [flags] Flags: -b, --badge-style string badge style to use for charts (default "flat-square") -c, --chart-search-root string directory to search recursively within for charts (default ".") -g, --chart-to-generate strings List of charts that will have documentation generated. Comma separated, no space. Empty list - generate for all charts in chart-search-root -u, --document-dependency-values For charts with dependencies, include the dependency values in the chart values documentation -y, --documentation-strict-ignore-absent strings A comma separate values which are allowed not to be documented in strict mode (default [service.type,image.repository,image.tag]) -z, --documentation-strict-ignore-absent-regex strings A comma separate values which are allowed not to be documented in strict mode (default [.*service\.type,.*image\.repository,.*image\.tag]) -x, --documentation-strict-mode Fail the generation of docs if there are undocumented values -d, --dry-run don't actually render any markdown files just print to stdout passed -h, --help help for helm-docs -i, --ignore-file string The filename to use as an ignore file to exclude chart directories (default ".helmdocsignore") --ignore-non-descriptions ignore values without a comment, this values will not be included in the README -l, --log-level string Level of logs that should printed, one of (panic, fatal, error, warning, info, debug, trace) (default "info") -o, --output-file string markdown file path relative to each chart directory to which rendered documentation will be written (default "README.md") --skip-version-footer if true the helm-docs version footer will not be shown in the default README template -s, --sort-values-order string order in which to sort the values table ("alphanum" or "file") (default "alphanum") -t, --template-files strings gotemplate file paths relative to each chart directory from which documentation will be generated (default [README.md.gotmpl]) -f, --values-file string Path to values file (default "values.yaml")