macOS
brew install tealdeerlocal Homebrew formula metadata
sudo port install tealdeerMacPorts ports tree · sysutils/tealdeer/Portfile · source: api.github.com
brew
Very fast implementation of tldr in Rust. Version 1.8.1 via Homebrew; verified from local package data.
install
brew install tealdeerlocal Homebrew formula metadata
sudo port install tealdeerMacPorts ports tree · sysutils/tealdeer/Portfile · source: api.github.com
sudo apk add tealdeerAlpine Linux edge package indexes · tealdeer · source: dl-cdn.alpinelinux.org
sudo apt install tealdeerDebian stable package indexes · tealdeer · source: deb.debian.org
sudo dnf install tealdeerFedora Rawhide package metadata · tealdeer · source: dl.fedoraproject.org
nix profile install nixpkgs#tealdeernixpkgs package indexes · pkgs/by-name/te/tealdeer/package.nix · source: api.github.com
sudo pacman -S tealdeerArch Linux sync databases · tealdeer · source: geo.mirror.pkgbuild.com
sudo zypper install tealdeeropenSUSE Tumbleweed package metadata · tealdeer · source: download.opensuse.org
scoop install main/tealdeerScoop official bucket manifest trees · bucket/tealdeer.json · source: api.github.com
winget install --id dbrgn.tealdeer -eWindows Package Manager source index · dbrgn.tealdeer · source: cdn.winget.microsoft.com
overview
Very fast implementation of tldr in Rust
history
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".
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.
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.
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.
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.
security posture
narrow executable package without higher-risk signals.
green risk · low confidence · appliance
Before unattended agent use, check whether the tool reads plaintext credentials, writes remote state, publishes artifacts, or shells out to plugins.
local files
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.
Config paths the tool may read or write during local use.
$XDG_CONFIG_HOME/tealdeer/config.toml~/.config/tealdeer/config.tomlexecutables
| Command | Kind | Exposure | Note |
|---|---|---|---|
tldr | cli | global executable |
freshness
These signals separate page generation age, package-manager activity, and upstream release comparison. Version lag is warned only when an evidence URL and comparable versions are present.
https://github.com/tealdeer-rs/tealdeer
install metadata
| Package key | brew:tealdeer |
|---|---|
| Version | 1.8.1 |
| Package manager | Homebrew |
| Package manager page | https://formulae.brew.sh/formula/tealdeer |
| Homepage | https://tealdeer-rs.github.io/tealdeer/ |
| Repository | https://github.com/tealdeer-rs/tealdeer |
| Upstream docs | https://tealdeer-rs.github.io/tealdeer |
| License | Apache-2.0 OR MIT |
| Source archive | https://github.com/tealdeer-rs/tealdeer/archive/refs/tags/v1.8.1.tar.gz |
| Build dependencies | rust |
| Bottle | available (on arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, sonoma, x86_64_linux) |
| Homebrew post-install | not defined |
| Service | none declared |
registry facts
| Source Database | Homebrew formula API |
|---|---|
| Tap | homebrew/core |
| Full Name | tealdeer |
| Version Scheme | 0 |
| Revision | 0 |
| Head Version | HEAD |
| Conflicts With |
|
| Bottle Stable Root URL | https://ghcr.io/v2/homebrew/core |
| Deprecated | no |
| Disabled | no |
| Keg Only | no |
| URL Keys |
|
source database matches
Matches are pulled from external package-manager indexes and kept separate from local Automic Vault package links.
tealdeer 1.7.2-1+deb13u1
simplified, example based and community-driven man pages
https://github.com/tealdeer-rs/tealdeer/
sudo apt install tealdeertealdeer
nix profile install nixpkgs#tealdeertealdeer 1.6.1-4build2
simplified, example based and community-driven man pages
https://github.com/dbrgn/tealdeer/
sudo apt install tealdeertealdeer 1.8.0-r0
Very fast implementation of tldr in Rust
https://tealdeer-rs.github.io/tealdeer/
sudo apk add tealdeertealdeer-bash-completion 1.8.0-r0
Bash completions for tealdeer
https://tealdeer-rs.github.io/tealdeer/
sudo apk add tealdeer-bash-completiontealdeer-fish-completion 1.8.0-r0
Fish completions for tealdeer
https://tealdeer-rs.github.io/tealdeer/
sudo apk add tealdeer-fish-completiontealdeer-zsh-completion 1.8.0-r0
Zsh completions for tealdeer
https://tealdeer-rs.github.io/tealdeer/
sudo apk add tealdeer-zsh-completiontealdeer 1.7.3-2.fc45
Fetch and show tldr help pages for many CLI commands
https://crates.io/crates/tealdeer
sudo dnf install tealdeertealdeer 1.8.1-2
A fast tldr client in Rust
https://github.com/tealdeer-rs/tealdeer
sudo pacman -S tealdeertealdeer 1.8.0-1.3
An implementation of tldr in Rust
https://github.com/tealdeer-rs/tealdeer
sudo zypper install tealdeertealdeer-bash-completion 1.8.0-1.3
Bash Completion for tealdeer
https://github.com/tealdeer-rs/tealdeer
sudo zypper install tealdeer-bash-completiontealdeer-fish-completion 1.8.0-1.3
Fish Completion for tealdeer
https://github.com/tealdeer-rs/tealdeer
sudo zypper install tealdeer-fish-completiontealdeer-zsh-completion 1.8.0-1.3
Zsh Completion for tealdeer
https://github.com/tealdeer-rs/tealdeer
sudo zypper install tealdeer-zsh-completiontealdeer
sudo port install tealdeermain/tealdeer
scoop install main/tealdeerdbrgn.tealdeer
winget install --id dbrgn.tealdeer -esource trail
This page is generated by av-web from the private package SQLite artifact built by scripts/generate-pkg-sqlite.py.
View the package source record on GitHub.