install

Additional install commands

macOS

Homebrewverified · 100%

brew install lychee

local Homebrew formula metadata

MacPortsverified · 94%

sudo port install lychee

MacPorts ports tree · devel/lychee/Portfile · source: api.github.com

Linux

Alpine Linux apkverified · 92%

sudo apk add lychee

Alpine Linux edge package indexes · lychee · source: dl-cdn.alpinelinux.org

Nixverified · 92%

nix profile install nixpkgs#lychee

nixpkgs package indexes · pkgs/by-name/ly/lychee/package.nix · source: api.github.com

Arch Linux pacmanverified · 92%

sudo pacman -S lychee

Arch Linux sync databases · lychee · source: geo.mirror.pkgbuild.com

openSUSE zypperverified · 92%

sudo zypper install lychee

openSUSE Tumbleweed package metadata · lychee · source: download.opensuse.org

Windows

Scoopverified · 92%

scoop install main/lychee

Scoop official bucket manifest trees · bucket/lychee.json · source: api.github.com

Windows Package Managerverified · 92%

winget install --id lycheeverse.lychee -e

Windows Package Manager source index · lycheeverse.lychee · source: cdn.winget.microsoft.com

overview

Package summary

Fast, async, resource-friendly link checker

Project links

Commands and aliases

lychee

history

Project history and usage

lychee is a fast, asynchronous Rust link checker for websites, Markdown, HTML, and other text-like files. It is distributed as a CLI, a Rust library, Docker image, prebuilt binaries, and a GitHub Action.

Project history

The official README says the first prototype was built in episode 10 of Hello Rust. The public Git history for the standalone repository begins in August 2020, and early tags followed in December 2020. Since then the project has developed into a lycheeverse-maintained CLI plus `lychee-lib` library.

The project emphasizes Rust async execution, stream-oriented checking, static binaries, and CI-oriented output formats. Its feature table compares it with other link checkers such as awesome_bot, muffet, broken-link-checker, linkinator, linkchecker, markdown-link-check, and fink, positioning lychee in the cross-language ecosystem of documentation-quality tooling.

Adoption history

Upstream documents many install paths: Arch, openSUSE, Ubuntu snap, Alpine, Homebrew, MacPorts, Docker, Nix, FreeBSD, Termux, Conda, Scoop, WinGet, Chocolatey, prebuilt binaries, cargo-binstall, Cargo, and GitHub Actions. The README also lists notable users including OpenSearch, papers-we-love, PingCAP docs, Microsoft WhatTheHack, HashiCorp Consul, Fastify, Nuxt, containerd, Gradle, and tldr-pages.

How it is used

Common usage is `lychee [OPTIONS] [inputs]...`, either locally over documentation files and websites or in CI through the GitHub Action. The official config guide says `lychee.toml` is used by default when present in the current working directory, and `--config <PATH>` can point at another TOML config.

For GitHub-heavy link sets, lychee can use a GitHub token through `GITHUB_TOKEN`, `--github-token`, or the config file. The docs frame this as a way to avoid GitHub API rate limiting when checking public repository links.

Why package nerds care

lychee is a package-nerd favorite because it is the modern static Rust binary version of a classic maintenance chore: keep every link in your docs alive. Its broad install matrix, GitHub Action, Docker image, library crate, config file, and stable CI exit codes make it easy for distributions and automation platforms to carry.

Timeline

2020: Standalone repository history begins after extraction from the Hello Rust show repository.
2020: v0.2.0, v0.3.0, and v0.4.0 are tagged.
2021: v0.5 and v0.6 alpha releases follow.
2026: v0.24.x releases are tagged, with docs noting lychee-v0.24.2.

Related projects

lychee-action provides the GitHub Actions integration.
lychee-lib exposes the Rust library used by the CLI.
The README compares lychee with awesome_bot, muffet, broken-link-checker, linkinator, linkchecker, markdown-link-check, and fink.

Sources

security posture

No protected-tool coverage found yet

No matching local secret-handling manifest was found for lychee. Nucleus package metadata is still published here so future coverage has a stable package URL.

Install behavior

No Homebrew post-install hook is recorded in formula metadata.
Homebrew bottle metadata is available for 6 platform targets.
Build metadata lists 2 build dependencies.

Recommended review

Before unattended agent use, check whether the tool reads plaintext credentials, writes remote state, publishes artifacts, or shells out to plugins.

local files

Configuration and credential file locations

These source-backed paths show where this package keeps local settings or durable credentials. Automic Vault can use them as review targets for secret scanning, migration, and command approval.

Configuration files

Config paths the tool may read or write during local use.

Unix: lychee.toml

Credential files

Credential-bearing paths to review before unattended agent runs.

Unix: lychee.toml

executables

Installed executables

Command	Kind	Exposure	Note
`lychee`	cli	global executable

freshness

Version and freshness

These signals separate page generation age, package-manager activity, and upstream release comparison. Version lag is warned only when an evidence URL and comparable versions are present.

page generated2026-07-08

manager version0.24.2

manager updated2026-05-17

local dataok

upstreamcurrent

latest detectedlychee-v0.24.2

https://github.com/lycheeverse/lychee

okNo freshness warnings were generated.

install metadata

Package metadata

