GitHub Store
lycheeverse

lychee

lycheeverse

A fast, async, multi-threaded link checker written in Rust, for finding broken links in Markdown, HTML, text, and more.

nightly
Published at
1h ago
4,127
Stars
5,586,807
Download
Synced at
11m ago

Latest release

nightlyNov 13, 2026, 04:42 PMPre-release
Downloads slow? Switch the source anytime above

README

Project Overview

lychee is a fast, async, multi-threaded link checker written in Rust. It checks links in Markdown, HTML, text, email, and other files for validity.

Key Features

  • Checks links in Markdown, HTML, text, PDF, and more
  • Supports custom exclusion patterns and ignore rules
  • Supports direct remote page checking via URL
  • Supports multiple output formats (JSON, CSV, etc.)

Target Audience

  • Documentation maintainers and developers
  • Teams who need automated checking of broken links in websites or documents

Quick Start

  1. Install via package manager: brew install lychee (macOS), cargo install lychee
  2. Check a local file: lychee README.md
  3. Check a whole directory: lychee docs/
  4. Check a remote URL: lychee https://example.com

Core Advantages

  • Blazing fast async multi-threaded checking
  • Supports multiple file formats
  • Highly configurable
  • Open-source and free (Apache-2.0 / MIT)

System Requirements

  • OS: Cross-platform (Linux, macOS, Windows)
  • Architectures: x86_64, arm64
  • Additional Dependencies: None

Release history

Sort