tlrc

Installation

Linux/macOS using Homebrew

Install tlrc with Homebrew:

brew install tlrc

Linux/macOS using Nix

Install tlrc from nixpkgs.

Arch Linux

Install tlrc (from source) or tlrc-bin (prebuilt) from the AUR.

Void Linux

Install tlrc with XBPS:

xbps-install tlrc

openSUSE

Install tlrc with Zypper:

zypper install tlrc

Windows using Winget

Install tlrc with Winget:

winget install tldr-pages.tlrc

Windows using Scoop

Install tlrc with Scoop:

scoop install tlrc

macOS using MacPorts

Install tlrc with MacPorts:

port install tlrc

NetBSD

Install tlrc with pkgin:

pkgin install tlrc

Linux/macOS/Windows using Conda

Install tlrc with Conda:

conda install conda-forge::tlrc
# if using mamba
# mamba install conda-forge::tlrc

From crates.io

To build tlrc from a source tarball, run:

cargo install tlrc --locked

[!NOTE] Shell completion files and the man page will not be installed that way.

From GitHub Releases

You can find prebuilt binaries and Debian packages here.

Usage

See man tldr or the online manpage. For a brief description, you can also run:

tldr --help

Configuration

Tlrc can be customized with a TOML configuration file. To get the default path for your system, run:

tldr --config-path

To generate a default config file, run:

tldr --gen-config > "$(tldr --config-path)"

or copy the below example.

Configuration options

…

For a style similar to tldr-python-client, add this to your config:

[output]
show_hyphens = true
compact = true

[style]
title.color = "default"
title.bold = true
description.color = "default"
bullet.color = "green"
example.color = "red"
placeholder.color = "default"