Evans vs protoc-gen-doc

Evans is a free universal gRPC client for manual API inspection and scripting on Linux, macOS, and Windows. Its interactive REPL completes package, service, and RPC names. Stateless CLI mode reads standard input or files and prints JSON-formatted results. When server reflection is enabled, Evans can use that instead of proto files. It supports client-streaming, server-streaming, and bidirectional-streaming RPCs, plus gRPC-Web; TLS is not supported for gRPC-Web. The listed IDL and codec is Protocol Buffers 3, and the compressor is GZIP. For ordinary gRPC connections, the project documents secure TLS connections with the --tls option. Installation options include GitHub Releases, Homebrew, Docker, and Go, with Releases or Homebrew recommended for automatic updates. The documented Go installation requires Go v1.20 or later. The repeat option does not support client-streaming or bidirectional-streaming RPCs. Evans uses the MIT license.

protoc-gen-doc is a documentation generator plugin for the Google Protocol Buffers compiler. It turns comments in .proto files into HTML, JSON, DocBook, or Markdown documentation, covering files, messages, fields, services and methods, enums and values, and extensions. It supports proto2 and proto3, including both in the same context. You can exclude files with path patterns and omit comments marked with the @exclude prefix. The plugin runs through protoc with the --doc_out and --doc_opt options; its source_relative flag places generated output in the same relative directory as the input. For customization, users can supply a Go template or use a stylesheet.css file to change HTML appearance. Installation options include Go, prebuilt releases, a Docker image, and a Maven Central package. It runs on Linux, macOS, and Windows and is self-hosted. The project is free under the MIT License, which allows use, modification, distribution, sublicensing, and sale under its terms. The license provides the software as is, without warranty.