Installing

There are a few different ways to install tealdeer:

• Through package managers
• Through static binaries
• Through cargo install
• By building from source

Additionally, when not using system packages, you can manually install autocompletions.

Package Managers

Tealdeer has been added to a few package managers:

• Arch Linux: tealdeer
• Debian: tealdeer
• Fedora: tealdeer
• FreeBSD: sysutils/tealdeer
• Funtoo: app-misc/tealdeer
• Homebrew: tealdeer
• MacPorts: tealdeer
• NetBSD: sysutils/tealdeer
• Nix: tealdeer
• openSUSE: tealdeer
• Scoop: tealdeer
• Solus: tealdeer
• Void Linux: tealdeer

Static Binaries (Linux)

Static binary builds (currently for Linux only) are available on the GitHub releases page. Simply download the binary for your platform and run it!

Through cargo install

Build and install the tool via cargo...

$ cargo install tealdeer

Build From Source

Release build:

$ cargo build --release

Release build with bundled CA roots:

$ cargo build --release --no-default-features --features webpki-roots

Debug build with logging support:

$ cargo build --features logging

(To enable logging at runtime, export the RUST_LOG=tldr=debug env variable.)

Autocompletion

Shell completion scripts are located in the folder completion. Just copy them to their designated location:

• Bash: cp completion/bash_tealdeer /usr/share/bash-completion/completions/tldr
• Fish: cp completion/fish_tealdeer ~/.config/fish/completions/tldr.fish
• Zsh: cp completion/zsh_tealdeer /usr/share/zsh/site-functions/_tldr