make-help

make-help

Static help generation for Makefiles with rich documentation support and linting.

Why make-help?

Makefiles are powerful but lack a built-in help system. As projects grow, developers accumulate dozens of targets with no easy way to discover or document them.

make-help solves this by extracting documentation from specially-formatted comments and generating static help files displayed with make help. The generated help files contain embedded help text and automatically regenerate when source Makefiles change. It supports categories, aliases, environment variables, and target filtering.

Features

• Static Help Generation: Creates help files with embedded help text (no runtime dependencies)
• Auto-Regeneration: Generated files automatically regenerate when source Makefiles change
• Automatic Target Discovery: Scans your Makefiles (including included files) to find documented targets
• Rich Documentation Syntax: Support for file-level docs, categories, aliases, and environment variables
• Target Filtering: Control which targets appear in help output
• Detailed Target Help: Show full documentation for individual targets via make help-<target>
• Flexible Ordering: Alphabetical or discovery order for both categories and targets
• Colored Output: Terminal-aware colored output with override flags
• Summary Extraction: Automatically extracts first sentence from multi-line documentation

Installation

Homebrew (macOS/Linux)

brew install sdlcforge/tap/make-help

Go

go install github.com/sdlcforge/make-help/cmd/make-help@latest

npm/bun

# global installation
npm install -g @sdlcforge/make-help
bun install -g @sdlcforge/make-help
# package installation
npm install --save-dev @sdlcforce/make-help
bun install --save-dev --trust true @sdlcforge/make-help

Quick start

1. Document your Makefile

Add documentation comments using the ## prefix:

## !file
## My Project Makefile
## This file contains build and deployment targets.

## !category Build
## Build the application
build:
	go build -o myapp ./cmd/myapp

## !category Test
## Run all tests
test:
	go test ./...

## !category Deploy
## !var ENV Target environment (dev, staging, prod)
## Deploy the application
deploy:
	./scripts/deploy.sh $(ENV)

2. Generate static help file

make-help

