avi1989 / tldr-rs

A rust client for tldr-pages

tldr

A rust client for tldr-pages.

Installation

This package is not available in any package manager at this time. The only way to install it is to download the correct file from the release and add it to the system path.

On Linux and x64 Mac

# Download binary
curl -L https://github.com/avi1989/tldr-rs/releases/latest/download/tldr_amd64 -o ./tldr

# Make binary executable
chmod +x ./tldr

# Copy into path
sudo cp ./tldr /usr/local/tldr

On M1 Mac

# Download binary
curl -L https://github.com/avi1989/tldr-rs/releases/latest/download/tldr_darwin -o ./tldr

# Make binary executable
chmod +x ./tldr

# Copy into path
sudo cp ./tldr /usr/local/bin/tldr

Usage

tldr [OPTIONS] [NAME]

Arguments:

[NAME]: The name of the tool you want to see the tldr page for

[Options]:

-p, --platform Specify the platform of the command.

-u, --update Update the TLDR cache.

-r, --reset Deletes the tldr cache and refreshes it.

-v, --version Print version.

--cache-dir Gets the cache directory

-h, --help Print help