A Python
command line client for tldr.
pip install tldr
sudo pacman -S tldr
sudo dnf install tldr
usage: tldr [-u] [-p PLATFORM] [-s SOURCE] [-c] [-r] [-L LANGUAGE] command
Python command line client for tldr
optional arguments:
-h, --help show this help message and exit
-v, --version show program's version number and exit
-u, --update_cache Update the local cache of pages and exit
-p PLATFORM, --platform PLATFORM
Override the operating system [linux, osx, sunos,
windows, common]
-s SOURCE, --source SOURCE
Override the default page source
-c, --color Override color stripping
-r, --render Render local markdown files
-L LANGUAGE, --language LANGUAGE
Override the default language
You can configure the behavior and output of the tldr
client by setting environment variables. For example, in the .bashrc
file:
export TLDR_COLOR_NAME="cyan"
export TLDR_COLOR_DESCRIPTION="white"
export TLDR_COLOR_EXAMPLE="green"
export TLDR_COLOR_COMMAND="red"
export TLDR_COLOR_PARAMETER="white"
export TLDR_CACHE_ENABLED=1
export TLDR_CACHE_MAX_AGE=720
export TLDR_PAGES_SOURCE_LOCATION="https://raw.githubusercontent.com/tldr-pages/tldr/master/pages"
export TLDR_DOWNLOAD_CACHE_LOCATION="https://tldr-pages.github.io/assets/tldr.zip"
export TLDR_LANGUAGE="en"
Cache is downloaded from TLDR_DOWNLOAD_CACHE_LOCATION
(defaults to the one described in the client specification), unzipped and extracted into the local cache directory. Pages are loaded directly from TLDR_PAGES_SOURCE_LOCATION
if tldr <command>
is used.
TLDR_CACHE_ENABLED
(default is1
):- If set to
1
, the client will first try to load from cache, and fall back to fetching from the internet if the cache doesn't exist or is too old. - If set to
0
, the client will fetch from the internet, and fall back to the cache if the page cannot be fetched from the internet.
- If set to
TLDR_CACHE_MAX_AGE
(default is24
): maximum age of the cache in hours to be considered as valid whenTLDR_CACHE_ENABLED
is set to1
.
In order of precedence:
$XDG_CACHE_HOME/tldr
$HOME/.cache/tldr
~/.cache/tldr
If you are experiencing issues with tldr, consider deleting the cache files before trying other measures.
For networks that sit behind a proxy, it may be necessary to disable SSL verification for the client to function. Setting the following:
TLDR_ALLOW_INSECURE=1
will disable SSL certificate inspection. This should be avoided unless absolutely necessary.
Values of the TLDR_COLOR_x
variables may consist of three parts:
- Font color:
blue, green, yellow, cyan, magenta, white, grey, red
- Background color:
on_blue, on_cyan, on_magenta, on_white, on_grey, on_yellow, on_red, on_green
- Additional effects, which depends on platform:
reverse, blink, dark, concealed, underline, bold
You may specify as many additional effects as you want, while only one of font and background color.
Any of the values of above may be omitted. For example, you can do similar things as the following:
TLDR_COLOR_NAME=""
use default system font color with default background color without any effectsTLDR_COLOR_DESCRIPTION="white"
for white text on default system background color without any effectsTLDR_COLOR_NAME="cyan dark"
for dark cyan text on default system background colorTLDR_COLOR_NAME="on_red"
for default system font color on red background colorTLDR_COLOR_PARAMETER="red on_yellow underline"
for underlined red text on yellow backgroundTLDR_COLOR_NAME="bold underline"
for default system font and background colors with underline and bolded effects
The language that tldr will use is dependent on a number of factors. If you specify a language via the
--language
flag, tldr will attempt to use that language and only that language. Otherwise, it will
default to language set using either TLDR_LANGUAGE
before falling back to LANG
(ignoring the value C
).
If neither are set, then tldr will always attempt to get the en
page. Finally, if LANGUAGES
is set, it uses
this as the priority list to try languages in, with the exception that it will attempt TLDR_LANGUAGE
and LANG
first, and if neither are set, will use en
last (assuming it does not already appear somewhere in LANGUAGES
).
All language values should be set to a value that follows RFC 1766,
with the special exception of C
which is ignored.
If you wish to use your own instance of the tldr pages instead of the default repository, you
can either use the --source
flag when using tldr or by specifying the following environment variables:
TLDR_PAGES_SOURCE_LOCATION
to control where to get individual pages from- defaults to
https://raw.githubusercontent.com/tldr-pages/tldr/master/pages
- it can also point to local directory using
file:///path/to/directory
- defaults to
TLDR_DOWNLOAD_CACHE_LOCATION
to control where to pull a zip of all pages from- defaults to
https://tldr-pages.github.io/assets/tldr.zip
- defaults to