This generates ./make/help.mk (or ./make/00-help.mk if numbered files exist) and automatically adds -include make/*.mk to your Makefile if needed.

• make help - displays help summary
• make help-<target> - detailed help for each documented target
• Run make update-help or add 'update-help' to your 'build' target to regenerate the help when source files change

3. Use the Help System

Now you can run:

• make help - displays help summary
• make help-build - detailed documentation for the build target

Output from make help (coloration not shown):

Usage: make [<target>...] [<ENV_VAR>=<value>...]

Targets:

Build:
  - build: Build the application

Deploy:
  - deploy: Deploy the application
    Vars: ENV Target environment (dev, staging, prod)

Test:
  - test: Run all tests

Usage

Generate static help file (default)

make-help                              # Generate ./make/help.mk for ./Makefile
make-help --makefile-path path/to/Makefile
make-help --help-file-rel-path custom/path.mk  # Override default location

Lint Makefile and help documentation

make-help --lint        # find potential red flags
make-help --lint --fix  # fix what can be automatically fixed and report the rest

Display help dynamically

To see help output without generating a file:

make-help --show-help                  # Show help for ./Makefile
make-help --show-help --makefile-path path/to/Makefile

To get detailed help for a particular target:

make-help --show-help --target build   # Full docs for 'build' target

Target Filtering

By default, only documented targets appear in help output.

make-help --include-target clean       # Include undocumented 'clean'
make-help --include-target foo,bar     # Include multiple (comma-separated)
make-help --include-all-phony          # Include all .PHONY targets

Remove Help Files

make-help --remove-help                # Remove generated help files

CLI reference

Mode:

• --dry-run - Preview changes without making them
• --fix - Auto-fix lint issues (requires --lint)
• --lint - Check documentation quality and report warning
• --remove-help - Remove generated help files
• --show-help - Display help dynamically instead of generating file
• --target <name> - Show detailed help for specific target (requires --show-help)

Input:

• --help-file-rel-path <path> - Relative path for generated help file (default: make/help.mk)
• --makefile-path <path> - Path to Makefile (default: ./Makefile)

Output/formatting:

• --category-order <list> - Explicit category order (comma-separated)
• --color / --no-color - Force or disable colored output
• --default-category <name> - Default category for uncategorized targets
• --help-category <name> - Category for generated help targets (default: Help)
• --include-all-phony - Include all .PHONY targets
• --include-target <list> - Include undocumented targets (comma-separated, repeatable)
• --keep-order-all - Preserve category, target, and file order
• --keep-order-categories - Preserve category discovery order
• --keep-order-files - Preserve file discovery order (default: alphabetical)
• --keep-order-targets - Preserve target discovery order

Misc:

• --verbose - Enable verbose output
• --version - Display version information

Documentation syntax

• Any line beginning with ## is considered part of the documentation.
• Lines beginning with a # are treated as internal documentation and will be ignored.
• Documentation directives include:
  • !file to identify file level documentation.
  • !category to specify the category for the following targets within the source file.
  • !alias explicitly names another target as an alias for the target being documented. Aliases can usually be inferred and the use of this directive may not be necessary.
  • !noalias keeps the next alias looking target as not an alias.
  • !var documents environment variables affecting the target behavior.

File-level documentation

Use !file to add file-level documentation. The entry point Makefile's !file documentation appears at the top of the help output (after the usage line). Documentation from included files appears in an "Included Files:" section.

## !file
## Project Build System
## This Makefile handles building, testing, and deploying the application.

Multiple !file directives: You can have multiple !file directives in the same file. They will be concatenated with a blank line between them.

File ordering: By default, included files are sorted alphabetically in the "Included Files:" section. Use --keep-order-files to preserve the discovery order instead.

Target Documentation

Document targets with ## comments immediately before the target:

## Build the entire project.
## This compiles all sources and runs code generation.
build:
	@echo "Building..."

The first sentence becomes the summary in the help output.

Categories

Group related targets using !category. The !category directive acts as a switch that applies to all subsequent targets until changed:

## !category Build
## Build the project
build:                    # category: Build
	@echo "Building..."

## Compile source files (still in Build category)
compile:                  # category: Build (inherited)
	@echo "Compiling..."

## !category Test
## Run unit tests
test:                     # category: Test
	@echo "Testing..."

## Run integration tests (still in Test category)
integration:              # category: Test (inherited)
	@echo "Running integration tests..."

Key Behaviors:

• Sticky directive: Once set, !category applies to all subsequent targets within that make file until another !category is encountered
• Reset to uncategorized: Use !category _ to reset the category to uncategorized (nil)
• Categories are merged: If you switch back and forth to the same category in a single or use the same category in mulitple files, all targets in that category will be grouped together.
• Mixed categorization: If you use categories, all documented targets must be categorized. Use --default-category to assign uncategorized targets to a default category

Aliases

An 'alias' is just an alternate name for a target. There are two ways to create an aliase.

Implicit aliases: A single phony target with a single phony target dependincy is regonized as an aliase; e.g., test: test.unit recognized test as an alias for test.unit. This can be supressed by placing the ## !noalias directive before the target. E.g.:

## !noalias
all: build

You can also explicitly name one or more aliases with the !alias directive:

## !alias b, build-all
## Build the project
build:
	@echo "Building..."

Environment variables

Document behavior affecting environment variables using !var. This is similar to how parameters would be documented for function documentation.

## !var DATABASE_URL Database connection string
## !var LOG_LEVEL Logging verbosity (debug, info, warn, error)
## Start the application server
server:
	./bin/server

Variables appear in the help output under the target:

  - server: Start the application server
    Vars: DATABASE_URL Database connection string, LOG_LEVEL Logging verbosity (debug, info, warn, error)

Examples

The examples/ directory contains complete working examples demonstrating different features. Each example includes a generated help.mk file, so you can run them via Make:

make -f examples/categorized-project/Makefile help
make -f examples/full-featured/Makefile help-build

Output format

The help output follows this structure:

Usage: make [<target>...] [<ENV_VAR>=<value>...]

[Entry point Makefile's !file documentation - full text, if present]

Included Files:
  path/to/file.mk
    Full documentation from the file's !file directive
    Can be multiple lines

  path/to/another.mk
    Documentation here

Targets:

[Category Name:]
  - <target> [<alias1>, <alias2>...]: <summary>
    [Vars: <VAR1> <description1>, <VAR2> <description2>...]

Key behaviors:

• Entry point's !file docs appear first (full text, not just summary)
• Included files' !file docs appear in the "Included Files:" section (full text)
• Files are sorted alphabetically by default (use --keep-order-files to preserve discovery order)

Color scheme

When colors are enabled:

• Category Names: Bold Cyan
• Target Names: Bold Green
• Aliases: Yellow
• Variable Names: Magenta
• Documentation: White

Advanced topics

Working with included files

make-help automatically discovers all Makefiles via include directives using Make's MAKEFILE_LIST variable. Documentation from all files is aggregated in discovery order.

# Main Makefile
include make/*.mk

## !category Core
## Build everything
all: build test deploy
	@echo "Done!"

# make/build.mk
## !category Build
## Build the project
build:
	go build ./...

Both files are processed and targets are grouped by category.

Uninstalling

Removing Generated Help Files

To remove the generated help files and artifacts created by make-help:

make-help --remove-help

What gets removed:

• The generated help file (e.g., ./make/help.mk or ./make/00-help.mk)
• The include directive that was automatically added to your Makefile (e.g., -include make/*.mk)

What does NOT get removed:

• Any targets or content you wrote yourself
• The bin/ directory (where the binary is built locally during development)
• Your documentation comments (## comments in your Makefiles)

Removing the Binary

The --remove-help flag only removes generated help files, not the make-help binary itself.

If installed via Homebrew:

brew uninstall make-help

If installed via Go:

rm $(go env GOPATH)/bin/make-help

If installed via npm or bun:

# global installation
npm uninstall -g @sdlcforge/make-help
bun uninstall -g @sdlcforge/make-help
# package installation
npm uninstall @sdlcforce/make-help
bun uninstall @sdlcforge/make-help

If built locally during development:

make clean    # Removes ./bin/make-help

Troubleshooting

Mixed Categorization Error

Error: mixed categorization: found both categorized and uncategorized targets

Solution: Either categorize all targets or use --default-category:

make-help --default-category Miscellaneous

Unknown Category Error

Error: unknown category "Foo" in --category-order

Solution: Check the available categories in your Makefile. The error message lists all available categories.

Makefile Not Found

Error: Makefile not found: ./Makefile

Solution: Specify the path explicitly:

make-help --makefile-path path/to/your/Makefile

Make Command Timeout

If your Makefile is very complex or has expensive operations during parsing, you may encounter timeouts. The default timeout is 30 seconds.

Solution: Simplify variable expansions or move expensive operations out of variable assignments.

Developer documentation

• Developer Brief - Contributing guide, development setup, and common tasks
• Architecture Document - Comprehensive architecture and implementation details

License

This project is licensed under the Apache 2.0 License - see the LICENSE.txt file for details.

Credits

The summary extraction algorithm is a Go port of the extract-topic JavaScript library.

Support

• Issues: Report bugs and request features via GitHub Issues
• Discussions: Ask questions in GitHub Discussions

Last reviewed: 2025-12-25T16:43Z