# Install tealdeer with Homebrew, apk, apt, MacPorts, Nix, pacman, zypper, scoop, winget, dnf
Very fast implementation of tldr in Rust. Version 1.8.1 via Homebrew; verified from local package data. Also installable with debian: sudo apt install tealdeer.
## Install
```sh
sudo av install brew:tealdeer
```
Additional install commands:
### macOS
- Homebrew (100%):
```sh
brew install tealdeer
```
Evidence: local Homebrew formula metadata
- MacPorts (94%):
```sh
sudo port install tealdeer
```
Evidence: MacPorts ports tree: sysutils/tealdeer/Portfile from https://api.github.com/repos/macports/macports-ports/git/trees/master?recursive=1
### Linux
- apk (92%):
```sh
sudo apk add tealdeer
```
Evidence: Alpine Linux edge package indexes: tealdeer from https://dl-cdn.alpinelinux.org/alpine/edge/testing/x86_64/APKINDEX.tar.gz
- Debian apt (92%):
```sh
sudo apt install tealdeer
```
Evidence: Debian stable package indexes: tealdeer from https://deb.debian.org/debian/dists/stable/main/binary-amd64/Packages.xz
- Nix (92%):
```sh
nix profile install nixpkgs#tealdeer
```
Evidence: nixpkgs package indexes: pkgs/by-name/te/tealdeer/package.nix from https://api.github.com/repos/NixOS/nixpkgs/git/trees/master?recursive=1
- pacman (92%):
```sh
sudo pacman -S tealdeer
```
Evidence: Arch Linux sync databases: tealdeer from https://geo.mirror.pkgbuild.com/extra/os/x86_64/extra.db.tar.gz
- zypper (92%):
```sh
sudo zypper install tealdeer
```
Evidence: openSUSE Tumbleweed package metadata: tealdeer from https://download.opensuse.org/tumbleweed/repo/oss/repodata/50b07339cb64c8ed4091bdbabddadc1ff5737b090e478818a195b40d8a3292861a879139b4a3987c31109699fde9fbf4a716367ddf4eef77da75f96e3193d6ed-primary.xml.zst
- dnf (92%):
```sh
sudo dnf install tldr
```
Evidence: Fedora Rawhide package metadata: tldr from https://dl.fedoraproject.org/pub/fedora/linux/development/rawhide/Everything/x86_64/os/repodata/07190dc5ae9f35ae73866675fed6d95fe6e8d9fe22c9d7cdf85862cb2ed24a4c-primary.xml.zst
### Windows
- Scoop (92%):
```sh
scoop install main/tealdeer
```
Evidence: Scoop official bucket manifest trees: bucket/tealdeer.json from https://api.github.com/repos/ScoopInstaller/Main/git/trees/master?recursive=1
- winget (92%):
```sh
winget install --id dbrgn.tealdeer -e
```
Evidence: Windows Package Manager source index: dbrgn.tealdeer from https://cdn.winget.microsoft.com/cache/source.msix
## Package facts
- **Package key:** brew:tealdeer
- **Package manager:** Homebrew
- **Version:** 1.8.1
- **Source summary:** Very fast implementation of tldr in Rust
- **Homepage:**
- **Repository:**
- **Generated:** 2026-08-03T19:37:03+00:00
## Executables
- tldr (alias)
## Install behavior
- Bottle: not available
## Freshness
- Page generated: 2026-08-03
- Package-manager version: 1.8.1
## Project history and usage
tealdeer is a Rust implementation of the TLDR client idea: simplified, example-based, community-maintained command help pages exposed through a fast `tldr` command. Its name is a pronunciation joke on "tldr".
### Project history
The official README frames tealdeer as a fast TLDR client written in Rust, with goals including cache download, offline use after cache update, compatibility with the NodeJS TLDR client, compliance with the TLDR client specification, configurable highlighting, and speed.
The project maintains an mdBook user manual covering installation, usage, custom pages, configuration, and tips. Its usage documentation shows the installed binary is named `tldr`, aligning it with the broader TLDR client ecosystem rather than exposing a separate end-user command name.
### Adoption history
The official installation manual lists packages for Arch Linux, Debian, Fedora, FreeBSD, Funtoo, Homebrew, MacPorts, NetBSD, Nix, openSUSE, Scoop, Solus, and Void Linux, along with static binaries, Cargo installation, and source builds. The supplied package-manager facts also show broad packaging across Homebrew, Debian/Ubuntu, Fedora, MacPorts, Nix, pacman, Scoop, winget, and openSUSE.
### How it is used
tealdeer is used as a fast local client for TLDR pages: users update or clear the cache, list cached commands, render pages, choose platform/language preferences, and customize display, style, search, update, and directory behavior through TOML configuration.
### Why package nerds care
tealdeer is significant to package-manager users because it turns command examples into a fast, cacheable CLI experience and is packaged broadly under the familiar `tldr` executable. Its README even benchmarks multiple TLDR clients, placing it in the tradition of package nerds comparing small CLI implementations across languages.
### Timeline
- 2021: README benchmark compares tealdeer against other TLDR clients.
- v0.2.0-v1.8.1: Official git tags show continued release series.
- 1.8.1: User manual usage page documents the current `tldr` command options.
### Related projects
- The README and user manual tie tealdeer to the TLDR Pages project, the TLDR client specification, tldr-node-client, tldr-python-client, tldr-bash, tldr-hs, fast-tldr, and outfieldr.
### Sources
-
-
-
-
-
-
- source_facts.package-manager
## Security Notes
narrow executable package without higher-risk signals.
- **Geiger risk:** green / low
- narrow executable package without higher-risk signals
## 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
- Linux: $XDG_CONFIG_HOME/tealdeer/config.toml, ~/.config/tealdeer/config.toml
## Other Package-Manager Records
- Debian apt - tealdeer - 1.7.2-1+deb13u1: normalized package name match | Debian stable package indexes: tealdeer from https://deb.debian.org/debian/dists/stable/main/binary-amd64/Packages.xz | simplified, example based and community-driven man pages | https://github.com/tealdeer-rs/tealdeer/
- Nix - tealdeer: normalized package name match | nixpkgs package indexes: pkgs/by-name/te/tealdeer/package.nix from https://api.github.com/repos/NixOS/nixpkgs/git/trees/master?recursive=1
- Ubuntu apt - tealdeer - 1.6.1-4build2: normalized package name match | Ubuntu 24.04 LTS package indexes: tealdeer from https://archive.ubuntu.com/ubuntu/dists/noble/universe/binary-amd64/Packages.gz | simplified, example based and community-driven man pages | https://github.com/dbrgn/tealdeer/
- apk - tealdeer - 1.8.0-r0: normalized package name match | Alpine Linux edge package indexes: tealdeer from https://dl-cdn.alpinelinux.org/alpine/edge/testing/x86_64/APKINDEX.tar.gz | Very fast implementation of tldr in Rust | https://tealdeer-rs.github.io/tealdeer/
- apk - tealdeer-bash-completion - 1.8.0-r0: normalized package name match | Alpine Linux edge package indexes: tealdeer-bash-completion from https://dl-cdn.alpinelinux.org/alpine/edge/testing/x86_64/APKINDEX.tar.gz | Bash completions for tealdeer | https://tealdeer-rs.github.io/tealdeer/
- apk - tealdeer-fish-completion - 1.8.0-r0: normalized package name match | Alpine Linux edge package indexes: tealdeer-fish-completion from https://dl-cdn.alpinelinux.org/alpine/edge/testing/x86_64/APKINDEX.tar.gz | Fish completions for tealdeer | https://tealdeer-rs.github.io/tealdeer/
- apk - tealdeer-zsh-completion - 1.8.0-r0: normalized package name match | Alpine Linux edge package indexes: tealdeer-zsh-completion from https://dl-cdn.alpinelinux.org/alpine/edge/testing/x86_64/APKINDEX.tar.gz | Zsh completions for tealdeer | https://tealdeer-rs.github.io/tealdeer/
- pacman - tealdeer - 1.8.1-2: normalized package name match | Arch Linux sync databases: tealdeer from https://geo.mirror.pkgbuild.com/extra/os/x86_64/extra.db.tar.gz | A fast tldr client in Rust | https://github.com/tealdeer-rs/tealdeer
- zypper - tealdeer - 1.8.0-1.5: normalized package name match | openSUSE Tumbleweed package metadata: tealdeer from https://download.opensuse.org/tumbleweed/repo/oss/repodata/50b07339cb64c8ed4091bdbabddadc1ff5737b090e478818a195b40d8a3292861a879139b4a3987c31109699fde9fbf4a716367ddf4eef77da75f96e3193d6ed-primary.xml.zst | An implementation of tldr in Rust | https://github.com/tealdeer-rs/tealdeer
- zypper - tealdeer-bash-completion - 1.8.0-1.5: normalized package name match | openSUSE Tumbleweed package metadata: tealdeer-bash-completion from https://download.opensuse.org/tumbleweed/repo/oss/repodata/50b07339cb64c8ed4091bdbabddadc1ff5737b090e478818a195b40d8a3292861a879139b4a3987c31109699fde9fbf4a716367ddf4eef77da75f96e3193d6ed-primary.xml.zst | Bash Completion for tealdeer | https://github.com/tealdeer-rs/tealdeer
- zypper - tealdeer-fish-completion - 1.8.0-1.5: normalized package name match | openSUSE Tumbleweed package metadata: tealdeer-fish-completion from https://download.opensuse.org/tumbleweed/repo/oss/repodata/50b07339cb64c8ed4091bdbabddadc1ff5737b090e478818a195b40d8a3292861a879139b4a3987c31109699fde9fbf4a716367ddf4eef77da75f96e3193d6ed-primary.xml.zst | Fish Completion for tealdeer | https://github.com/tealdeer-rs/tealdeer
- zypper - tealdeer-zsh-completion - 1.8.0-1.5: normalized package name match | openSUSE Tumbleweed package metadata: tealdeer-zsh-completion from https://download.opensuse.org/tumbleweed/repo/oss/repodata/50b07339cb64c8ed4091bdbabddadc1ff5737b090e478818a195b40d8a3292861a879139b4a3987c31109699fde9fbf4a716367ddf4eef77da75f96e3193d6ed-primary.xml.zst | Zsh Completion for tealdeer | https://github.com/tealdeer-rs/tealdeer
- MacPorts - tealdeer: normalized package name match | MacPorts ports tree: sysutils/tealdeer/Portfile from https://api.github.com/repos/macports/macports-ports/git/trees/master?recursive=1
- Scoop - main/tealdeer: normalized package name match | Scoop official bucket manifest trees: bucket/tealdeer.json from https://api.github.com/repos/ScoopInstaller/Main/git/trees/master?recursive=1
- winget - dbrgn.tealdeer: normalized package name match | Windows Package Manager source index: dbrgn.tealdeer from https://cdn.winget.microsoft.com/cache/source.msix
- Nix - tldr: installed executable or alias match | nixpkgs package indexes: pkgs/by-name/tl/tldr/package.nix from https://api.github.com/repos/NixOS/nixpkgs/git/trees/master?recursive=1
## Combined YAML source
View the package source record on GitHub. [combined/tealdeer.yml](https://github.com/mxcl/pkgdb/blob/main/combined/tealdeer.yml)
## Sources
- pkg.so package database
- Geiger risk classifier
- curated configuration and credential file locations
- curated package history
- pkgdb category and tag curation
- external package-manager database matches
- cross-ecosystem install command graph