pkg.soopen package index

brew / rank 5091

Install protoc-gen-doc with Homebrew, apk, Nix

Documentation generator plugin for Google Protocol Buffers. Version 1.5.1 via Homebrew; verified 2026-09-13. Also installable with nix: nix profile install nixpkgs#protoc-gen-doc.

Install commandSecurity notes

install

Additional install commands

macOS

Homebrewverified · 100%
brew install protoc-gen-doc

local Homebrew formula metadata

Linux

Alpine Linux apkverified · 92%
sudo apk add protoc-gen-doc

Alpine Linux edge package indexes · protoc-gen-doc · source: dl-cdn.alpinelinux.org

Nixverified · 92%
nix profile install nixpkgs#protoc-gen-doc

nixpkgs package indexes · pkgs/by-name/pr/protoc-gen-doc/package.nix · source: api.github.com

overview

Package summary

Documentation generator plugin for Google Protocol Buffers

Commands and aliases

  • protoc-gen-doc

history

Project history and usage

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.

Project history

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.

Adoption history

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.

How it is used

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.

Why package nerds care

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.

Timeline

  • 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.

security posture

Risk level: green

narrow executable package without higher-risk signals.

Risk classifier

green risk · low confidence · appliance

Why

  • narrow executable package without higher-risk signals

Signals

  • metadata:no-higher-risk-signals

Install behavior

  • No Homebrew post-install hook is recorded in formula metadata.
  • Homebrew bottle metadata is available for 6 platform targets.
  • Installs with 1 runtime dependencies.
  • Build metadata lists 1 build dependencies.

Recommended review

Before unattended agent use, check whether the tool reads plaintext credentials, writes remote state, publishes artifacts, or shells out to plugins.

executables

Installed executables

CommandKindExposureNote
protoc-gen-doccliglobal executable

freshness

Version and freshness

These signals separate page generation age, package-manager activity, and upstream release comparison. Version lag is warned only when an evidence URL and comparable versions are present.

page generated2026-09-19
manager version1.5.1
manager updated2026-09-13
local dataok
upstreamcurrent
latest detectedv1.5.1

https://github.com/pseudomuto/protoc-gen-doc

  • okNo freshness warnings were generated.

install metadata

Package metadata

Package keybrew:protoc-gen-doc
Version1.5.1
Package managerHomebrew
Package manager pagehttps://formulae.brew.sh/formula/protoc-gen-doc
Homepagehttps://github.com/pseudomuto/protoc-gen-doc
Repositoryhttps://github.com/pseudomuto/protoc-gen-doc
LicenseMIT
Source archivehttps://github.com/pseudomuto/protoc-gen-doc/archive/refs/tags/v1.5.1.tar.gz
Last updated2026-09-13T12:25:23Z
Pulseupdated
Dependenciesprotobuf
Build dependenciesgo
Bottleavailable (on arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, sonoma, x86_64_linux)
Homebrew post-installnot defined
Servicenone declared

registry facts

Source database details

Source DatabaseHomebrew formula API
Taphomebrew/core
Full Nameprotoc-gen-doc
Version Scheme0
Revision1
Head VersionHEAD
Bottle Stable Root URLhttps://ghcr.io/v2/homebrew/core
Deprecatedno
Disabledno
Keg Onlyno
URL Keys
  • head
  • stable

source database matches

Other package-manager records

Matches are pulled from external package-manager indexes and kept separate from local Automic Vault package links.

Nix95%

protoc-gen-doc

nix profile install nixpkgs#protoc-gen-doc
  • normalized package name match
  • Matched by: Protoc Gen Doc
nixpkgs package indexes · api.github.com · nixpkgs package indexes: pkgs/by-name/pr/protoc-gen-doc/package.nix from https://api.github.com/repos/NixOS/nixpkgs/git/trees/master?recursive=1
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 dependencies
  • 1 provides
  • normalized package name match
  • Matched by: Protoc Gen Doc
Alpine Linux edge package indexes · dl-cdn.alpinelinux.org · Alpine Linux edge package indexes: protoc-gen-doc from https://dl-cdn.alpinelinux.org/alpine/edge/testing/x86_64/APKINDEX.tar.gz
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
  • Matched by: Protoc Gen Doc
Alpine Linux edge package indexes · dl-cdn.alpinelinux.org · Alpine Linux edge package indexes: protoc-gen-doc-doc from https://dl-cdn.alpinelinux.org/alpine/edge/testing/x86_64/APKINDEX.tar.gz

package graph

Links come from deterministic package relationships, av.db category and tag curation, ecosystem matches, and package hub membership.

Related tools

  • protobufRuntime dependency declared by Homebrew.
  • goBuild dependency declared by Homebrew.
  • protoc-gen-jsPackage names and metadata indicate a similar tool family. Shared terms: buffers, cli, code, code-generation, developer.
  • protoc-gen-grpc-swiftPackage names and metadata indicate a similar tool family. Shared terms: cli, code, code-generation, developer, developer-tools.

Same workflow

  • protoc-gen-go-grpcShares pkgdb curated category or tags: cli, code-generation, developer-tools, protobuf, protoc-plugin.
  • buffaShares pkgdb curated category or tags: cli, code-generation, developer-tools, protobuf.
  • sourceryShares pkgdb curated category or tags: cli, code-generation, developer-tools.
  • swift-protobufShares pkgdb curated category or tags: cli, code-generation, developer-tools, protobuf.
  • openapi-generatorShares pkgdb curated category or tags: cli, code-generation, developer-tools.
  • mockoloShares pkgdb curated category or tags: cli, code-generation, developer-tools.

source trail

Generated from repository data

This page is generated by av-web from the private package SQLite artifact built by scripts/generate-pkg-sqlite.py.

Used sources

  • 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