# Install tealdeer with Homebrew, apk, apt, dnf, MacPorts, Nix, pacman, scoop, winget, zypper Very fast implementation of tldr in Rust. Version 1.8.1 via Homebrew; verified from local package data. ## 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 - dnf (92%): ```sh sudo dnf install tealdeer ``` Evidence: Fedora Rawhide package metadata: tealdeer from https://dl.fedoraproject.org/pub/fedora/linux/development/rawhide/Everything/x86_64/os/repodata/e5ca8ce900cd68f5419e1c39ae517343100b306336cbaeb70a3c153121d95094-primary.xml.zst - 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/be8d3611d25469107f32075a1697e69ec57a2b850b42348a658cc671ad5ec2b50760d02c3e59524d50da9a11d5be799bdaffba2e166e8ca8858512e3c0bd665d-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 - **Package manager page:** - **Version:** 1.8.1 - **Source summary:** Very fast implementation of tldr in Rust - **Homepage:** - **Repository:** - **Upstream docs:** - **License:** Apache-2.0 OR MIT - **Source archive:** - **Generated:** 2026-07-08T07:18:31+00:00 ## Executables - tldr (cli) - tldr (alias) ## Build dependencies - rust ## Install behavior - Post-install hook: not defined - Bottle: available on arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, sonoma, x86_64_linux ## Freshness - Page generated: 2026-07-08 - Package-manager version: 1.8.1 - Local data: ok - Upstream repository: https://github.com/tealdeer-rs/tealdeer - Upstream latest detected: v1.8.1 (current) - info: No package-manager update timestamp was available. ## 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 ## Source Database Details - **Source Database:** Homebrew formula API - **Tap:** homebrew/core - **Full Name:** tealdeer - **Version Scheme:** 0 - **Revision:** 0 - **Head Version:** HEAD - **Conflicts With:** tldr, tlrc - **Bottle Stable Root URL:** - **Deprecated:** no - **Disabled:** no - **Keg Only:** no - **URL Keys:** head, stable ## 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/ - dnf - tealdeer - 1.7.3-2.fc45: normalized package name match | Fedora Rawhide package metadata: tealdeer from https://dl.fedoraproject.org/pub/fedora/linux/development/rawhide/Everything/x86_64/os/repodata/e5ca8ce900cd68f5419e1c39ae517343100b306336cbaeb70a3c153121d95094-primary.xml.zst | Fetch and show tldr help pages for many CLI commands | https://crates.io/crates/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.3: normalized package name match | openSUSE Tumbleweed package metadata: tealdeer from https://download.opensuse.org/tumbleweed/repo/oss/repodata/be8d3611d25469107f32075a1697e69ec57a2b850b42348a658cc671ad5ec2b50760d02c3e59524d50da9a11d5be799bdaffba2e166e8ca8858512e3c0bd665d-primary.xml.zst | An implementation of tldr in Rust | https://github.com/tealdeer-rs/tealdeer - zypper - tealdeer-bash-completion - 1.8.0-1.3: normalized package name match | openSUSE Tumbleweed package metadata: tealdeer-bash-completion from https://download.opensuse.org/tumbleweed/repo/oss/repodata/be8d3611d25469107f32075a1697e69ec57a2b850b42348a658cc671ad5ec2b50760d02c3e59524d50da9a11d5be799bdaffba2e166e8ca8858512e3c0bd665d-primary.xml.zst | Bash Completion for tealdeer | https://github.com/tealdeer-rs/tealdeer - zypper - tealdeer-fish-completion - 1.8.0-1.3: normalized package name match | openSUSE Tumbleweed package metadata: tealdeer-fish-completion from https://download.opensuse.org/tumbleweed/repo/oss/repodata/be8d3611d25469107f32075a1697e69ec57a2b850b42348a658cc671ad5ec2b50760d02c3e59524d50da9a11d5be799bdaffba2e166e8ca8858512e3c0bd665d-primary.xml.zst | Fish Completion for tealdeer | https://github.com/tealdeer-rs/tealdeer - zypper - tealdeer-zsh-completion - 1.8.0-1.3: normalized package name match | openSUSE Tumbleweed package metadata: tealdeer-zsh-completion from https://download.opensuse.org/tumbleweed/repo/oss/repodata/be8d3611d25469107f32075a1697e69ec57a2b850b42348a658cc671ad5ec2b50760d02c3e59524d50da9a11d5be799bdaffba2e166e8ca8858512e3c0bd665d-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 ## Related links - [Source-control packages](https://www.automicvault.com/pkg/source-control-tools/) - Belongs to a source-control command family. - [Terminal utility packages](https://www.automicvault.com/pkg/terminal-utilities/) - Matched terminal and command-line workflow metadata. - [Text processing packages](https://www.automicvault.com/pkg/text-processing-tools/) - Matched text, document, or structured-data processing metadata. - [Developer build packages](https://www.automicvault.com/pkg/developer-build-tools/) - Matched build, compiler, generator, or developer workflow metadata. - [rust](https://www.automicvault.com/pkg/brew/rust/) - Build dependency declared by Homebrew. - [halp](https://www.automicvault.com/pkg/brew/halp/) - Shares av.db curated category or tags: cli, developer-tools, rust, terminal. - [chalk-cli](https://www.automicvault.com/pkg/brew/chalk-cli/) - Shares av.db curated category or tags: cli, developer-tools, terminal. - [chars](https://www.automicvault.com/pkg/brew/chars/) - Shares av.db curated category or tags: cli, developer-tools, terminal. - [chatblade](https://www.automicvault.com/pkg/brew/chatblade/) - Shares av.db curated category or tags: cli, developer-tools, terminal. - [cheat](https://www.automicvault.com/pkg/brew/cheat/) - Shares av.db curated category or tags: cli, developer-tools, documentation. - [ddgr](https://www.automicvault.com/pkg/brew/ddgr/) - Shares av.db curated category or tags: cli, developer-tools, terminal. - [figlet](https://www.automicvault.com/pkg/brew/figlet/) - Shares av.db curated category or tags: cli, developer-tools, terminal. - [fx](https://www.automicvault.com/pkg/brew/fx/) - Shares av.db curated category or tags: cli, developer-tools, terminal. - [fzy](https://www.automicvault.com/pkg/brew/fzy/) - Local package facts share a topical domain. Shared terms: cli, developer, developer-tools, fast, terminal. - [gitui](https://www.automicvault.com/pkg/brew/gitui/) - Both packages touch the same language runtime or ecosystem. Shared terms: cli, developer, developer-tools, fast, rust. ## Combined YAML source View the package source record on GitHub. [combined/tealdeer.yml](https://github.com/automic-vault/db/blob/main/combined/tealdeer.yml) ## Sources - Nucleus package database - Geiger risk classifier - package-page enrichment - curated configuration and credential file locations - curated package history - package version freshness - av.db category and tag curation - package relationship graph - external package-manager database matches - cross-ecosystem install command graph