md-click-2

What it is and what it does

MD-Click is a command-line tool that introspects click CLI projects and automatically generates markdown documentation files. It recursively walks through a command group, creating one markdown file per command and subcommand, named in formats like `parent-command.md` or `parent-command-subcommand.md`. The tool solves the problem of maintaining separate documentation for click-based CLI tools by automating the extraction of command names, options, help text, and structure directly from Python code.

You run it by pointing it at your click module and specifying an output directory, and it generates the full documentation tree. It requires click and build as runtime dependencies. The project is marked as Production/Stable but has been dormant since its single release on 2025-02-06.

Use it for:

• Generate initial markdown documentation for a new CLI project without manual command documentation
• Keep CLI documentation in sync with code changes by regenerating markdown files after modifying commands
• Create a reference guide showing all available commands, options, and help text in browsable format
• Automate documentation generation in CI/CD pipelines to ensure docs stay current with code

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Generates markdown documentation files automatically from click CLI command hierarchies, creating one markdown file per command and subcommand.

Yes, if you maintain a click CLI and want automated markdown documentation. Install friction is low and the license is permissive. However, the project is dormant with no maintenance activity since release—if you encounter issues or need support for new features, you may need to fork or patch it yourself.

Install

md-click-2 on PyPI

pip install md-click-2

uv add md-click-2

poetry add md-click-2

Installing md-click-2

Before you install

Low install friction with only 2 runtime dependencies. Maintenance status is dormant—554 days since release with no recorded activity.

License in practice

BSD 3-Clause License permits modification and redistribution with attribution; no restrictions on commercial use or derivative works.

Quickstart

pip install md-click-2

mdclick dumps --baseModule=app.cli --baseCommand=main --docPath=./docs/commands

Requires Python >=3.8 and a click CLI module to introspect; the tool is run as a command-line utility, not imported as a library.

Verify before relying

• Whether the tool correctly handles complex nested command hierarchies and all option types
• Performance characteristics when processing large CLI projects with many commands
• Whether generated markdown formatting matches common documentation standards
• Current state of the repository and whether it accepts contributions or pull requests

Package facts

Evidence: md_click_2-0.0.1-py3-none-any.whl

Tags

More Python Modules packages