Skip to content
lychee Logo Docs

Installation

Terminal window
pacman -S lychee

Pre-built binaries

We provide binaries for Linux, macOS, and Windows for every release. You can download them from the releases page.

Cargo

Build dependencies

On APT/dpkg-based Linux distros (e.g. Debian, Ubuntu, Linux Mint and Kali Linux) the following commands will install all required build dependencies, including the Rust toolchain and cargo:

Terminal window
curl -sSf '<https://sh.rustup.rs>' | sh
apt install gcc pkg-config libc6-dev libssl-dev

Compile and install lychee

Terminal window
cargo install lychee

Feature flags

Lychee supports several feature flags:

  • native-tls enables the platform-native TLS crate native-tls.
  • vendored-openssl compiles and statically links a copy of OpenSSL. See the corresponding feature of the openssl crate.
  • rustls-tls enables the alternative TLS crate rustls.
  • email-check enables checking email addresses using the check-if-email-exists crate. This feature requires the native-tls feature.
  • check_example_domains allows checking example domains such as example.com. This feature is useful for testing.

By default, native-tls and email-check are enabled.