#63 · Find ·

A Quiet Look at Lychee Link Checker

An overview of the Lychee link checker, examining its supported file formats, integration options, caching features, and the performance claims made in its documentation.

Fast stream-based link checker
AI-generated illustration. Fast stream-based link checker

The utility known as Lychee has emerged as a tool designed to scan files for broken hyperlinks. The software supports checking links within Markdown, HTML, reStructuredText, plain text, and source code files, as well as websites. To prevent redundant checks of URLs that were recently verified, the tool offers an optional on-disk cache, named '.lycheecache', to avoid re-checking recently validated URLs. For integration into automated workflows, the 'lychee-action' is available as an official GitHub Action that integrates lychee into CI/CD pipelines to check for broken links.

The project documentation claims that parallel async input and output makes lychee "orders of magnitude faster than sequential link checkers". Additionally, the development team presents the tool as a fast, async, stream-based link checker written in Rust. The documentation also asserts that the tool checks hundreds of links concurrently using parallel async I/O, and that it supports GitHub API tokens to bypass rate-limiting when checking github.com links.

In practical application, Lychee provides multiple output formats, including human-readable summaries, JSON, Markdown, JUnit XML, and GitHub Actions-compatible formats. These diverse output options allow development teams to easily parse results within their existing build pipelines and reporting structures. By utilizing the optional '.lycheecache' disk cache, users can significantly reduce unnecessary network traffic and avoid redundant processing of recently validated URLs during frequent local or automated runs.

Outside observers and independent testers have noted that the exact performance metrics, such as specific speedup ratios, are not universally quantified and depend on various factors like network latency and user configuration. Because the claim about lychee being 'orders of magnitude faster' is attributed directly to project documentation, it has not been verified by an independent benchmark.

Several details regarding the tool's operation and distribution remain unverified. It is not officially confirmed whether the tool is developed under the GitHub organization 'lycheeverse', nor is it verified if Lychee is distributed as a single static binary available via package managers like Homebrew, APT, pacman, Nix, Cargo, and Docker. Finally, the official project documentation does not specify how the tool handles custom network proxy configurations during link verification.

Sources

Verified claims

Stills

Checks hundreds of links concurrently
AI-generated. Checks hundreds of links concurrently
Proxy setup not specified
Proxy setup not specified
Lychee offers an optional on-disk cache,
AI-generated. Lychee offers an optional on-disk cache,

Original reporting: https://lychee.cli.rs/

Written by The Quiet Search. Method: /about.

Related

Comments

Plain text only. New comments stay hidden until a person reviews them.