Skip to content

tlrc (tldr)

Man pages replaced by six examples of what people actually type.

Homebrew formula

What it does

tldr shows a short, community-maintained page of practical examples for a command instead of its full manual. tlrc is the official Rust client: it caches the pages locally, so lookups are instant and work offline.

tldr tar
tldr --update          # refresh the cache
tldr --platform osx dd # platform-specific page

Notes

Pages come from the tldr-pages repository. It complements man rather than replacing it — tldr for “how do I invoke this”, man for what a flag actually means.

Alternative to

AlternativeTypeTrade-off
tealdeerOpen sourceThe other Rust tldr client, and the more widely installed one
tldr (the Node client)Open sourceThe reference implementation
cheat.shFreecurl cheat.sh/tar, no install at all
naviOpen sourceInteractive cheat sheets you can execute rather than read
manBuilt inComplete, authoritative, and no help whatsoever when you are in a hurry

Install

brew install tlrc

Links

This post is licensed under CC BY 4.0 by the author.
Last updated on