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
• 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

(Note: You might need to install OpenSSL development headers, otherwise you get a "failed to run custom build command for openssl-sys" error message. The package is called libssl-dev on Ubuntu.)

Build From Source

Debug build with logging enabled:

$ cargo build --features logging

Release build without logging:

$ cargo build --release

To enable the log output, set the RUST_LOG env variable:

$ export RUST_LOG=tldr=debug

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