Lychee (link checker)
lastmod 2025-04-15created 2025-04-153 edits
⚡ Fast, async, stream-based link checker written in Rust. Finds broken URLs and mail addresses inside Markdown, HTML, reStructuredText, websites and more!
A fast asynchronous link checker written in Rust
About
- Optimized for analyzing links in Markdown, HTML, text files, and websites and detecting broken links
- Available as a CLI, library, Docker image, GitHub Action, and pre-commit hook, so it can be integrated into various development and deployment pipelines
- Compared with other well-known open-source link checkers, it offers the most features, excellent performance, broad format support, and high extensibility
- Installable on most operating systems and package managers: Linux (pacman, zypper, apk, pkg, nix, apt), Mac (Homebrew, MacPorts), Windows (Scoop, Chocolatey)
Key features
- Supported formats: Markdown, HTML, text, reStructuredText, websites
- Fast checking through asynchronous processing and parallel requests
- Can check email addresses
- Customizable HTTP headers, authentication, cookies, timeouts, etc.
- JSON output, progress bar, colored output, summary report
- Automatic redirect handling, GZIP compression support, URL pattern filtering
- Caching (.lycheecache)
- Configurable via environment variables or a config file
- Can use a GitHub API token to avoid rate limits
See also
- lychee (image organizer) - Free/open-source photo management system
- lychee (link checker) - A fast asynchronous link checker written in Rust
- Markdown
- pandoc