# tealdeer-rs/tealdeer

A very fast implementation of tldr in Rust.

Repository: https://github.com/tealdeer-rs/tealdeer
Canonical: https://ross.abutalabs.com/products/tealdeer
Homepage: https://docs.tealdeer.org
Language: Rust
License: Apache-2.0
License Family: permissive
Topics: tldr, rust, hacktoberfest
Last push: 2026-08-25T22:10:38+00:00

## Health v2 (maintenance only)
Score: 95/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 99, release rhythm 87, longevity 100
- inputs: {"age_days": 3900, "days_push": 8, "days_rel": 9, "gap_med": 58.5, "n_releases_24m": 9}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 6465, forks 162 (observed 2026-08-28T04:09:43.616408+00:00)

## What it is
Tealdeer is a very fast Rust implementation of the tldr client, showing simplified, example-based community man pages for CLI commands. It caches pages locally so it works fully offline except for cache updates.

## Use cases
- show usage examples for a cli command quickly
- offline alternative to man pages
- look up command flags without reading full man page
- cache tldr pages locally
- faster tldr client

## When to choose
- you want the fastest tldr client with offline caching
- you prefer example-based help over verbose man pages
- you need a cross-platform static binary

## When to avoid
- you need full detailed man page documentation
- you need a client for a non-tldr help format

## Facets
- artifact type: cli-tool
- maturity: active
- function: cli, documentation, developer-tools
- domain: developer-tools, documentation
- platform: windows, rust, cli, cross-platform
- tags: tldr, man-pages, offline-caching, command-examples, command-line, linux, macos

## Member repositories
- tealdeer-rs/tealdeer (main) score 95

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:09:43.616408+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-29T17:44:36.894167+00:00, confidence not recorded.
  - readme: https://github.com/tealdeer-rs/tealdeer (fetched 2026-08-28T04:09:43.616408+00:00, sha 4275944eae4e)
  - registry_crates: https://crates.io/api/v1/crates/tealdeer (fetched 2026-08-29T08:41:43.113264+00:00, sha d097a89667af)
- Data as of 2026-08-30T08:39:29.467469+00:00.