# Install lychee with Homebrew, apk, MacPorts, Nix, pacman, scoop, winget, zypper Fast, async, resource-friendly link checker. Version 0.24.2 via Homebrew; verified 2026-05-17. ## Install ```sh sudo av install brew:lychee ``` Additional install commands: ### macOS - Homebrew (100%): ```sh brew install lychee ``` Evidence: local Homebrew formula metadata - MacPorts (94%): ```sh sudo port install lychee ``` Evidence: MacPorts ports tree: devel/lychee/Portfile from https://api.github.com/repos/macports/macports-ports/git/trees/master?recursive=1 ### Linux - apk (92%): ```sh sudo apk add lychee ``` Evidence: Alpine Linux edge package indexes: lychee from https://dl-cdn.alpinelinux.org/alpine/edge/testing/x86_64/APKINDEX.tar.gz - Nix (92%): ```sh nix profile install nixpkgs#lychee ``` Evidence: nixpkgs package indexes: pkgs/by-name/ly/lychee/package.nix from https://api.github.com/repos/NixOS/nixpkgs/git/trees/master?recursive=1 - pacman (92%): ```sh sudo pacman -S lychee ``` Evidence: Arch Linux sync databases: lychee from https://geo.mirror.pkgbuild.com/extra/os/x86_64/extra.db.tar.gz - zypper (92%): ```sh sudo zypper install lychee ``` Evidence: openSUSE Tumbleweed package metadata: lychee from https://download.opensuse.org/tumbleweed/repo/oss/repodata/be8d3611d25469107f32075a1697e69ec57a2b850b42348a658cc671ad5ec2b50760d02c3e59524d50da9a11d5be799bdaffba2e166e8ca8858512e3c0bd665d-primary.xml.zst ### Windows - Scoop (92%): ```sh scoop install main/lychee ``` Evidence: Scoop official bucket manifest trees: bucket/lychee.json from https://api.github.com/repos/ScoopInstaller/Main/git/trees/master?recursive=1 - winget (92%): ```sh winget install --id lycheeverse.lychee -e ``` Evidence: Windows Package Manager source index: lycheeverse.lychee from https://cdn.winget.microsoft.com/cache/source.msix ## Package facts - **Package key:** brew:lychee - **Package manager:** Homebrew - **Package manager page:** - **Version:** 0.24.2 - **Source summary:** Fast, async, resource-friendly link checker - **Homepage:** - **Repository:** - **Upstream docs:** - **License:** Apache-2.0 OR MIT - **Source archive:** - **Last updated:** 2026-05-17T19:17:45Z - **Generated:** 2026-07-08T07:18:31+00:00 ## Executables - lychee (cli) - lychee (alias) ## Build dependencies - pkgconf - rust ## Install behavior - Post-install hook: not defined - Bottle: available on arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, sonoma, x86_64_linux ## Freshness - Page generated: 2026-07-08 - Package-manager version: 0.24.2 - Package-manager updated: 2026-05-17 - Local data: ok - Upstream repository: https://github.com/lycheeverse/lychee - Upstream latest detected: lychee-v0.24.2 (current) ## 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 ` 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 - - - - - - source_facts.package-manager ## Security Notes 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. ## 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 - Unix: lychee.toml ## Credential files - Unix: lychee.toml ## 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:** - **Deprecated:** no - **Disabled:** no - **Keg Only:** no - **URL Keys:** head, stable ## Other Package-Manager Records - Nix - lychee: normalized package name match | nixpkgs package indexes: pkgs/by-name/ly/lychee/package.nix from https://api.github.com/repos/NixOS/nixpkgs/git/trees/master?recursive=1 - apk - lychee - 0.23.0-r0: normalized package name match | Alpine Linux edge package indexes: lychee from https://dl-cdn.alpinelinux.org/alpine/edge/testing/x86_64/APKINDEX.tar.gz | Fast, async, resource-friendly link checker written in Rust | https://lychee.cli.rs - apk - lychee-doc - 0.23.0-r0: normalized package name match | Alpine Linux edge package indexes: lychee-doc from https://dl-cdn.alpinelinux.org/alpine/edge/testing/x86_64/APKINDEX.tar.gz | Fast, async, resource-friendly link checker written in Rust (documentation) | https://lychee.cli.rs - pacman - lychee - 0.24.2-1: normalized package name match | Arch Linux sync databases: lychee from https://geo.mirror.pkgbuild.com/extra/os/x86_64/extra.db.tar.gz | Fast, async, resource-friendly link checker written in Rust | https://lychee.cli.rs - zypper - lychee - 0.24.2-1.1: normalized package name match | openSUSE Tumbleweed package metadata: lychee from https://download.opensuse.org/tumbleweed/repo/oss/repodata/be8d3611d25469107f32075a1697e69ec57a2b850b42348a658cc671ad5ec2b50760d02c3e59524d50da9a11d5be799bdaffba2e166e8ca8858512e3c0bd665d-primary.xml.zst | Fast, async, stream-based link checker written in Rust | https://lychee.cli.rs - MacPorts - lychee: normalized package name match | MacPorts ports tree: devel/lychee/Portfile from https://api.github.com/repos/macports/macports-ports/git/trees/master?recursive=1 - Scoop - main/lychee: normalized package name match | Scoop official bucket manifest trees: bucket/lychee.json from https://api.github.com/repos/ScoopInstaller/Main/git/trees/master?recursive=1 - winget - lycheeverse.lychee: normalized package name match | Windows Package Manager source index: lycheeverse.lychee from https://cdn.winget.microsoft.com/cache/source.msix ## Related links - [Terminal utility packages](https://www.automicvault.com/pkg/terminal-utilities/) - Matched terminal and command-line workflow metadata. - [Text processing packages](https://www.automicvault.com/pkg/text-processing-tools/) - Matched text, document, or structured-data processing metadata. - [Developer build packages](https://www.automicvault.com/pkg/developer-build-tools/) - Matched build, compiler, generator, or developer workflow metadata. - [Language runtime packages](https://www.automicvault.com/pkg/language-runtime-packages/) - Matched language runtime, compiler, or interpreter metadata. - [pkgconf](https://www.automicvault.com/pkg/brew/pkgconf/) - Build dependency declared by Homebrew. - [rust](https://www.automicvault.com/pkg/brew/rust/) - Build dependency declared by Homebrew. - [dotenv-linter](https://www.automicvault.com/pkg/brew/dotenv-linter/) - Shares av.db curated category or tags: cli, developer-tools, quality-assurance, rust. - [cargo-llvm-cov](https://www.automicvault.com/pkg/brew/cargo-llvm-cov/) - Shares av.db curated category or tags: ci, cli, developer-tools, rust. - [cargo-nextest](https://www.automicvault.com/pkg/brew/cargo-nextest/) - Shares av.db curated category or tags: ci, cli, developer-tools, rust. - [deadfinder](https://www.automicvault.com/pkg/brew/deadfinder/) - Shares av.db curated category or tags: broken-links, cli, developer-tools, link-checker. - [mlc](https://www.automicvault.com/pkg/brew/mlc/) - Shares av.db curated category or tags: ci, cli, developer-tools, link-checker. - [action-validator](https://www.automicvault.com/pkg/brew/action-validator/) - Shares av.db curated category or tags: cli, developer-tools, rust. - [actionlint](https://www.automicvault.com/pkg/brew/actionlint/) - Shares av.db curated category or tags: ci, cli, developer-tools. - [actions-up](https://www.automicvault.com/pkg/brew/actions-up/) - Shares av.db curated category or tags: ci, cli, developer-tools. ## Combined YAML source View the package source record on GitHub. [combined/lychee.yml](https://github.com/automic-vault/db/blob/main/combined/lychee.yml) ## Sources - Nucleus package database - Geiger risk classifier - package-page enrichment - curated configuration and credential file locations - curated package history - package version freshness - av.db category and tag curation - package relationship graph - external package-manager database matches - cross-ecosystem install command graph