godocmd

godocmd

godocmd is a powerful Go documentation generator that outputs structured, customizable Markdown from your Go packages. It supports recursive package scanning, inclusion of private and undocumented symbols, and both CLI and programmatic usage.

🔧 Installation (CLI)

You can install the CLI tool using:

go install github.com/thinktide/godocmd/cmd@latest

This will install a binary named godocmd in your $GOBIN.

🚀 CLI Usage

godocmd -d <directory> [flags]

Common Flags:

Example

# Generate docs recursively from ./models and write to docs.md
godocmd -d ./models -r -o docs.md --include-private --verbose

📦 Programmatic Usage

You can also use godocmd as a Go library.

Install

go get github.com/thinktide/godocmd@latest

Import and Use

package main

import (
	"os"

	"github.com/thinktide/godocmd"
	"github.com/thinktide/godocmd/enums"
)

func main() {
	err := godocmd.GenerateMarkdown(
		"./myproject",   // root directory
		os.Stdout,       // output writer
		enums.Recursive, // enable recursion
		enums.Verbose,   // log verbosely
		enums.IncludePrivate, // include private symbols
	)
	if err != nil {
		panic(err)
	}
}

🧠 Features

• ✅ Recursive scanning with enums.Recursive
• ✅ Support for private types and functions via enums.IncludePrivate
• ✅ Strict documentation enforcement (exclude symbols with no GoDoc by default)
• ✅ Verbose logging support with enums.Verbose
• ✅ Outputs Markdown suitable for GitHub, wikis, or README sections

📁 Output Structure

• Each package starts with a comment header: <!-- ./package/path -->
• Structs include:
  • Go struct definition
  • JSON tags (if present)
  • DynamoDB tags (if present)
• Functions and methods show:
  • Full signature
  • GoDoc comments (if present)
  • Grouped under their receiver (for methods)

🧪 Contributing

We welcome issues and pull requests that improve Markdown output, formatting, or support for additional tag types (e.g., BSON, XML).

📄 License

This project is licensed under the MIT License.