macOS
Homebrewvérifié · 100%
brew install helm-docslocal Homebrew formula metadata
brew
Installer helm-docs avec Homebrew, Nix, zypper, scoop
Consultez les chemins d'installation, exécutables, métadonnées et notes de sécurité de helm-docs pour les workflows d'agents IA.
installation
Commandes d'installation supplémentaires
Linux
Nixvérifié · 92%
nix profile install nixpkgs#helm-docsnixpkgs package indexes · pkgs/by-name/he/helm-docs/package.nix · Source: api.github.com
openSUSE zyppervérifié · 92%
sudo zypper install helm-docsopenSUSE Tumbleweed package metadata · helm-docs · Source: download.opensuse.org
Windows
Scoopvérifié · 92%
scoop install main/helm-docsScoop official bucket manifest trees · bucket/helm-docs.json · Source: api.github.com
aperçu
Résumé du paquet
Tool for automatically generating markdown documentation for helm charts
Liens du projet
Commandes et alias
- helm-docs
historique
Historique du projet et usages
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.
Historique du projet
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.
Historique d'adoption
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.
Modes d'utilisation
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.
Pourquoi les passionnés de paquets s'y intéressent
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.
Chronologie
- 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.
Sources
posture de sécurité
Niveau de risque : vert
narrow executable package without higher-risk signals.
Classificateur de risque
risque vert · confiance faible · appliance
Pourquoi
- narrow executable package without higher-risk signals
Signaux
- metadata:no-higher-risk-signals
Comportement d'installation
- Aucun hook post-install Homebrew n’est enregistré dans les métadonnées de formule.
- Les métadonnées de bottle Homebrew sont disponibles pour 10 plateformes.
- Les métadonnées de compilation listent 1 dépendances de compilation.
Revue recommandée
Avant une utilisation sans surveillance par un agent, vérifiez si l'outil lit des identifiants en clair, écrit un état distant, publie des artefacts ou lance des plugins.
exécutables
Exécutables installés
| Commande | Type | Exposition | Note |
|---|---|---|---|
helm-docs | cli | exécutable global |
fraîcheur
Version et fraîcheur
Ces signaux séparent l'âge de génération de la page, l'activité du gestionnaire de paquets et la comparaison avec les versions amont. Un retard de version n'est signalé que lorsqu'une URL de preuve et des versions comparables sont présentes.
page générée2026-07-25
version du gestionnaire1.14.2
gestionnaire mis à jour
données localesOK
amontà jour
dernière version détectéev1.14.2
https://github.com/norwoodj/helm-docs
- infoNo package-manager update timestamp was available.confiance faible
métadonnées d'installation
Métadonnées du paquet
| Clé du paquet | brew:helm-docs |
|---|---|
| Version | 1.14.2 |
| Gestionnaire de paquets | Homebrew |
| Page du gestionnaire de paquets | https://formulae.brew.sh/formula/helm-docs |
| Page d'accueil | https://github.com/norwoodj/helm-docs |
| Dépôt | https://github.com/norwoodj/helm-docs |
| Docs amont | https://github.com/norwoodj/helm-docs#readme |
| Licence | GPL-3.0-or-later |
| Archive source | https://github.com/norwoodj/helm-docs/archive/refs/tags/v1.14.2.tar.gz |
| Dépendances de compilation | go |
| Bouteille | disponible (sur arm64_linux, arm64_monterey, arm64_sequoia, arm64_sonoma, arm64_tahoe, arm64_ventura, monterey, sonoma, ventura, x86_64_linux) |
| post-install Homebrew | non défini |
| Service | aucun déclaré |
faits du registre
Détails de la base source
| 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 |
|
correspondances dans les bases sources
Autres enregistrements de gestionnaires de paquets
Les correspondances proviennent d’index externes de gestionnaires de paquets et restent séparées des liens de paquets Automic Vault locaux.
Nix95%
helm-docs
nix profile install nixpkgs#helm-docs- normalized package name match
- Correspondance par : Helm Docs
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 Dépendances
- 1 fournit
- normalized package name match
- Correspondance par : Helm Docs
Scoop95%
main/helm-docs
scoop install main/helm-docs- normalized package name match
- Correspondance par : Helm Docs
piste source
Généré depuis les données du dépôt
Cette page est servie par av-web depuis l'artéfact SQLite privé des paquets généré par scripts/generate-pkg-sqlite.py.
Combined YAML source
View the package source record on GitHub.
Sources utilisées
- 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