# lychee

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

Stars: 4.2k · Language: Rust · License: Apache-2.0 · Categories: Dev Tools

- Repository: https://github.com/lycheeverse/lychee
- Website: https://lychee.cli.rs
- Page: https://www.trmn.sh/tools/lychee

## Install

- Homebrew: `brew install lychee`
- Cargo: `cargo install lychee`
- Docker: `docker pull lycheeverse/lychee`

## Overview

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

```bash
# via Homebrew
brew install lychee
```

```bash
# via Cargo
cargo install lychee
```

```bash
# via Docker
docker pull lycheeverse/lychee
```

## Alternatives

- [dprint](https://www.trmn.sh/tools/dprint.md): Pluggable code formatting platform that runs multiple language formatters, including TypeScript, JSON, Markdown, TOML and wrappers for Prettier, Biome and Ruff. (Rust, 4.1k stars)
- [typos](https://www.trmn.sh/tools/typos.md): Source code spell checker that reports known misspellings, applies unambiguous corrections, and supports project-specific dictionaries and CI checks. (Rust, 4.2k stars)
- [bacon](https://www.trmn.sh/tools/bacon.md): Background code checker for Rust projects that runs continuously alongside your editor (Rust, 3.5k stars)
- [pastel](https://www.trmn.sh/tools/pastel.md): Command-line tool to generate, analyze, convert and manipulate colors across multiple formats and color spaces (Rust, 6.6k stars)
- [jscpd](https://www.trmn.sh/tools/jscpd.md): Copy/paste detector for 224 source formats with a Rust engine. Also reports dead code, complexity, git-history duplication trends, and a health score. (Rust, 6.6k stars)

---

Canonical: https://www.trmn.sh/tools/lychee
