tldr-bash-client/README.md

tldr-bash-client

A fully-functional bash client for the tldr project, providing poignant examples of terminal commands.

Installation

Download the tldr bash script to the install location:

location=/usr/local/bin/tldr  # elevated privileges needed for some locations
sudo wget -qO $location https://raw.githubusercontent.com/pepa65/tldr-bash-client/master/tldr
sudo chmod +x $location

If the location is not in $PATH, you need to specify the path to run it.

Prerequisites

coreutils, less, grep, unzip, curl / wget

Customisation

The colors and other styling of the 5 elements of tldr pages can be modified either by editing the first few lines of the scipt, or by setting the following environment variables:

• TLDR_TITLE_STYLE (defaults to: Newline Space Bold Yellow)
• TLDR_DESCRIPTION_STYLE (defaults to: Space Yellow)
• TLDR_EXAMPLE_STYLE (defaults to: Newline Bold Green)
• TLDR_CODE_STYLE (defaults to: Space Bold Blue)
• TLDR_VALUE_STYLE (defaults to: Bold Cyan)

Also the error color and page expiry can easily be set:

• TLDR_ERROR_COLOR (defaults to: Red)
• TLDR_EXPIRY (defaults to: 60)

Contributing

Please file an issue for a question, a bug or a feature request. Or even better, send a pull request!

This tldr-bash-client github page

License

Relicensed under GPL v3+