Skip to content

tldr

Agent-readyGit & GitHubDocs / Content

Command examples, cheat sheets, and fast docs from the terminal.

Command examples, cheat sheets, and fast docs from the terminal. Built by tealdeer.

Task fit

command examples, cheat sheets, and fast docs from the terminal.

Lane

Review PRs, triage issues, inspect workflows, and keep repo work agent-safe.

Operator brief

Use tldr for command examples, cheat sheets, and fast docs from the terminal.

Run `tldr tar` and see what comes back.

Repository family

tealdeer

First trust check

tldr responds locally and is ready for the first real command.

Safe first loop

Install, verify, then run one real command.

GitHub review loop

Install command

$ brew install tealdeer

Operator pack

Copy or export the working notes for this CLI before handing it to an agent.

Verify

$ tldr --version

tldr responds locally and is ready for the first real command.

First real command

$ tldr tar

First steps

  1. 01Install tldr.
  2. 02Run `tldr --version` first.
  3. 03Start with `tldr tar`.
  4. 04Install the CLI and make sure it is on your PATH.

When to use / hold off when

Best for

command examples, cheat sheets, and fast docs from the terminal.

Use this when

You work with docs and content and want a fast terminal interface.

Hold off when

You don't work with docs and content.

Trust and constraints

trusted100/100
Install readyTrusted
JSON outputNo
Non-interactiveYes
CI-friendlyNo

Why operators pick it

  • tldr fits git & github well, especially for command examples, cheat sheets, and fast docs from the terminal.
  • 2,130 homebrew installs (30d).
  • Easy to automate.

Constraints

  • Output is mostly plain text.
  • Better for local use than CI.

Repository context

Other CLIs in this family

This is the only CLI surfaced from this family right now.

Facts and links

Install withbrew
Homebrew installs (30d)2.1K
GitHub stars6.1K
LicenseApache-2.0
UpdatedMar 2, 2026