tldr

all

Display simple help pages for command-line tools from the tldr-pages project. Note: The `--language` and `--list` options are not required by the client specification, but most clients implement them.

More info →

Subcommands (1)

tldr-lint

Lint and format `tldr` pages. Note: `tldrl` can be used as an alias for `tldr-lint`.

→

Options (5)

-L, --languageboolean

Print the tldr page for a command in the given language (if available, otherwise fall back to English)

Example: tldr {{[-L|--language]}} {{language_code}} {{command}}

-p, --platformboolean

Print the tldr page for a command from a specific platform

Example: tldr {{[-p|--platform]}} {{android|cisco-ios|common|dos|freebsd|linux|netbsd|openbsd|osx|sunos|windows}} {{command}}

-u, --updateboolean

Update the local cache of tldr pages

Example: tldr {{[-u|--update]}}

-l, --listboolean

List all pages for the current platform and `common`

Example: tldr {{[-l|--list]}}

-n, --head-countboolean

Print the tldr page for a random command

Example: tldr {{[-l|--list]}} | shuf {{[-n|--head-count]}} 1 | xargs tldr

Examples (8)

Print the tldr page for a specific command (hint: this is how you got here!)

tldr command

Print the tldr page for a specific subcommand

tldr command subcommand

Print the tldr page for a command in the given language (if available, otherwise fall back to English)

tldr [-L|--language] language_code command

Print the tldr page for a command from a specific platform

Update the local cache of tldr pages

tldr [-u|--update]

List all pages for the current platform and `common`

tldr [-l|--list]

Browse tldr pages in a terminal window (`fzf` must be available)

tldr [-l|--list] | fzf --preview "tldr {1} --color=always" --preview-window=right,70% | xargs tldr

Print the tldr page for a random command

tldr [-l|--list] | shuf [-n|--head-count] 1 | xargs tldr

made by @shridhargupta | data from tldr-pages