feat(cli): cli markdown docs #13291
Merged
feat(cli): cli markdown docs #13291
+649
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
onbjerg
requested review from
DaniPopes,
grandizzy,
mattsse and
zerosnacks
as code owners
onbjerg
changed the title
Add a new crate for generating Markdown documentation from clap CLIs. This is a fork of clap-markdown with the following enhancements: - Support for grouped options by help heading (PR #48) - Show environment variable names for arguments (PR #50) - Add version information to generated Markdown (PR #52)
Add a hidden --markdown-help flag to forge, cast, anvil, and chisel that prints CLI reference documentation as Markdown and exits. This uses the new foundry-cli-markdown crate to generate the output.
onbjerg
force-pushed
the
onbjerg/md-help
branch
from
d469c16 to
7427c2f
Compare
mattsse
approved these changes
Feb 3, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
The CLI reference docs in the Foundry book are not that great to read, and you can't link to individual sections that well.
Solution
Have a mode to generate markdown CLI documentation from
--help. The flag is hidden. I've modifiedclap-markdownbecause it looks unmaintained and there were some patches I wanted. Attribution in the source code.Example output: https://gist.github.com/onbjerg/1bc68de7e464ad6d20060005ee427d42
PR Checklist