# tealdeer

> Fast Rust implementation of tldr providing simplified, example-based manual pages for command-line tools

Stars: 6.6k · Language: Rust · License: MIT · Categories: Dev Tools

- Repository: https://github.com/dbrgn/tealdeer
- Website: https://docs.tealdeer.org
- Page: https://www.trmn.sh/tools/tealdeer

## Install

- Cargo: `cargo install tealdeer`

## Overview

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

```bash
# via Cargo
cargo install tealdeer
```

![Tealdeer logo](https://media.trmn.sh/cached/11b5fb12c58ff217a0cc501a19c4991657a183f1abf6d8f0962f879265961796.png)

## Alternatives

- [pastel](https://www.trmn.sh/tools/pastel.md): Command-line tool to generate, analyze, convert and manipulate colors across multiple formats and color spaces (Rust, 6.5k stars)
- [jscpd](https://www.trmn.sh/tools/jscpd.md): Copy/paste detector for 224 source formats with a Rust engine. Also reports dead code, complexity, git-history duplication trends, and a health score. (Rust, 6.5k stars)
- [zizmor](https://www.trmn.sh/tools/zizmor.md): Static analysis tool that finds and fixes security issues in CI/CD configurations, including GitHub Actions workflows, Dependabot, and pre-commit. (Rust, 6.9k stars)
- [watchexec](https://www.trmn.sh/tools/watchexec.md): File watcher that runs commands when files change, with .gitignore support and cross-platform filesystem monitoring (Rust, 7.3k stars)
- [sd](https://www.trmn.sh/tools/sd.md): Find and replace CLI tool with regex support, string-literal mode, and faster performance than sed (Rust, 7.4k stars)

## Guides

- [Modern Replacements for man](https://www.trmn.sh/replace/man): Replace man with tldr, tealdeer or eg: example-first command help instead of full manuals. Compare clients, offline use and customization.

---

Canonical: https://www.trmn.sh/tools/tealdeer