lychee

Async, stream-based link checker written in Rust that finds broken URLs and email addresses in Markdown, HTML, reStructuredText, and websites.

install

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

add a badge to your README

Maintain lychee? Show that it's featured on trmn. The badge links back to this page.

Featured on trmn
Markdown
[![Featured on trmn](https://www.trmn.sh/badge/lychee.svg)](https://www.trmn.sh/tools/lychee?utm_source=badge)
HTML
<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>