Package key	brew:lychee
Version	0.24.2
Package manager	Homebrew
Package manager page	https://formulae.brew.sh/formula/lychee
Homepage	https://lychee.cli.rs/
Repository	https://github.com/lycheeverse/lychee
Upstream docs	https://lychee.cli.rs/
License	Apache-2.0 OR MIT
Source archive	https://github.com/lycheeverse/lychee/archive/refs/tags/lychee-v0.24.2.tar.gz
Last updated	2026-05-17T19:17:45Z
Pulse	updated
Build dependencies	pkgconf, rust
Bottle	available (on arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, sonoma, x86_64_linux)
Homebrew post-install	not defined
Service	none declared

registry facts

Source database details

Source Database	Homebrew formula API
Tap	homebrew/core
Full Name	lychee
Version Scheme	0
Revision	0
Head Version	HEAD
Bottle Stable Root URL	https://ghcr.io/v2/homebrew/core
Deprecated	no
Disabled	no
Keg Only	no
URL Keys	head stable

source database matches

Other package-manager records

Matches are pulled from external package-manager indexes and kept separate from local Automic Vault package links.

Nix95%

lychee

nix profile install nixpkgs#lychee

normalized package name match
Matched by: Lychee

nixpkgs package indexes · api.github.com · nixpkgs package indexes: pkgs/by-name/ly/lychee/package.nix from https://api.github.com/repos/NixOS/nixpkgs/git/trees/master?recursive=1

apk95%

lychee 0.23.0-r0

Fast, async, resource-friendly link checker written in Rust

https://lychee.cli.rs

sudo apk add lychee

License: MIT OR Apache-2.0
Architecture: x86_64
Source Package: lychee
1 dependencies
1 provides
normalized package name match
Matched by: Lychee

Alpine Linux edge package indexes · dl-cdn.alpinelinux.org · Alpine Linux edge package indexes: lychee from https://dl-cdn.alpinelinux.org/alpine/edge/testing/x86_64/APKINDEX.tar.gz

apk95%

lychee-doc 0.23.0-r0

Fast, async, resource-friendly link checker written in Rust (documentation)

https://lychee.cli.rs

sudo apk add lychee-doc

License: MIT OR Apache-2.0
Architecture: x86_64
Source Package: lychee
normalized package name match
Matched by: Lychee

Alpine Linux edge package indexes · dl-cdn.alpinelinux.org · Alpine Linux edge package indexes: lychee-doc from https://dl-cdn.alpinelinux.org/alpine/edge/testing/x86_64/APKINDEX.tar.gz

pacman95%

lychee 0.24.2-1

Fast, async, resource-friendly link checker written in Rust

https://lychee.cli.rs

sudo pacman -S lychee

License: Apache-2.0 OR MIT
Architecture: x86_64
2 dependencies
normalized package name match
Matched by: Lychee

Arch Linux sync databases · geo.mirror.pkgbuild.com · Arch Linux sync databases: lychee from https://geo.mirror.pkgbuild.com/extra/os/x86_64/extra.db.tar.gz

zypper95%

lychee 0.24.2-1.1

Fast, async, stream-based link checker written in Rust

https://lychee.cli.rs

sudo zypper install lychee

License: Apache-2.0 OR MIT
Category: Unspecified
Architecture: x86_64
Source Package: lychee
4 dependencies
2 provides
normalized package name match
Matched by: Lychee

openSUSE Tumbleweed package metadata · download.opensuse.org · openSUSE Tumbleweed package metadata: lychee from https://download.opensuse.org/tumbleweed/repo/oss/repodata/be8d3611d25469107f32075a1697e69ec57a2b850b42348a658cc671ad5ec2b50760d02c3e59524d50da9a11d5be799bdaffba2e166e8ca8858512e3c0bd665d-primary.xml.zst

MacPorts95%

lychee

sudo port install lychee

normalized package name match
Matched by: Lychee

MacPorts ports tree · api.github.com · MacPorts ports tree: devel/lychee/Portfile from https://api.github.com/repos/macports/macports-ports/git/trees/master?recursive=1

Scoop95%

main/lychee

scoop install main/lychee

normalized package name match
Matched by: Lychee

Scoop official bucket manifest trees · api.github.com · Scoop official bucket manifest trees: bucket/lychee.json from https://api.github.com/repos/ScoopInstaller/Main/git/trees/master?recursive=1

winget95%

lycheeverse.lychee

winget install --id lycheeverse.lychee -e

normalized package name match
Matched by: Lychee

Windows Package Manager source index · cdn.winget.microsoft.com · Windows Package Manager source index: lycheeverse.lychee from https://cdn.winget.microsoft.com/cache/source.msix

package graph

Links come from deterministic package relationships, av.db category and tag curation, ecosystem matches, and package hub membership.

source trail

Generated from repository data

This page is generated by av-web from the private package SQLite artifact built by scripts/generate-pkg-sqlite.py.

Combined YAML source

View the package source record on GitHub.

combined/lychee.yml

Used sources

Geiger risk classifier
Nucleus package database
av.db category and tag curation
cross-ecosystem install command graph
curated configuration and credential file locations
curated package history
external package-manager database matches
package relationship graph
package version freshness
package-page enrichment

Install lychee with Homebrew, apk, MacPorts, Nix, pacman, scoop, winget, zypper

Additional install commands

macOS

Linux

Windows

Package summary

Project links

Commands and aliases

Project history and usage

Project history

Adoption history

How it is used

Why package nerds care

Timeline

Related projects

Sources

No protected-tool coverage found yet

Install behavior

Recommended review

Configuration and credential file locations

Configuration files

Credential files

Installed executables

Version and freshness

Package metadata

Source database details

Other package-manager records

Internal package links

Topical hubs

Related tools

Same workflow

Agent security guides

Generated from repository data

Combined YAML source

Used sources