hereink

How to install tldr pages: update cache, read examples, vs man pages

Install tldr, refresh the cache, read examples, and know when man wins.

man pages are complete but slow to scan when you only need a copy-paste example. The tldr pages project collects community-maintained cheatsheets; clients expose the tldr command. This guide covers install on macOS/Linux/Windows, refresh caches with tldr --update, read simplified examples, and when to still use man or --help for hereink readers who live in the terminal.

The query is how to install tldr pages update cache and read command examples. You should finish with tldr on PATH, an updated local cache, commands like tldr git working, and a clear split between tldr and man.

installbrew · npm · cargo
cachetldr --update
comparetldr vs man
install client--updateread examples

What tldr fixes

Examples first

tldr tar shows common archive commands in a few lines; man tar is the full manual. Best when you know the tool name but not the flags.

Beside rg and bat

After tldr kubectl, paste into scripts and debug with ripgrep or HTTPie from our other guides. tldr does not replace deep flag documentation.

Page source: github.com/tldr-pages/tldr, site tldr.sh. Popular Rust client tealdeer (binary tldr); Node and Python clients also ship a tldr command.

Install a tldr client

  1. 1
    macOS (Homebrew, tealdeer)

    brew install tealdeer. Verify with which tldr and tldr --version. Pick one client—avoid two different tldr binaries fighting on PATH.

  2. 2
    Linux

    Arch: pacman -S tealdeer. Others: distro packages or cargo install tealdeer. Alternative: npm install -g tldr. See Clients on tldr.sh.

  3. 3
    Windows

    scoop install tealdeer or choco install tealdeer; or npm install -g tldr. New terminal, then tldr --version.

  4. 4
    First fetch

    Many clients download pages on first query; you can also run tldr --update up front. Configure HTTP_PROXY if needed.

Update the cache with tldr --update

tldr --update
tldr --list
tldr --info

Pages merge daily on GitHub. If update fails, check network, disk permissions, and GitHub reachability. Do not install unofficial page bundles.

Read simplified examples

tldr tar
tldr git commit
tldr --platform linux curl
tldr --list | head
tldr -s archive

Each block is a short description plus a command line. Replace placeholders like path/to/file before running against production systems.

tldr vs man / --help

Goaltldrman / --help
Common recipestldr ffmpegman is long; --help is often flags-only
Full options & defaultsUsually omittedman 1 tar, tool --help
SubcommandsOften separate pagesOne long man page
OfflineAfter cache updateDepends on man-db
ContributePR to tldr-pagesUpstream docs
Fits
Forgotten flags, README examples, unfamiliar servers, alongside gh, jq, and ripgrep.
Does not fit
Security-sensitive tools where every flag matters—read official man pages first.
tldr vs cheat?

cheat is for personal or team sheets; tldr pages are a shared, formatted corpus. Both can coexist.

Page not found?

Run tldr --update. Still missing means no page yet—use man or search github.com/tldr-pages/tldr, or contribute a page.

tealdeer or npm tldr?

tealdeer is fast and common on macOS/Linux. npm client fits Node-heavy setups. Keep one tldr first on PATH.

After the commands, sketch on one board

Deploy steps and service edges still belong on a shared canvas. See how to create a space.

Start a room