lychee Async Broken Link Checker for Websites and Documentation

lychee is a fast, async, stream-based link checker written in Rust that finds broken URLs and mail addresses inside Markdown, HTML, reStructuredText, websites and more. It supports HTTP/HTTPS, file links, and mail address validation with configurable concurrency and output formats.

Installation

Use the upstream install or setup path that matches your environment:

• brew install lychee
• docker pull lycheeverse/lychee
• conda install lychee -c conda-forge
• cargo install lychee

Requirements and caveats from upstream:

• 

• Docker

• | Language | Rust | Ruby | Go | JS | TypeScript | Python | JS | PHP |

Basic usage or getting-started notes:

• <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

• Commandline usage

• Library usage

• Source: https://github.com/lycheeverse/lychee

• Extracted from upstream docs: https://raw.githubusercontent.com/lycheeverse/lychee/HEAD/README.md

Source

• Agent Skill Exchange