lychee
fast link checker
TLDR
Check links in file
$ lychee [README.md]
Check entire directory$ lychee [docs/]
Check website$ lychee [https://example.com]
Exclude patterns$ lychee --exclude [example.com] [file.md]
Output formats$ lychee --format json [file.md]
Skip offline check$ lychee --offline [file.md]
SYNOPSIS
lychee [options] inputs
DESCRIPTION
lychee is a fast link checker. It validates links in markdown, HTML, and plain text.The tool is written in Rust for speed. It checks both local and remote links concurrently.
PARAMETERS
INPUTS
Files, directories, or URLs.--exclude PATTERN
Exclude matching URLs.--format FMT
Output format (plain, json, markdown).--offline
Skip network checks.--cache
Use cache for results.--help
Display help information.
INSTALL
sudo pacman -S lychee
sudo zypper install lychee
brew install lychee
nix profile install nixpkgs#lychee
CAVEATS
Network checks may be rate-limited. Some sites block automated requests. Rust-based.
HISTORY
lychee was created as a fast, modern Rust-based link checker for documentation and websites.
SEE ALSO
linkchecker(1), wget(1), curl(1)
