tldr - Man Page
Examples (TL;DR)
- 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 [L]anguage (if available, otherwise fall back to English):
tldr --language language_code command
- Print the tldr page for a command from a specific [p]latform:
tldr --platform android|common|freebsd|linux|osx|netbsd|openbsd|sunos|windows command
- [u]pdate the local cache of tldr pages:
tldr --update
- [l]ist all pages for the current platform and
common
:tldr --list
- [l]ist all available subcommand pages for a command:
tldr --list | grep command | column
Name
tldr — tldr 3.3.0
Python command line client for tldr
usage: tldr command [options]
Positional Arguments
- command
command to lookup
Named Arguments
- -v, --version
show program's version number and exit
- --search
Search for a specific command from a query
- -u, --update, --update_cache
Update the local cache of pages and exit
Default: False
- -p, --platform
Possible choices: android, freebsd, linux, netbsd, openbsd, osx, sunos, windows, common
Override the operating system [android, freebsd, linux, netbsd, openbsd, osx, sunos, windows, common]
- -l, --list
List all available commands for operating system
Default: False
- -s, --source
Override the default page source
Default: "https://raw.githubusercontent.com/tldr-pages/tldr/main/pages"
- -c, --color
Override color stripping
- -r, --render
Render local markdown files
Default: False
- -L, --language
Override the default language
- -m, --markdown
Just print the plain page file.
Default: False
- --print-completion
Possible choices: bash, zsh, tcsh
print shell completion script
Author
Felix Yan and tldr-pages contributors
Copyright
2024, Felix Yan and 2014-present, tldr-pages contributors