rumdl CLI
CLI проверяет и форматирует Markdown, чтобы агент сначала показал нарушения, затем применил согласованные исправления.
- 1 630 ★ репозитория
- Последний коммит
Расширенный доступ
Почему такой уровень
- При форматировании и исправлении rumdl меняет Markdown-файлы; область записи определяется переданными путями и настройками.
Установка
Ручная установка
uvx rumdl check .Первый Quick Start запускает проверку текущего каталога без постоянной установки. Для начала выберите тестовый каталог.
Доступ и проверки
Как мы проверяемРасширенный доступИнструмент запускает код или ходит в сеть, а внешние данные только читает.
- При форматировании и исправлении rumdl меняет Markdown-файлы; область записи определяется переданными путями и настройками.
Это чужой код. Посмотрите файлы в репозитории перед установкой.
Что делает
rumdl проверяет Markdown по настраиваемым правилам и помогает поддерживать единое оформление документации. Агент запускает `rumdl check` для нужных файлов, разбирает найденные места и выбирает исправления. Для форматирования есть `rumdl fmt` и режим исправления с повторной проверкой. Инструмент понимает несколько вариантов Markdown и умеет находить привычные настройки `markdownlint`. Его можно встроить в CI, редактор или обработку входного потока. Программа меняет исходные файлы только в выбранном режиме записи.
Для кого. Техническим писателям, которые ведут много Markdown-файлов и хотят согласованно исправлять оформление вместе с агентом.
Подходит, если
- Агент подготовил документацию, и перед коммитом нужно проверить структуру Markdown.
- Команда переносит существующие настройки `markdownlint` в новый инструмент.
- В CI требуется отличать успешное форматирование от оставшихся нарушений.
- Исправления нужно ограничить конкретной папкой документации.
Не подходит, если
- Вы ожидаете проверку фактов и качества содержания вместо разметки.
- Автоматические правки нельзя просмотреть перед сохранением.
- CI должен завершаться успешно только при чистом документе, но вы запускаете лишь форматирование.
Пример запроса к агенту
Проверь документацию через `rumdl check`, покажи нарушения и предложи исправить только согласованные файлы.Ограничения
Правила касаются Markdown; смысл, факты и соответствие текста задаче проверяйте отдельно. Команда `rumdl fmt` может завершиться успешно при оставшихся неисправимых нарушениях; для строгой приемки используйте `rumdl check`. Автоматическое исправление пишет в файлы, поэтому сначала просмотрите набор правил и выбранные пути. Совместимость вариантов Markdown зависит от настроенного формата и исключений, особенно для MDX, MkDocs и других расширений.
Как отключить. Остановите наблюдение и уберите rumdl из CI или редактора. Примененные изменения отменяются отдельно через Git; конфигурация остается файлом проекта.
Частые вопросы
Как проверить без постоянной установки?
Выполните `uvx rumdl check .` в каталоге документации.
Чем `rumdl fmt` отличается от `rumdl check --fix`?
`rumdl fmt` сообщает об успешном форматировании. `rumdl check --fix` дополнительно отражает оставшиеся нарушения в коде завершения.
Нужно ли сразу переписывать конфигурацию `markdownlint`?
Нет. Можно начать с существующего файла и сравнить результат.
Как ограничить проверку?
Используйте пути, `--include` и `--exclude`.
Как увидеть справку о правиле?
Команда `rumdl rule` показывает сведения о выбранном правиле или список правил.
Обсуждение
Вопросов и отзывов пока нет.
Похожие
CLI-инструментыslopless, CLI проверки английского текста, различает чистый результат, замечания к тексту и ошибку запуска кодами завершения.
Скилл и CLI от Firecrawl: агент переводит Word, PowerPoint, Excel, OpenDocument, RTF, EPUB, CSV и PDF в Markdown на вашей машине
CLI форматирует Markdown для публикации, создает HTML с оформлением, извлекает обычный текст и исправляет разметку файла.
Docling — CLI для смешанного архива: PDF, документы и таблицы можно привести к общему формату для поиска и ИИ.
Скилл и программа docx: агент заполняет формы, правит таблицы и ведет рецензирование Word с отслеживаемыми правками
MCP-сервер на базе Docling: переводит PDF в структурированный документ, собирает новые документы и загружает их в RAG
Коротко о README
Есть интеграция с редакторами через языковой сервер и проверка Markdown в документационных комментариях Rust. Пользовательские и проектные настройки имеют разные приоритеты.