tldr

Python command-line client for tldr pages

TLDR

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

$ tldr [command]
copy


Show the tldr page for cd, overriding the default platform
$ tldr -p [android|linux|osx|sunos|windows] [cd]
copy


Show the tldr page for a subcommand
$ tldr [git-checkout]
copy


Update local pages (if the client supports caching)
$ tldr -u
copy

POSITIONAL ARGUMENTS

command to lookup

OPTIONS

-v, --version

show program's version number and exit

--search

Search for a specific command from a query

-u, --update_cache

Update the local cache of pages and exit

Default: False

-p, --platform

Possible choices: linux, osx, sunos, windows, common

Override the operating system [linux, 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/master/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

COPYRIGHT

2022, Felix Yan

AUTHOR

Felix Yan

Copied to clipboard