Installation

Weitere Installationsbefehle

macOS

Homebrewverifiziert · 100%

brew install helm-docs

local Homebrew formula metadata

Linux

Nixverifiziert · 92%

nix profile install nixpkgs#helm-docs

nixpkgs package indexes · pkgs/by-name/he/helm-docs/package.nix · Quelle: api.github.com

openSUSE zypperverifiziert · 92%

sudo zypper install helm-docs

openSUSE Tumbleweed package metadata · helm-docs · Quelle: download.opensuse.org

Windows

Scoopverifiziert · 92%

scoop install main/helm-docs

Scoop official bucket manifest trees · bucket/helm-docs.json · Quelle: api.github.com

Überblick

Paketzusammenfassung

Tool for automatically generating markdown documentation for helm charts

Projektlinks

Befehle und Aliase

helm-docs

Verlauf

Projektgeschichte und Nutzung

helm-docs is a Go command-line tool that auto-generates Markdown documentation from Helm charts. Its README describes generated files that include chart metadata and tables of values, defaults, and descriptions parsed from comments.

The project sits in the practical layer around Helm: once charts became a common packaging format for Kubernetes applications, teams needed generated, reviewable README files that stayed synchronized with `Chart.yaml`, `values.yaml`, and template conventions.

Projektgeschichte

The public repository was created in September 2018, during the period when Helm charts were becoming a standard way to distribute Kubernetes applications. GitHub release metadata shows a v0.1.0 release in July 2019.

The tool evolved around Go templates and chart parsing. Its default workflow searches recursively for `Chart.yaml`, reads values files and chart metadata, and renders Markdown through either a default internal template or user-supplied `README.md.gotmpl` files.

Adoptionsgeschichte

helm-docs became part of chart-authoring workflows because it is easy to run locally, in containers, and as a pre-commit hook. The README includes pre-commit hook configurations and direct binary usage for regenerating READMEs.

The README documents Homebrew, Scoop, mise, source builds, and container usage, while the supplied package metadata also lists Homebrew, Nix, Scoop, and openSUSE packaging.

Wie es verwendet wird

A chart maintainer runs `helm-docs` in a repository, optionally with `--chart-search-root`, `--template-files`, or `--dry-run`. The tool finds charts, parses metadata and values, and writes generated Markdown back into chart README files.

Comment conventions in `values.yaml` let maintainers document fields next to the defaults they control. That makes the generated table useful for reviewers and users who need to understand chart configuration without reading every template.

Warum Paket-Nerds sich dafür interessieren

helm-docs is package-nerd glue: it turns Helm charts from installable bundles into better documented packages. In chart repositories with many values, generated documentation prevents README drift and makes package review less painful.

It is also a good example of a packaging-adjacent CLI that belongs in package managers because teams run it in hooks, CI, release pipelines, and local chart authoring environments.

Zeitleiste

2018: Public GitHub repository created.
2019: v0.1.0 release published.
2019: Early 0.x releases iterate on generated chart documentation.
2020s: README documents Homebrew, Scoop, mise, source, container, and pre-commit workflows.

Related projects

Helm is the chart format and command-line ecosystem that helm-docs documents.
Go templates drive the Markdown rendering model.
pre-commit is a common workflow integration documented by the project.
Chart.yaml, values.yaml, and README.md.gotmpl are the main chart files touched by the tool.

Quellen

Sicherheitslage

Risikostufe: grün

narrow executable package without higher-risk signals.

Risikoklassifikator

grün Risiko · niedrig Konfidenz · appliance

Warum

narrow executable package without higher-risk signals

Signale

metadata:no-higher-risk-signals

Installationsverhalten

In den Formelmetadaten ist kein Homebrew-Post-install-Hook erfasst.
Homebrew-Bottle-Metadaten sind für 10 Plattformziele verfügbar.
Build-Metadaten listen 1 Build-Abhängigkeiten.

Empfohlene Prüfung

Prüfe vor unbeaufsichtigter Agent-Nutzung, ob das Tool Klartext-Credentials liest, Remote-Zustand schreibt, Artefakte veröffentlicht oder Plugins ausführt.

Executables

Installierte Executables

Befehl	Art	Sichtbarkeit	Hinweis
`helm-docs`	cli	globales Executable

Aktualität

Version und Aktualität

