Skip to content

Clients

Jump to bottom
Managor edited this page Mar 29, 2025 · 18 revisions

The content of tldr pages is openly available under the permissive MIT License. It can be accessed directly by downloading the contents of this repository (there's a regularly updated archive available here), visiting the command pages individually on github.com — for example, here's the page for the tar command — or downloading the PDF version.

For a more convenient access, though, several dedicated client applications have been developed for different platforms:

Web clients

Author Source code Where to find it
@rwv tldr.inbrowser.app Available online and offline (PWA) at tldr.inbrowser.app
@ostera tldr.jsx (archived) Available online at tldr.ostera.io
@finzzz finzzz/tldr (archived) Available online at https://tldr.finzzz.net/
@TheAshwanik tldr-Jquery-client Available online at blog.ashwani.co.in/tldr-Jquery-client
@hill tldr-chrome [Discontinued] Browser extension for Google Chrome
@piraces tldr-extension-browser Browser extension, published in the stores for Google Chrome, Firefox, Edge and other Chromium based browsers
@duckduckgo tldr_pages (archived) Sidebar shown on searches such as "tldr tar" on the DuckDuckGo search engine
DistroWatch (unavailable) Available online at distrowatch.com/dwres.php?resource=man-pages
@opoet7 tldr-persian Available online at https://opoet7.github.io/tldr-persian/
@manualsrepo (unavailable) Available online at https://manualsrepo.com/command

Console clients

The original client

The Node.js client was the client that was originally bundled with the tldr-pages project. It has since been moved to a separate repository but remains actively supported by the maintainers of the tldr-pages project. It is available on NPM and can be installed by running npm install -g tldr.

Official console clients

Client Implementation details Installation instructions
tldr-pages / tldr-c-client C Homebrew: brew install tldr
Macports: port install tldr-cpp-client
tldr-pages / tldr-python-client Python PyPI:pip install tldr
ArchLinux: pacman -S tldr
Fedora: sudo dnf install tldr
Snap Store: snap install tldr
tldr-pages / tlrc Rust Instructions on the README

Other console clients

Client Implementation details Installation instructions

| superatomic / tldr-man-client | Python | PyPI: pip install tldr-man
Homebrew: brew install superatomic/tap/tldr-man | kovmir / tinytldr | C99 | make install | brainmaestro/tldr-php | PHP | composer global require brainmaestro/tldr | tealdeer-rs / tealdeer | Rust | cargo install tealdeer
AUR: yay -S tealdeer | tldr-pages / extldr (Archived)| Elixir | Instructions on the README | hterkelsen / tldr | Dart | pub global activate tldr | isacikgoz / tldr | Go | go get github.com/isacikgoz/tldr/cmd/tldr | k3mist / tldr | Go | go get bitbucket.org/djr2/tldr
(or Downloads (OSX, Linux, Windows)) | Yakiyo / tilde | Go | go get https://github.com/Yakiyo/tilde (pre-built binaries) | Phuker / multi-tldr | Python | pip install multi-tldr | pepa65 / tldr-bash-client | Bash | L=/usr/local/bin/tldr; sudo wget -qO $L good4.eu/tldr; sudo chmod +x $L | porras / tlcr | Crystal | brew install porras/tap/tlcr | principis / tldr-sharp | C# | platform packages or instructions in README | raylee / tldr-sh-client | POSIX Shell | installation via curl or manually saving the script | rilut / rust-tldr | Rust | cargo install tldr | skaji / perl-tldr | Perl | cpanm App::tldr | HardDie / myTldr | Go | go get github.com/HardDie/myTldr
(or platform binaries)
(supports custom pages directories) | iamgodot/py-tldr | Python | pip install py-tldr | wlemuel / vim-tldr | vim / neovim | Instructions on the README | lonr / tldr-ts | Node.js | npm install -g tldr-ts | jiripospisil / drtl | Zig | paru -Sy drtl-bin | dvinciguerra/tldr-cli | Ruby | gem install tldr-cli

Mobile clients

Client Platform Installation instructions
Techno-Disaster / tldr man-pages Android tldr man-pages on Google Play, and F-Droid
hidroh / tldroid (outdated) Android tldroid on Google Play
freesuraj / TLDR iOS TLDR Man Page in App Store
mflint / ios-tldr-viewer iOS tldr-pages in App Store

Desktop clients

Client Platform Installation instructions
terenceng2010/tldr-electron Linux, macOS, Windows electron-packaged binaries at https://github.com/terenceng2010/tldr-electron

Application integration

Application Language Source code Installation instructions
Alfred Go konoui / alfred-tldr Instructions on the README
Alfred Python cs1707 / tldr-alfred
Dash for macOS / Zeal Python cvn / tldr-python-dash-docset open Preferences > Downloads > User Contributed and find tldr pages in the list
Emacs Emacs Lisp kuanyui / tldr.el tldr.el is now available on MELPA
Slack Rust tldr-slack-bot (Discontinued) Add a bot user to workspace, obtain API key, compile repository with cargo and execute.
Telegram JavaScript tldr-telegram Add the bot on Telegram or follow the installation instructions.
Keypirinha Python keypirinha-tldr Follow the installation instructions on the readme page.
Discord C# Epictek/tldr-Discord
Dendron JavaScript kevinslin/seed-tldr Install Dendron (VS Code extension), then follow the Quickstart to add the dendron.tldr vault
Rust/Coreutils Rust uutils/coreutils Coreutils written in Rust documentations uses tldr for the doc. example
Raycast TypeScript raycast/extensions/tldr Install Extension on Raycast Store
VS Code Typescript felipemullen/tldr-panel search for tldr panel in IDE or download from Visual Studio Marketplace

Outdated clients

Unmaintained

These clients have not been updated in 3 years or more so it's safe to assume they are abandoned.

Client / integration Implementation details Issue / pull request Installation instructions
accatyyc / tldr-man man Instructions on the README
anoopengineer / tldr Go go get github.com/anoopengineer/tldr
(or Download binaries for Windows, MacOSX and Linux)
avih / tldr-fmt POSIX Shell git clone https://github.com/avih/tldr-fmt
edgurgel / tldr_elixir_client (Archived) Elixir binaries not yet available
pranavraja / tldr (Archived) Go go get github.com/pranavraja/tldr
(or platform binaries)
psibi / tldr-hs Haskell stack install tldr
YellowApple / tldrb Ruby gem install tldrb
marchersimon/tldr-cpp C++ yay -S tldr-cpp-git
hochata/mt Nim nimble install mt
tldrx / tldrx Rust cargo install tldrx

Currently broken clients and integrations

The following clients are under-maintained and were broken, when we removed the master branch. When these clients and integrations have been updated to work again, they can be moved back to the tables above.

Client / integration Implementation details Issue / pull request Installation instructions
RosalesJ / tldr-ocaml OCaml https://github.com/RosalesJ/tldr-ocaml/pull/4 opam install tldr
lord63 / tldr.py Python https://github.com/lord63/tldr.py/pull/50 pip install tldr.py
ve-nt / outfieldr Zig https://gitlab.com/ve-nt/outfieldr/-/merge_requests/3 Instructions in the README
kirillseva / tldrrr R https://github.com/kirillseva/tldrrr/pull/1 devtools::install_github('kirillseva/tldrrr')
karthiks-oss / tldr-java-client Java None Instructions in the README
Clone this wiki locally