tealdeer

Tealdeer is a Rust implementation of the tldr project, which provides simplified, example-based manual pages 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 tldr pages locally, allowing offline access after the initial download.

The implementation focuses on performance, with benchmark results showing execution times of around 13.2ms on average, making it one of the fastest tldr clients available. It complies with the official tldr client specification while adding advanced highlighting and configuration options. The tool supports the same command-line interface as other tldr clients, making it a drop-in replacement.

Tealdeer targets developers and system administrators who need quick reference documentation for command-line tools. It eliminates the need to parse lengthy man pages when you just need a simple usage example. The tool maintains a local cache of pages that can be updated independently, ensuring fast lookups without requiring network connectivity for everyday use.

Installation

# via Cargo
cargo install tealdeer