rumdl CLI
The CLI checks and formats Markdown so an agent can report violations before applying agreed changes.
- 1,630 ★ on the repository
- Last commit
Extended access
Why this level
- Formatting and fixing modes change Markdown files within supplied paths and configuration.
Install
Manual install
uvx rumdl check .First Quick Start command checks the current directory without persistent installation; begin in a test directory.
Access and checks
How we reviewExtended accessThe tool runs code or makes network calls and only reads external data.
- Formatting and fixing modes change Markdown files within supplied paths and configuration.
This is third-party code. Review the repository files before installing.
What it does
rumdl checks Markdown against configurable rules for consistent documentation. An agent runs check, inspects findings and selects fixes. Separate formatting and fix-and-check modes provide different completion signals. Several Markdown flavors and common markdownlint configurations are supported. The tool fits CI, editor and stdin workflows; writing changes depends on the selected mode.
Who it is for. Technical writers maintaining many Markdown files with agent-assisted formatting checks.
Good fit when
- Agent-written docs need Markdown checks before committing.
- A team wants to reuse existing markdownlint configuration.
- CI must distinguish successful formatting from remaining violations.
- Fixes should be limited to one documentation directory.
Not a fit when
- You expect factual or editorial review rather than markup checks.
- Automated changes cannot be reviewed before saving.
- Zero exit must mean no violations but only fmt is used.
Example request
Run rumdl check on the documentation, show violations and propose fixes only for agreed files.Limitations
Rules concern Markdown syntax and style, so meaning, facts and task relevance need separate review. fmt can succeed while unfixable violations remain; use check for strict acceptance of the document. Automatic fixing writes files, so inspect selected rules and paths beforehand. Markdown-flavor handling depends on configuration and exclusions, particularly for MDX, MkDocs and other extended documentation formats.
How to disable. Stop watch mode and remove rumdl from CI or the editor. Revert applied changes through Git; configuration remains in the project.
FAQ
How do I check without persistent installation?
Run `uvx rumdl check .` in the documentation directory.
How do fmt and check --fix differ?
fmt reports formatting success, while fixing through check also reflects remaining violations in exit status.
Must I rewrite markdownlint configuration immediately?
No. Start with the existing file and compare results.
How do I restrict scope?
Use paths, `--include` and `--exclude`.
How do I inspect a rule?
Use `rumdl rule` for a rule’s details or a rule list.
Discussion
No questions or reviews yet.
Related
CLI toolsslopless is an English prose-checking CLI with distinct exit codes for a clean result, editorial findings and execution failure.
A Firecrawl skill and CLI that lets your agent convert Word, PowerPoint, Excel, OpenDocument, RTF, EPUB, CSV and PDF to Markdown on your own machine
A CLI formats Markdown for publication, creates styled HTML, extracts plain text and fixes document markup from a terminal.
Docling is a CLI for mixed document archives, bringing PDFs, office files and spreadsheets into a shared format for AI search.
A skill plus the docx program: the agent fills forms, edits tables and reviews Word files with tracked changes
An MCP server built on Docling: converts PDFs into structured documents, builds new ones and feeds them to RAG
README in short
Editor language-server integration and Rust documentation-comment checks are available. User and project configuration have distinct precedence.