tealdeer

scriptabledocs / content
$ brew install tealdeer
Summary

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

  • tldr fits git & github well, especially for command examples, cheat sheets, and fast docs from the terminal.
  • 2,142 homebrew installs (30d).
  • Easy to automate.
  • Good fit for coding-agent workflows and repeatable scripts.
  • Output is mostly text-first, so verify results before scripting around it.
github-tealdeer-SKILL.md

Tldr guide

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

Open CLI packages the install path, verify step, and safe-start workflow so this tool can move from “interesting CLI” to something you can actually use. It also integrates with skills.sh so each CLI comes with the right companion skills, not just a binary and a docs link.

When to apply

  • command examples, cheat sheets, and fast docs from the terminal.
  • You work with docs and content and want a fast terminal interface.
  • You need command examples.
  • You need cheat sheets.
  • You need fast docs.

Quick reference

Installbrew install tealdeer
Verifytldr --version
First real commandtldr tar

Open CLI × skills.sh

Open CLI integrates tldr with the right skills.sh companions so you get the tool and the workflow together.

Technical Writing

Recommended pairing

Open CLI recommends this skills.sh skill because it fits docs / content workflows. Document commands, outputs, and workflows in a way other people can reuse.

View on skills.sh
$ npx skills add https://github.com/supercent-io/skills-template --skill technical-writing
Starter prompt

Use tldr together with the Technical Writing skills.sh skill. Start with safe inspection commands, summarize what you find, and ask before any step with side effects.

Why this tool

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

Watch-outs

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

Example workflow

1. tldr tar

Safe start

Step 1

Install tldr.

Step 2

Run `tldr --version` first.

Step 3

Start with `tldr tar`.

Step 4

Install the CLI and make sure it is on your PATH.

Alternatives worth considering