Tealdeer Fast Rust Implementation of tldr Command-Line Help Pages
Tealdeer is a very fast Rust implementation of the tldr project — simplified, example-based man pages for command-line tools. It provides quick reference with syntax highlighting, offline caching, and configurable output.
Installation
Use the upstream install or setup path that matches your environment:
- Docker container using sharkdp's [hyperfine][hyperfine-gh]
- $ cargo build --features logging
- $ cargo build --release
- $ cargo test
Requirements and caveats from upstream:
- Don't require a network connection for anything besides updating the cache
- Command line interface similar or equivalent to the [NodeJS client][node-gh]
- | [tldr-python-client][python-gh] | Python | 87.0 | 2.4 | |
Basic usage or getting-started notes:
Rust: Simplified, example based and community-driven man pages.
Docs (Installing, Usage, Configuration)
measures the execution times on a cold disk cache. The benchmarking is run in a
Extracted from upstream docs: https://raw.githubusercontent.com/tealdeer-rs/tealdeer/HEAD/README.md