lychee
Async, stream-based link checker written in Rust that finds broken URLs and email addresses in Markdown, HTML, reStructuredText, and websites.
lychee is a link checker written in Rust. It scans files and websites for hyperlinks and email addresses and reports the ones that are broken. It works on Markdown, HTML, reStructuredText, and other file formats, and it can also check live websites. The README describes it as async and stream-based.
lychee is available as a command-line utility, as a Rust library (lychee-lib, documented on docs.rs), and as a GitHub Action (lycheeverse/lychee-action) for running checks in CI. A pre-commit usage section is also listed in the README. Email address checking is provided by the mailify-lib crate through the email-check feature flag, which is enabled by default. A check_example_domains flag allows checking domains such as example.com, mainly for testing. TLS is handled by Rustls only, because OpenSSL support was dropped.
The intended users are developers, documentation maintainers, and CI pipeline owners who want to catch dead links in docs, READMEs, and sites. Pre-built binaries are published for Linux, macOS, and Windows. Packages exist for many systems, including Arch, openSUSE, Alpine, Nix, FreeBSD, Termux, Conda, Homebrew, MacPorts, Scoop, WinGet, and Chocolatey, and there is a Docker image with latest, versioned, and nightly tags plus -alpine variants. The project website documents the full set of command-line flags.
Installation
# via Homebrew
brew install lychee
# via Cargo
cargo install lychee
# via Docker
docker pull lycheeverse/lychee
Alternatives & related tools
dprint
Pluggable code formatting platform that runs multiple language formatters, including TypeScript, JSON, Markdown, TOML and wrappers for Prettier, Biome and Ruff.
typos
Source code spell checker that reports known misspellings, applies unambiguous corrections, and supports project-specific dictionaries and CI checks.
bacon
Background code checker for Rust projects that runs continuously alongside your editor
pastel
Command-line tool to generate, analyze, convert and manipulate colors across multiple formats and color spaces
jscpd
Copy/paste detector for 224 source formats with a Rust engine. Also reports dead code, complexity, git-history duplication trends, and a health score.
add a badge to your README
Maintain lychee? Show that it's featured on trmn. The badge links back to this page.
[](https://www.trmn.sh/tools/lychee?utm_source=badge)<a href="https://www.trmn.sh/tools/lychee?utm_source=badge"><img src="https://www.trmn.sh/badge/lychee.svg" alt="Featured on trmn" height="20"></a>