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 are regularly updated archives available here), visiting the command pages individually on github.com — for example, here's the page for the tar command — or downloading the English PDF version (other language PDF versions are available here).
For a more convenient access, several dedicated client applications have been developed for different platforms:
Web clients
| Author | Source code | Where to find it | Notes |
|---|---|---|---|
| @rwv | tldr.inbrowser.app | Available online and offline (PWA) at tldr.inbrowser.app | |
| DistroWatch | (unavailable) | Available online at distrowatch.com/dwres.php?resource=man-pages | |
| Dendron | (unavailable) | https://tldr.dendron.so/ | |
| Linux Command Library | (unavailable) | Available online at linuxcommandlibrary.com/commands | The descriptions on this site are generated with an LLM and can be incorrect. It is advised to use other sites to confirm the information. |
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 tldrMacports: port install tldr-cpp-client |
| tldr-pages / tldr-python-client | Python | PyPI:pip install tldrArchLinux: pacman -S tldrFedora: sudo dnf install tldrSnap Store: snap install tldr |
| tldr-pages / tlrc | Rust | Instructions on the README |
Other console clients
| Client | Implementation details | Installation instructions |
|---|---|---|
| tealdeer-rs / tealdeer | Rust | Debian: apt install tealdeerArch: pacman -S tealdeer More instructions on tealdeer documentation |
| superatomic / tldr-man-client | Python | PyPI: pip install tldr-manHomebrew: brew install superatomic/tap/tldr-man |
| kovmir / tinytldr | C99 | make install |
| ve-nt / outfieldr | Zig | AUR: yay -S outfieldr |
| principis / tldr-sharp | C# | platform packages or instructions in 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 |
|---|---|---|
| freesuraj / TLDR | iOS | TLDR Man Page in App Store |
Application integration
| Application | Language | Source code | Installation instructions |
|---|---|---|---|
| Discord | Python | allthingslinux / tux | Follow the DEVELOPER.md and invoke with $tldr command |
| Rust/Coreutils | Rust | uutils/coreutils | Coreutils written in Rust documentations uses tldr for the doc. example |
| VS Code | Typescript | felipemullen/tldr-panel | search for tldr panel in IDE or download from Visual Studio Marketplace |
Wall of shame
These websites are using LLMs on TLDR pages without crediting the project. The explanations are often inaccurate and riddled with LLM hallucinations.
| Name | Website |
|---|---|
| CommandMasters | https://commandmasters.com/ |
| Forrest | https://forrestcli.com/tools |
| Command Examples | https://commandexamples.com/ |
Outdated clients
Unmaintained
These clients have not been updated in 3 years or more so it's safe to assume they are abandoned.
| Author | Source code | Where to find it |
|---|---|---|
| wlemuel / vim-tldr | vim / neovim | Instructions on the README |
| iamgodot/py-tldr | Python | pip install py-tldr |
| HardDie / myTldr | Go | go get github.com/HardDie/myTldr (or platform binaries) (supports custom pages directories) |
| skaji / perl-tldr | Perl | cpanm App::tldr |
| rilut / rust-tldr | Rust | cargo install tldr |
| porras / tlcr | Crystal | brew install porras/tap/tlcr |
| pepa65 / tldr-bash-client | Bash | L=/usr/local/bin/tldr; sudo wget -qO $L good4.eu/tldr; sudo chmod +x $L |
| Phuker / multi-tldr | Python | pip install multi-tldr |
| Yakiyo / tilde | Go | go get https://github.com/Yakiyo/tilde (pre-built binaries) |
| isacikgoz / tldr | Go | go get github.com/isacikgoz/tldr/cmd/tldr |
| hterkelsen / tldr | Dart | pub global activate tldr |
| tldr-pages / extldr (Archived) | Elixir | Instructions on the README |
| brainmaestro/tldr-php | PHP | composer global require brainmaestro/tldr |
| @ostera | tldr.jsx (archived) | Available online at tldr.ostera.io |
| @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 |
| @opoet7 | tldr-persian | Available online at https://opoet7.github.io/tldr-persian/ |
| @finzzz | finzzz/tldr (archived) | Available online at https://tldr.finzzz.net/ |
| @manualsrepo | (unavailable) | Available online at https://manualsrepo.com/command |
| Client | Implementation details | 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 |
| Client | Platform | Installation instructions |
|---|---|---|
| hidroh / tldroid | Android | tldroid on Google Play |
| Techno-Disaster / tldr man-pages | Android | tldr man-pages on Google Play, and F-Droid |
| mflint / ios-tldr-viewer | iOS | tldr-pages in App Store |
| Client | Platform | Installation instructions |
|---|---|---|
| terenceng2010/tldr-electron | Linux, macOS, Windows | electron-packaged binaries at https://github.com/terenceng2010/tldr-electron |
| Application | Language | Source code | Installation instructions |
|---|---|---|---|
| Keypirinha | Python | keypirinha-tldr | Follow the installation instructions on the readme page. |
| Emacs | Emacs Lisp | kuanyui / tldr.el | tldr.el is now available on MELPA |
| 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 |
| Telegram | JavaScript | tldr-telegram | Add the bot on Telegram or follow the installation instructions. |
| 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 |
| Raycast | TypeScript | raycast/extensions/tldr | Install Extension on Raycast Store |
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 |
| 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 |
| raylee / tldr-sh-client | POSIX Shell | https://github.com/raylee/tldr-sh-client/pull/54 | installation via curl or manually saving the script |
| k3mist / tldr | Go | https://github.com/k3mist/tldr/pull/2 | go get bitbucket.org/djr2/tldr (or Downloads (OSX, Linux, Windows)) |