macOS
Homebrewverified · 100%
brew install tealdeerprovider-native install command
brew / rank 878
Install tealdeer with Homebrew
Very fast implementation of tldr in Rust. Version 1.8.1 via Homebrew; verified from local package data.
install
Additional install commands
overview
Package summary
Very fast implementation of tldr in Rust
Project links
Commands and aliases
- tldr
history
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
- https://github.com/tealdeer-rs/tealdeer
- https://raw.githubusercontent.com/tealdeer-rs/tealdeer/main/README.md
- https://tealdeer-rs.github.io/tealdeer/
- https://tealdeer-rs.github.io/tealdeer/config.html
- https://tealdeer-rs.github.io/tealdeer/installing.html
- https://tealdeer-rs.github.io/tealdeer/usage.html
- source_facts.package-manager
security posture
Risk level: green
narrow executable package without higher-risk signals.
Risk classifier
green risk · low confidence · appliance
Why
- narrow executable package without higher-risk signals
Signals
- metadata:no-higher-risk-signals
Install behavior
- No Homebrew bottle metadata was recorded.
Recommended review
Before unattended agent use, check whether the tool reads plaintext credentials, writes remote state, publishes artifacts, or shells out to plugins.
local files
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
Config paths the tool may read or write during local use.
- Linux
$XDG_CONFIG_HOME/tealdeer/config.toml~/.config/tealdeer/config.toml
executables
Installed executables
| Command | Kind | Exposure | Note |
|---|---|---|---|
tldr | executable | indexed executable | Discovered from the local executable index. |
freshness
Version and 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.
page generated2026-08-03
manager version1.8.1
manager updated
local dataunknown
upstreamnot available
latest detectednot detected
- okNo freshness warnings were generated.
install metadata
Package metadata
| Package key | brew:tealdeer |
|---|---|
| Version | 1.8.1 |
| Package manager | Homebrew |
| Homepage | https://tealdeer-rs.github.io/tealdeer/ |
| Repository | https://github.com/tealdeer-rs/tealdeer |
| Bottle | not recorded |
| Service | none declared |
source trail
Generated from repository data
This page is generated by av-web from the private package SQLite artifact built by scripts/generate-pkg-sqlite.py.
Combined YAML source
View the package source record on GitHub.
Used sources
- Geiger risk classifier
- Nucleus package database
- curated configuration and credential file locations
- curated package history
- pkgdb category and tag curation