{"repo":"g4s8/envdoc","free":true,"listed":false,"github":"https://github.com/g4s8/envdoc","clone":"git clone https://github.com/g4s8/envdoc.git","description":"Go tool to generate documentation for environment variables","language":"Go","stars":100,"topics":["devtools","documentation","go","go-generate"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"envdoc envdoc is a tool for generating documentation for environment variables in Go structs. It takes comments associated with env tags in Go structs and creates a Markdown, plaintext or HTML file with detailed documentation. For docenv linter see docenv/README.md. Installation Go = 1.24 Add envdoc tool and install it: Add go:generate : Generate: Before Go 1.24 Run it with go run in source file: Or download binary to run it: And use it in code: Usage -dir (path string, optional ) - Specify the directory to search for files. Default is the file dir with go:generate command. -files (glob string, optional ) - File glob pattern to specify file names to process. Default is the single file with go:generate . -types (glob string, optional ) - Type glob pattern for type names to process. If not specified, the next type after go:generate is used. -target ( enum(caarlos0, cleanenv) string, optional, default caarlos0 ) - Set env library target. -output (path string, required ) - Output file name for generated documentation. -format ( enum(markdown, plaintext, html, dotenv, json) string, optional ) - Output format for documentation. Default is markdown . -no-styles ( bool , optional ) - If true, CSS styles will not be included for html format. -env-prefix ( string , optional ) - Sets additional global prefix for all environment variables. -tag-name (string, optional , default: env ) - Use custom tag name instead of env . -tag-default (string, optional , default: envDefault ) - Use \"defa","default_branch":null,"files":null,"tree":[],"storefront":"/r/g4s8","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/g4s8/envdoc/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}