Проверяет сайты, документацию и локальные файлы на битые ссылки, обходя их через CLI, Node.js API и интеграции с CI.
lycheeverse/lychee
Быстрый асинхронный проверщик ссылок на Rust, который находит неработающие URL и адреса электронной почты в Markdown, HTML и на веб-сайтах.
- Звёзды
- 4,096
- Форки
- 245
- Открытые issues
- 75
- Последний коммит
- 4 дня назад
Что это?
lychee — это консольный проверщик ссылок, который ищет неработающие гиперссылки и, при необходимости, адреса электронной почты в локальных файлах и на веб-сайтах. Он поддерживает Markdown, HTML, CSS, XML и обычный текст, а для остальных форматов пытается извлечь URL. Перед проверкой команды предварительной обработки могут конвертировать такие форматы, как PDF и DOCX.
Проверки выполняются асинхронно и в потоковом режиме; можно настроить параллелизм, ограничение частоты запросов для отдельных хостов, повторы с экспоненциальной задержкой и кэширование запросов на диске. Ссылки можно исключать с помощью регулярных выражений или файла .lycheeignore, фильтровать по кодам состояния, передавать собственные заголовки или токен GitHub и выбирать формат отчёта, включая JSON, JUnit и Markdown.
Помимо CLI, lychee доступен как библиотека Rust (lychee-lib) и GitHub Action. Его также можно установить во многих операционных системах и использовать как Docker-образ.
Ключевые возможности
- 01Проверяет ссылки в файлах Markdown, HTML, CSS, XML и обычного текста, а также в локальных файлах и на веб-сайтах.
- 02При необходимости проверяет адреса электронной почты и якоря или текстовые фрагменты URL.
- 03Выполняет проверки асинхронно с настраиваемым параллелизмом, ограничением частоты запросов для отдельных хостов и повторами.
- 04Кэширует результаты на диске, чтобы ускорить повторные запуски.
- 05Исключает ссылки с помощью регулярных выражений или файла .lycheeignore.
- 06Формирует краткие и подробные отчёты, а также отчёты в форматах JSON, JUnit и Markdown.
Сценарии использования
- Поиск неработающих ссылок в репозиториях с документацией перед слиянием изменений.
- Запуск проверок ссылок в CI-пайплайнах с помощью GitHub Action или Docker-образа.
- Проверка существующего веб-сайта на неработающие внешние ссылки.
- Встраивание проверки ссылок в приложение на Rust с помощью крейта lychee-lib.
Быстрый старт
- 1
Установите lychee с помощью Homebrew (macOS)
brew install lychee - 2
Установите lychee с помощью Cargo (любая платформа с Rust)
cargo install lychee - 3
Загрузите официальный образ Docker
docker pull lycheeverse/lychee
В подборках
Темы
Частые вопросы
- Что такое lychee?
- Быстрый асинхронный проверщик ссылок на Rust, который находит неработающие URL и адреса электронной почты в Markdown, HTML и на веб-сайтах. lychee — это консольный проверщик ссылок, который ищет неработающие гиперссылки и, при необходимости, адреса электронной почты в локальных файлах и на веб-сайтах. Он поддерживает Markdown, HTML, CSS, XML и обычный текст, а для остальных форматов пытается извлечь URL. Перед проверкой команды предварительной обработки могут конвертировать такие форматы, как PDF и DOCX.
- lychee можно использовать бесплатно? Какая у него лицензия?
- lychee распространяется с открытым исходным кодом под лицензией Apache-2.0. Перед использованием в коммерческих продуктах проверьте условия лицензии.
- lychee всё ещё поддерживается?
- Активно поддерживается. Последний коммит в lychee — 2 нояб. 2026 г..
- Для чего можно использовать lychee?
- Поиск неработающих ссылок в репозиториях с документацией перед слиянием изменений. Запуск проверок ссылок в CI-пайплайнах с помощью GitHub Action или Docker-образа. Проверка существующего веб-сайта на неработающие внешние ссылки. Встраивание проверки ссылок в приложение на Rust с помощью крейта lychee-lib.
- Как установить lychee?
- Установите lychee с помощью Homebrew (macOS): brew install lychee Установите lychee с помощью Cargo (любая платформа с Rust): cargo install lychee Загрузите официальный образ Docker: docker pull lycheeverse/lychee
- Где скачать lychee?
- Исходный код и инструкции по установке — на GitHub: https://github.com/lycheeverse/lychee
Описание создано ИИ на основе README проекта. Статистика GitHub обновляется ежедневно.
Похожие проекты
CLI на Go для форматирования Markdown в стиле GFM, генерации фрагментов кода из команд, проверки ссылок и сборки статических сайтов из Markdown.
Быстрый чекер ссылок на сайтах на Go: рекурсивно обходит сайт и сообщает о неработающих ссылках.
Офлайн-линтер прозы для командных правил стиля: работает в редакторах, CI и коде.
Фоновый инструмент для проверки кода на Rust: запускает cargo check, Clippy и тесты при сохранении файлов и показывает предупреждения и ошибки в терминальном интерфейсе.
Инструмент для Python на Rust, который визуализирует зависимости между модулями и публичные интерфейсы кодовой базы и следит за их соблюдением.