# Tealdeer — Blazing-Fast tldr Client Written in Rust

> A very fast command-line client for the tldr-pages project, providing simplified and community-driven man pages.

## Install

Save as a script file and run:

# Tealdeer — Blazing-Fast tldr Client Written in Rust

## Quick Use
```bash
# Install
cargo install tealdeer
# Or via package managers
brew install tealdeer   # macOS
sudo apt install tealdeer  # Debian/Ubuntu

# Fetch pages and look up a command
tldr --update
tldr tar
```

## Introduction
Tealdeer is a Rust implementation of the tldr-pages client that displays simplified, practical command-line examples for common tools. It fetches community-maintained pages from the tldr-pages project and renders them in the terminal with color-coded output.

## What Tealdeer Does
- Displays concise usage examples for thousands of CLI commands
- Fetches and caches pages from the tldr-pages repository
- Renders output with syntax-highlighted platform-specific examples
- Supports offline usage after the initial page cache download
- Allows custom pages in a local directory for personal or team use

## Self-Hosting & Configuration
- Install via cargo, Homebrew, apt, or download a prebuilt binary
- Run `tldr --update` to download and cache all pages locally
- Custom pages go in `~/.local/share/tealdeer/pages/` (or XDG equivalent)
- Configure colors and display settings in `~/.config/tealdeer/config.toml`
- Pages cache is stored locally; no server component is needed

## Architecture Overview
Tealdeer is a single static Rust binary. On `--update`, it downloads a compressed archive of all tldr-pages and extracts them into a local cache directory. Lookups scan the cache by command name, parse the Markdown page, and render it to the terminal using ANSI color codes.

## Key Features
- Sub-millisecond lookup times thanks to local cache and compiled Rust binary
- Tiny binary size with no runtime dependencies
- Supports Linux, macOS, Windows, and Android (via Termux)
- Platform-aware: shows OS-specific examples when available
- Custom page directories for team-specific or private documentation

## Comparison with Similar Tools
- **tldr (Node.js)** — reference client; Tealdeer is faster with no Node runtime needed
- **man** — comprehensive but verbose; Tealdeer shows practical examples only
- **cheat** — personal cheatsheets; Tealdeer pulls from a shared community repo
- **navi** — interactive cheatsheet browser; Tealdeer is a direct lookup tool
- **eg** — example-based man pages; Tealdeer uses the broader tldr-pages community

## FAQ
**Q: How many commands are covered?**
A: The tldr-pages project covers thousands of commands across Linux, macOS, and Windows.

**Q: Can I add my own pages?**
A: Yes. Place Markdown files in the custom pages directory.

**Q: Does it work offline?**
A: Yes, after running `tldr --update` to cache pages locally.

**Q: How is Tealdeer different from the official tldr client?**
A: Tealdeer is written in Rust for speed and ships as a single static binary with no dependencies.

## Sources
- https://github.com/tealdeer-rs/tealdeer
- https://tealdeer-rs.github.io/tealdeer/

---
Source: https://tokrepo.com/en/workflows/asset-bae84756
Author: Script Depot