Diese Signale trennen das Alter der Seitengenerierung, Aktivität des Paketmanagers und Upstream-Release-Vergleich. Versionsrückstand wird nur gemeldet, wenn eine Evidenz-URL und vergleichbare Versionen vorhanden sind.

Seite generiert2026-07-25

Manager-Version1.14.2

Manager aktualisiert

lokale DatenOK

Upstreamaktuell

neueste erkannte Versionv1.14.2

https://github.com/norwoodj/helm-docs

InfoNo package-manager update timestamp was available.niedrig Konfidenz

Installationsmetadaten

Paketmetadaten

Paketschlüssel	brew:helm-docs
Version	1.14.2
Paketmanager	Homebrew
Paketmanager-Seite	https://formulae.brew.sh/formula/helm-docs
Homepage	https://github.com/norwoodj/helm-docs
Repository	https://github.com/norwoodj/helm-docs
Upstream-Dokumentation	https://github.com/norwoodj/helm-docs#readme
Lizenz	GPL-3.0-or-later
Quellarchiv	https://github.com/norwoodj/helm-docs/archive/refs/tags/v1.14.2.tar.gz
Build-Abhängigkeiten	go
Bottle	verfügbar (auf arm64_linux, arm64_monterey, arm64_sequoia, arm64_sonoma, arm64_tahoe, arm64_ventura, monterey, sonoma, ventura, x86_64_linux)
Homebrew post-install	nicht definiert
Dienst	keiner deklariert

Registry-Fakten

Details aus der Quelldatenbank

Source Database	Homebrew formula API
Tap	homebrew/core
Full Name	helm-docs
Version Scheme	0
Revision	0
Head Version	HEAD
Bottle Stable Root URL	https://ghcr.io/v2/homebrew/core
Deprecated	no
Disabled	no
Keg Only	no
URL Keys	head stable

Source-Datenbank-Treffer

Andere Paketmanager-Einträge

Treffer stammen aus externen Paketmanager-Indizes und bleiben von lokalen Automic-Vault-Paketlinks getrennt.

Nix95%

helm-docs

nix profile install nixpkgs#helm-docs

normalized package name match
Abgeglichen nach: Helm Docs

nixpkgs package indexes · api.github.com · nixpkgs package indexes: pkgs/by-name/he/helm-docs/package.nix from https://api.github.com/repos/NixOS/nixpkgs/git/trees/master?recursive=1

zypper95%

helm-docs 1.14.2-1.6

A tool for automatically generating markdown documentation for helm charts

https://github.com/norwoodj/helm-docs

sudo zypper install helm-docs

License: GPL-3.0-only
Category: Unspecified
Architecture: x86_64
Source Package: helm-docs
1 Abhängigkeiten
1 stellt bereit
normalized package name match
Abgeglichen nach: Helm Docs

openSUSE Tumbleweed package metadata · download.opensuse.org · openSUSE Tumbleweed package metadata: helm-docs from https://download.opensuse.org/tumbleweed/repo/oss/repodata/be8d3611d25469107f32075a1697e69ec57a2b850b42348a658cc671ad5ec2b50760d02c3e59524d50da9a11d5be799bdaffba2e166e8ca8858512e3c0bd665d-primary.xml.zst

Scoop95%

main/helm-docs

scoop install main/helm-docs

normalized package name match
Abgeglichen nach: Helm Docs

Scoop official bucket manifest trees · api.github.com · Scoop official bucket manifest trees: bucket/helm-docs.json from https://api.github.com/repos/ScoopInstaller/Main/git/trees/master?recursive=1

Paketgraph

Links stammen aus dem lokalen Paketbeziehungsgraph, Ergänzungen, Abhängigkeitskanten, Ecosystem-Matches und Paket-Hub-Mitgliedschaft.

Quellspur

Aus Repository-Daten generiert

Diese Seite wird von av-web aus dem privaten Paket-SQLite-Artefakt bereitgestellt, das scripts/generate-pkg-sqlite.py erstellt.

Combined YAML source

View the package source record on GitHub.

combined/helm-docs.yml

Verwendete Quellen

Geiger risk classifier
Nucleus package database
av.db category and tag curation
cross-ecosystem install command graph
curated package history
external package-manager database matches
package relationship graph
package version freshness
package-page enrichment

helm-docs mit Homebrew, Nix, zypper, scoop installieren