tealdeer

tealdeer is a Rust implementation of tldr that provides simplified, example-based documentation for command-line tools. It serves as an alternative to traditional man pages by offering concise, practical examples of how to use common commands. The tool downloads and caches documentation pages locally, allowing offline access after initial setup.

tealdeer complies with the tldr client specification and includes advanced highlighting and configuration options. It supports the same command-line interface as other tldr clients, making it a drop-in replacement. The tool can update its cache of documentation pages when network connectivity is available but operates entirely offline for viewing cached pages.

Benchmarks show tealdeer executing in approximately 13.2ms on average, making it one of the fastest tldr implementations available. It outperforms clients written in Python, Node.js, and C while maintaining feature parity. The tool is particularly useful for developers and system administrators who need quick reference documentation without parsing verbose man pages.

Installation

# via Cargo
cargo install tealdeer