Introduction

lychee is getting more mature and we'd like to share the future v1 with a broader audience.
For that we need an easy way to install the binary.

Package Managers

• cargo install (automatically publish on crates.io with github action) (see Publish releases on crates.io #65)
• Docker Hub (see Publish images to Docker Hub #40 and Add Docker image #40 #52)
• Binary releases on Github
• Github Actions marketplace
• cargo binstall
• AUR (Arch Linux)
• Alpine Linux
• pkg (FreeBSD)
• Homebrew for macOS (Instructions, Github action)
• NixOS
• Termux
• scoop for Windows
• winget (Windows Package manager)
• Chocolatey for Windows (in progress)
• snap/flatpak
• conda
• cargo quickinstall
• apt (Debian/Ubuntu) (see https://bugs.debian.org/993913) ¹
• rpm (Fedora/RedHat)
• emerge (Gentoo)

Preferably, all of our packages should have versions for these CPU architectures:
x86_64, arm and aarch64 (64-bit ARM)

(This list is probably incomplete and should be extended.)

Language Bindings

• NPM (JavaScript bindings using Neon)
• pip (Python Bindings using pyo3)

How to contribute

Please pick one of the above targets and create a pull request.

Inspiration:

• Binary releases on GitHub: https://github.com/BurntSushi/ripgrep/blob/master/.github/workflows/release.yml
• APT package: https://github.com/sharkdp/bat/blob/master/.github/workflows/CICD.yml
• Chocolatey: https://github.com/marketplace/actions/chocolatey-action