CheatPress

tldr pages Command examples

Version Python client 3.x · source

tldr pages, Postcard, light preview Light · Postcard 102 × 152 mm · PDF tldr pages, Postcard, dark preview Dark · Postcard 102 × 152 mm · PDF tldr pages, Postcard, ink saver preview Ink saver · Postcard 102 × 152 mm · PDF
tldr pages, A5, light preview Light · A5 148 × 210 mm · PDF tldr pages, A5, dark preview Dark · A5 148 × 210 mm · PDF tldr pages, A5, ink saver preview Ink saver · A5 148 × 210 mm · PDF
tldr pages, A4, light preview Light · A4 210 × 297 mm · PDF tldr pages, A4, dark preview Dark · A4 210 × 297 mm · PDF tldr pages, A4, ink saver preview Ink saver · A4 210 × 297 mm · PDF
tldr pages, A4 landscape, light preview Light · A4 landscape 297 × 210 mm · PDF tldr pages, A4 landscape, dark preview Dark · A4 landscape 297 × 210 mm · PDF tldr pages, A4 landscape, ink saver preview Ink saver · A4 landscape 297 × 210 mm · PDF
tldr pages, A3, light preview Light · A3 297 × 420 mm · PDF tldr pages, A3, dark preview Dark · A3 297 × 420 mm · PDF tldr pages, A3, ink saver preview Ink saver · A3 297 × 420 mm · PDF
tldr pages, A3 landscape, light preview Light · A3 landscape 420 × 297 mm · PDF tldr pages, A3 landscape, dark preview Dark · A3 landscape 420 × 297 mm · PDF tldr pages, A3 landscape, ink saver preview Ink saver · A3 landscape 420 × 297 mm · PDF
tldr pages, Letter, light preview Light · Letter 8.5 × 11 in · PDF tldr pages, Letter, dark preview Dark · Letter 8.5 × 11 in · PDF tldr pages, Letter, ink saver preview Ink saver · Letter 8.5 × 11 in · PDF
tldr pages, Tabloid, light preview Light · Tabloid 11 × 17 in · PDF tldr pages, Tabloid, dark preview Dark · Tabloid 11 × 17 in · PDF tldr pages, Tabloid, ink saver preview Ink saver · Tabloid 11 × 17 in · PDF

Start here

tldr <command>
Show examples
tldr --update
Refresh the cache
tldr --list
List known pages
tldr --search "<words>"
Search pages
tldr <command> <sub>
Subcommand page
tldr --platform <os> <command>
Other OS page
tldr --language <code> <command>
Translated page
tldr --render <file>
Preview your page

Concepts

  1. tldr-pages repo markdown pages
  2. Local cache refreshed by --update
  3. Client tldr <command>
  4. Terminal coloured examples

Look up

tldr <command>
Show examples for a command
tldr <command> <subcommand>
Show a subcommand page
Pages are named with a dash, e.g. tldr git commit finds git-commit.
tldr --search "<keywords>"
Find pages matching keywords
tldr --list
List pages for this platform
tldr --markdown <command>
Print the raw page source
tldr --help
Show client options
tldr --version
Show client version

Platform and language

tldr --platform linux <command>
Use the Linux page
tldr --platform osx <command>
Use the macOS page
tldr --platform windows <command>
Use the Windows page
tldr --platform common <command>
Use the cross-platform page
tldr --language <code> <command>
Read a translated page
Falls back to English when no translation exists.
export TLDR_LANGUAGE=<code>
Set the default language
export TLDR_PLATFORM=<os>
Override platform detection

Install and cache

pipx install tldr
Install the Python client
pip install tldr
Install with pip
tldr --update
Download the latest pages
tldr --clear-cache
Delete the local cache
export TLDR_CACHE_MAX_AGE=<hours>
Set how long the cache is valid
Default is 168 hours (one week).
export TLDR_CACHE_ENABLED=0
Fetch online before using the cache
tldr --print-completion bash
Print shell completion script
Also zsh and tcsh; needs the shtab package.

Output

tldr --short-options <command>
Prefer short flags in examples
tldr --long-options <command>
Prefer long flags in examples
tldr --color <command>
Keep colour when piped
export TLDR_OPTIONS=<short|long|both>
Default option style
export TLDR_COLOR_COMMAND=<style>
Restyle the command lines

Writing pages

pages/<platform>/<command>.md
Where a page lives in the repo
Use common/ for commands on two or more platforms; linux, osx, windows, ... otherwise.
{{path/to/file}}
Placeholder syntax in a command
tldr --render <file>.md
Preview a page locally
pages.<locale>/
Folder for translations
Page layout
Part Syntax
Title # command
Summary > Short description.
Link > More information: <url>.
Example - What it does:
Command `cmd {{arg}}`

Recipes

Weekly refresh with a timer
# crontab -e0 9 * * 1 tldr --update
Try a page before submitting
$EDITOR pages/common/<command>.mdtldr --render pages/common/<command>.md
Compare platforms
tldr --platform linux <command>tldr --platform osx <command>
Pick a page with fzf
tldr --list | fzf --preview 'tldr {}'