Introduction
Welcome to Lychee!
…a fast, async, stream-based link checker written in Rust. 🦀✨
lychee finds broken URLs and mail addresses inside Markdown, HTML, reStructuredText, websites, and more!
Let’s go through some usage examples.
Check All Links In Current Directory
The following command recursively checks all links in all supported files inside the current directory.
lychee .
Check All Links On A Website
lychee https://example.com
Check Only Specific Files
lychee README.mdlychee test.html info.txtlychee test.html info.txt https://example.com
Check Links In Directories, But Block All Network Requests
lychee --offline path/to/directory
Check Links In A Remote File
lychee https://raw.githubusercontent.com/lycheeverse/lychee/master/README.md
Check links from stdin
cat test.md | lychee -echo 'https://example.com' | lychee -
Check Links In Local Files Via Shell Glob
lychee ~/projects/*/README.md
Advanced Globbing And ~
Expansion
lychee "~/projects/big_project/\*_/README._"
Ignore Case When Globbing And Check Result For Each Link
lychee --glob-ignore-case --verbose "~/projects/\*_/[r]eadme._"
Check Links From Epub File
If you have atool installed, you can check links inside .epub
files as well!
acat -F zip {file.epub} "_.xhtml" "_.html" | lychee -