tldr-bash-client/README.md

A fully-functional bash client for tldr. This version aims to be the easiest and smallest to set up on a new account, without sacrificing any features.

Setup

mkdir -p ~/bin
curl -o ~/bin/tldr https://raw.githubusercontent.com/raylee/tldr/master/tldr
chmod +x ~/bin/tldr

Then make sure ~/bin is in your $PATH. On OSX edit ~/.bash_profile (or ~/.bashrc on Linux), and add the following line to the bottom of the file:

export PATH=~/bin:$PATH

Prerequisites

curl needs to be available somewhere in your $PATH. The script is otherwise self-contained.

Usage

tldr [options] command

[options]
	-l, --list:     show all available pages
	-u, --update:   update, force retrieving latest copies of index and <command>
	-p, --platform: show page from specific platform rather than autodetecting
	-h, -?:         this help overview

command
	Show examples for this command

The client caches a copy of all pages and the index locally under ~/.config/tldr. By default, the cached copies will expire in 14 days.

Contributing

This is the result of a Sunday afternoon project. It's been lightly tested under Mac OS X 10.9 and Ubuntu Linux 15.10. I've tried to make the project as portable as possible, but if there's something I missed I'd love your help.

• Want a new feature? Feel free to file an issue for a feature request.
• Find a bug? Open an issue please, or even better send me a pull request.

Contributions are always welcome at any time!