md-click-2
A fork. A command line tool for automatically generating .md files from click's CLI command.
Decision gist · record as of 2026-08-14
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.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- 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.
- Low install friction with only 2 runtime dependencies.
- Maintenance status is dormant—554 days since release with no recorded activity.
License · maintenance · safety
permissive license (permissive) — BSD 3-Clause License permits modification and redistribution with attribution; no restrictions on commercial use or derivative works.
last release 2025-02-06 (554 days)
0 known vulnerabilities (OSV.dev, 2026-08-14) · 95,098 downloads/mo, #13,291 on PyPI
Alternatives
Verify before relying
pip install md-click-2
mdclick dumps --baseModule=app.cli --baseCommand=main --docPath=./docs/commands- 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
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 on it.
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
Before you install
Low install friction with only 2 runtime dependencies. Maintenance status is dormant—554 days since release with no recorded activity.
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.
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/commandsVerify 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
| License | permissive license permissive |
| Python support | Supports the current Python release >=3.8 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 2 packagesclickbuild |
| Maintenance | Dormant 554 days since the last release |
| First released | |
| Downloads | 95,098 / month, #13,291 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableLicense :: OSI Approved :: BSD LicenseTopic :: DocumentationTopic :: Software Development :: Build ToolsTopic :: Software Development :: DocumentationTopic :: Software Development :: Libraries :: Python ModulesTopic :: Text Processing :: Markup :: Markdown |
Evidence: md_click_2-0.0.1-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “auto generate markdown from commands”
- md-click-2Generates markdown documentation files automatically from click CLI…
- reme-aiReMe is a local-first knowledge base that converts conversations and…
- opentelemetry-instrumentationProvides automatic instrumentation commands and programmatic APIs to…
Give your agent the search over MCP, or paste the wish link into any chat.
More Python Modules packages
Converts domain names between Unicode and ASCII-compatible encoding (Punycode) according to IDNA 2008 and Unicode Technical Standard 46, with security validation and broader script coverage than the standard library.
Install it if you work with internationalized domain names, need to validate domains, or use HTTP clients that depend on it transitively.
Setuptools is a Python build backend and package management tool that handles building, distributing, and installing Python packages, including support for C/C++ extension modules.
PyYAML parses and emits YAML 1.1 data format, enabling serialization and deserialization of configuration files and Python objects to and from human-readable YAML text.
Pydantic validates Python data structures against type hints, coercing and checking input at runtime to ensure it matches a declared schema.
Provides reusable metadata objects for use with PEP-593 `typing.Annotated` to express common constraints like bounds, collection sizes, and predicates on types.
Install it if you use or build libraries that need to express type constraints in a standardized, inspectable way—or if you want to annotate your own types with…
Provides runtime tools to inspect and introspect Python type annotations, enabling programmatic examination of type hints at execution time.
See also mkdocs-click · click-default-group · notion2md · jsonschema2md · md2pdf · pytest-md · django-click · click · mkdocs-autorefs · click-help-colors