macOS
Homebrewvérifié · 100%
brew install protoc-gen-doclocal Homebrew formula metadata
brew / rang 5091
Installer protoc-gen-doc avec Homebrew, apk, Nix
Consultez les chemins d'installation, exécutables, métadonnées et notes de sécurité de protoc-gen-doc pour les workflows d'agents IA.
installation
Commandes d'installation supplémentaires
Linux
Alpine Linux apkvérifié · 92%
sudo apk add protoc-gen-docAlpine Linux edge package indexes · protoc-gen-doc · Source: dl-cdn.alpinelinux.org
Nixvérifié · 92%
nix profile install nixpkgs#protoc-gen-docnixpkgs package indexes · pkgs/by-name/pr/protoc-gen-doc/package.nix · Source: api.github.com
aperçu
Résumé du paquet
Documentation generator plugin for Google Protocol Buffers
Liens du projet
Commandes et alias
- protoc-gen-doc
historique
Historique du projet et usages
protoc-gen-doc is a protoc plugin that generates API documentation from comments in Protocol Buffer schemas. It supports built-in HTML, Markdown, DocBook, and JSON output as well as custom templates.
Historique du projet
protoc-gen-doc was created as a standalone plugin for Google's Protocol Buffers compiler. It converts comments and declarations in proto2 and proto3 schemas into human-readable or machine-readable documentation.
Historique d'adoption
The project is distributed through several developer-oriented channels, including downloadable binaries, a container image, Maven Central, and package managers represented in source_facts.package-manager. This makes it usable in local builds and language-neutral documentation pipelines.
Modes d'utilisation
Place the executable on PATH, then invoke protoc with --doc_out and --doc_opt to select an output directory, format or template, and output filename. The plugin can also exclude selected schema paths or comments and offers a containerized workflow using mounted input and output directories. It has no documented persistent configuration or credential file.
Pourquoi les passionnés de paquets s'y intéressent
It is a focused example of the protoc plugin model applied to documentation rather than source-code generation. Its support for HTML, Markdown, DocBook, JSON, and custom Go templates makes it useful when protobuf schemas double as an interface-description source.
Chronologie
- The official project documentation describes support for both proto2 and proto3 schemas and distribution as native releases, a Docker image, and a Maven Central artifact.
Related projects
- Protocol Buffers and its protoc compiler provide the schema and plugin protocol on which protoc-gen-doc depends.
- Other protoc plugins generate language bindings or RPC stubs; protoc-gen-doc instead generates descriptive documentation.
Sources
- https://github.com/pseudomuto/protoc-gen-doc#readme
- source_facts.description
- source_facts.package-manager
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 6 plateformes.
- S’installe avec 1 dépendances d’exécution.
- 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 |
|---|---|---|---|
protoc-gen-doc | 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-09-19
version du gestionnaire1.5.1
gestionnaire mis à jour2026-09-13
données localesOK
amontà jour
dernière version détectéev1.5.1
https://github.com/pseudomuto/protoc-gen-doc
- OKAucun avertissement de fraîcheur n'a été généré.
métadonnées d'installation
Métadonnées du paquet
| Clé du paquet | brew:protoc-gen-doc |
|---|---|
| Version | 1.5.1 |
| Gestionnaire de paquets | Homebrew |
| Page du gestionnaire de paquets | https://formulae.brew.sh/formula/protoc-gen-doc |
| Page d'accueil | https://github.com/pseudomuto/protoc-gen-doc |
| Dépôt | https://github.com/pseudomuto/protoc-gen-doc |
| Licence | MIT |
| Archive source | https://github.com/pseudomuto/protoc-gen-doc/archive/refs/tags/v1.5.1.tar.gz |
| Dernière mise à jour | 2026-09-13T12:25:23Z |
| Pulse | updated |
| Dépendances | protobuf |
| Dépendances de compilation | go |
| Bouteille | disponible (sur arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, sonoma, 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 | protoc-gen-doc |
| Version Scheme | 0 |
| Revision | 1 |
| 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%
protoc-gen-doc
nix profile install nixpkgs#protoc-gen-doc- normalized package name match
- Correspondance par : Protoc Gen Doc
apk95%
protoc-gen-doc 1.5.1-r6
protoc plugin to generate documentation from comments in .proto files
https://github.com/pseudomuto/protoc-gen-doc
sudo apk add protoc-gen-doc- License: MIT
- Architecture: x86_64
- Source Package: protoc-gen-doc
- 1 Dépendances
- 1 fournit
- normalized package name match
- Correspondance par : Protoc Gen Doc
apk95%
protoc-gen-doc-doc 1.5.1-r6
protoc plugin to generate documentation from comments in .proto files (documentation)
https://github.com/pseudomuto/protoc-gen-doc
sudo apk add protoc-gen-doc-doc- License: MIT
- Architecture: x86_64
- Source Package: protoc-gen-doc
- normalized package name match
- Correspondance par : Protoc Gen Doc
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
- cross-ecosystem install command graph
- curated package history
- external package-manager database matches
- package relationship graph
- package version freshness
- package-page enrichment
- pkg.so package database
- pkgdb category and tag curation