On GitHub, tldr-pages/tlrc has picked up 1.1k stars, Backend, Rust. Official tldr client written in Rust.
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
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
[cache]
# Override the cache directory ('~' will be expanded to your home directory).
dir = "/path/to/cache"
# Override the base URL used for downloading tldr pages.
# The mirror must provide files with the same names as the official tldr pages repository:
# mirror/tldr.sha256sums must point to the SHA256 checksums of all assets
# mirror/tldr-pages.LANGUAGE.zip must point to a zip archive that contains platform directories with pages in LANGUAGE
mirror = "https://github.com/tldr-pages/tldr/releases/latest/download"
# Automatically update the cache if it's older than max_age hours.
auto_update = true
# Perform the automatic update after the page is shown (the default is to update first, then show the page).
defer_auto_update = false
max_age = 336 # 336 hours = 2 weeks
# Specify a list of desired page languages. If it's empty, languages specified in
# the LANG and LANGUAGE environment variables are downloaded.
# English is implied and will always be downloaded.
# You can see a list of language codes here: https://github.com/tldr-pages/tldr
# Example: ["de", "pl"]
languages = []
[output]
# Show the title in the rendered page.
show_title = true
# Show the platform name ('common', 'linux', etc.) in the title.
platform_title = false
# Prefix descriptions of examples with hyphens.
show_hyphens = false
# Display a link to edit the shown page on GitHub.
edit_link = false
# Use a custom string instead of a hyphen.
example_prefix = "- "
# Set the max line length. 0 means to use the terminal width.
# If a description is longer than this value, it will be split
# into multiple lines.
line_length = 0
# Strip empty lines from output.
compact = false
# In option placeholders, show the specified option style.
# Example: {{[-s|--long]}}
# short : -s
# long : --long
# both : [-s|--long]
option_style = "long"
# Print pages in raw markdown.
raw_markdown = false
# Number of spaces to put before each line of the page.
[indent]
# Command name.
title = 2
# Command description.
description = 2
# Descriptions of examples.
bullet = 2
# Example command invocations.
example = 4
# Style for the title of the page (command name).
[style.title]
# Fixed colors: "black", "red", "green", "yellow", "blue", "magenta", "cyan", "white", "default",
# "bright_black", "bright_red", "bright_green", "bright_yellow", "bright_blue",
# "bright_magenta", "bright_cyan", "bright_white"
# 256color ANSI code: { color256 = 50 }
# RGB: { rgb = [0, 255, 255] }
# Hex: { hex = "#ffffff" }
color = "magenta"
background = "default"
bold = true
underline = false
italic = false
dim = false
strikethrough = false
# Style for the description of the page.
[style.description]
color = "magenta"
background = "default"
bold = false
underline = false
italic = false
dim = false
strikethrough = false
# Style for descriptions of examples.
[style.bullet]
color = "green"
background = "default"
bold = false
underline = false
italic = false
dim = false
strikethrough = false
# Style for command examples.
[style.example]
color = "cyan"
background = "default"
bold = false
underline = false
italic = false
dim = false
strikethrough = false
# Style for URLs inside the description.
[style.url]
color = "red"
background = "default"
bold = false
underline = false
italic = true
dim = false
strikethrough = false
# Style for text surrounded by backticks (`).
[style.inline_code]
color = "yellow"
background = "default"
bold = false
underline = false
italic = true
dim = false
strikethrough = false
# Style for placeholders inside command examples.
[style.placeholder]
color = "red"
background = "default"
bold = false
underline = false
italic = true
dim = false
strikethrough = false
For a style similar to tldr-python-client, add this to your config:
The most recent commit recorded on tldr-pages/tlrc was 8 days ago, based on the GitHub push timestamp. The repository has 35 forks — one of the better signals of community interest.
Is tldr-pages/tlrc open source?
Yes — tldr-pages/tlrc ships under the MIT license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/tldr-pages/tlrc.
What license does tldr-pages/tlrc use?
tldr-pages/tlrc is released under the MIT license. Always verify the LICENSE file directly on GitHub for the authoritative terms — license strings can be edited out of sync with a project's actual stance.
What topics is tldr-pages/tlrc associated with?
GitHub's repository topics for tldr-pages/tlrc: "hacktoberfest", "rust", "tldr", "tldr-pages". TopGit's editorial category is Backend.
Where can I see tldr-pages/tlrc in action?
The project maintains a homepage at http://tldr.sh/tlrc/. The README tab on this page also usually contains screenshots and a quickstart.
Where do I read more about tldr-pages/tlrc?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/tldr-pages/tlrc is the definitive source.
Read full README in the tab above.
Is tlrc worth your time?
ChatGPT, Claude and Perplexity can all read this page. Ask one of them what it makes of tlrc.
/tlrc
