IT for operating businesses
Using the tldr Command
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 information: <https://github.com/tldr-pages/tldr/blob/main/CLIENT-SPECIFICATION.md#command-line-interface>.
- 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:
tldr *[-p|--platform]* *android|cisco-ios|common|dos|freebsd|linux|netbsd|openbsd|osx|sunos|windows* *command*
- Update the local cache of tldr pages:
tldr *[-u|--update]*
- List all pages for the current platform and
common:
tldr *[-l|--list]*
- Print the tldr page for a command and display short options:
tldr --short-options *command*
- Browse tldr pages in a terminal window (
fzfmust be available):
tldr *[-l|--list]* | fzf --preview "tldr {1} --color=always" --preview-window=right,70% | xargs tldr
This content is compiled from the open-source tldr-pages project under the MIT license.