Tealdeer is a high-performance CLI tool designed to provide quick access to community-driven documentation and examples for command-line tools. Built using Rust, it offers a fast and efficient way to simplify complex commands through concise, example-based explanations.
Key Features:
Exceptional speed and performance
Offline functionality after initial setup
Cross-platform support
Adherence to the tldr client specification
Audience & Benefit:
Ideal for developers and CLI enthusiasts seeking streamlined access to command-line tool documentation. Tealdeer enhances productivity by delivering clear, actionable examples instantly.
Tealdeer can be installed via winget, ensuring a seamless setup process for users across different platforms.
README
tealdeer
Crate
CI (Linux/macOS/Windows)
A very fast implementation of tldr in
Rust: Simplified, example based and community-driven man pages.
If you pronounce "tldr" in English, it sounds somewhat like "tealdeer". Hence the project name :)
In case you're in a hurry and just want to quickly try tealdeer, you can find static
binaries on the GitHub releases page!
Docs (Installing, Usage, Configuration)
User documentation is available at !
The docs are generated using mdbook.
They can be edited through the markdown files in the docs/src/ directory.
Goals
High level project goals:
Download and cache pages
Don't require a network connection for anything besides updating the cache
Using AI is generally discouraged. However, if it is used as part of a contribution, the contributor MUST:
Clearly mark what parts (if any) of a contribution were created with the help of AI tools. This includes issue and pull request comments.
Check all output of AI tools before sharing it with others in the tealdeer project.
Not post slop, spam, or low quality contributions. This includes pull request descriptions and comments with excessive text and markdown flair.
Leave small or easy tasks to new contributors who want to learn without the use of AI. This is to maintain the presence of the good-first-issue tag.
Be respectful of everyone's time: maintainers and other contributors will be reviewing your PRs.
MSRV (Minimally Supported Rust Version)
When publishing a tealdeer release, the Rust version required to build it
should be stable for at least a month. The current MSRV can always be found in
the rust-version field in Cargo.toml.
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall
be dual licensed as above, without any additional terms or conditions.
Thanks to @severen for coming up with the name "tealdeer"!
