Get Instant Command Cheatsheets in Your Terminal

// Before you start

What you need

A terminal / command prompt open
Internet connection for install and first use
One of: Python (pipx), Rust (Cargo or Homebrew), Node.js (npm), or Windows (winget) — at least one is usually already present

Step 1 of 5

Pick your install method and run it

2 min

tldr has official clients for Python, Rust, and Node.js, plus a Windows-native option. Pick the one line that matches what you already have. You only need one. The Python (pipx) route is the most reliable across all platforms if you are unsure.

Terminal · mac

$ # Python (recommended — works on Mac, Linux, Windows)

$ pipx install tldr

$ # Mac or Linux with Homebrew

$ brew install tlrc

$ # Windows with winget

$ winget install tldr-pages.tlrc

$ # Node.js (any platform)

$ npm install -g tldr

What you should see

A success message ending with something like 'installed package tldr' or 'Successfully installed tlrc'. No errors in red.

This might happen

pipx: command not found

Install pipx first with: pip install --user pipx then run: pipx ensurepath and restart your terminal.

Step 2 of 5

Look up your first command

1 min

Type tldr followed by any command name you want help with. You will see a short description and several real-world examples — far easier to scan than a man page. Try tar as a classic example.

Terminal · mac

$ tldr tar

What you should see

A short description of tar followed by 5-8 practical examples, each with a one-line explanation and the exact flags to use.

This might happen

First run says 'updating cache' and takes a moment

This is normal. tldr downloads its page database on first use. Wait 10-20 seconds and it will display the result.

Step 3 of 5

Try a few more commands to build the habit

2 min

The real value of tldr is speed — you stop guessing flags. Run these to see pages for common commands you will actually use. Each page shows only the most practical examples.

Terminal · mac

$ tldr git

$ tldr curl

$ tldr find

$ tldr ssh

What you should see

A clean, readable cheatsheet for each command with copy-paste-ready examples.

Step 4 of 5

Update the local page cache

1 min

The tldr community adds and improves pages regularly. Run this every few weeks to pull the latest cheatsheets to your machine.

Terminal · mac

$ # Python client

$ tldr --update

$ # Rust client (tlrc)

$ tldr --update

$ # Node.js client

$ tldr --update

What you should see

A message like 'Successfully updated local database' or similar. Takes under 30 seconds.

This might happen

Update fails with a network or permission error

Check your internet connection. If using the Node.js client, try: sudo tldr --update on Mac/Linux.

Step 5 of 5

Search for a page if you forget the exact command name

1 min

Not sure of the exact command name? Use the search flag to find relevant pages by keyword. This works with the Python and Rust clients.

Terminal · mac

$ # Python client

$ tldr --search "compress files"

$ # Rust client

$ tldr --list | grep zip

What you should see

A list of matching command names you can then look up individually with tldr <command>.

// Status

cooked. baked. worked.

A working tldr command in your terminal that gives you instant, readable cheatsheets for hundreds of common CLI tools — no internet browser needed.

// the honest bit

The honest part

tldr only covers commands that community members have written pages for. Obscure or very new tools may return 'page not found'. It is a complement to man pages, not a full replacement — for deep flag details you still need man. The Node.js client has fallen behind in updates per the official README, so prefer the Python or Rust client for the best experience.