Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README: remove list of clients #7381

Merged
merged 3 commits into from
Nov 8, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 3 additions & 99 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,105 +63,9 @@ just like you would write `man tar` to show its manpage.
However, if you just want to browse without installing anything, check
out the [PDF version](https://tldr.sh/assets/tldr-book.pdf).

There are also various other clients provided by the community,
both for the command-line and for other platforms:

- Alfred Workflow
- [tldr-alfred](https://github.com/cs1707/tldr-alfred)
- [alfred-tldr](https://github.com/konoui/alfred-tldr)
- [Albert Plugin](https://github.com/bergercookie/awesome-albert-plugins/tree/master/plugins/tldr_pages)
- Android clients:
- [tldroid](https://github.com/hidroh/tldroid), available on
[Google Play](https://play.google.com/store/apps/details?id=io.github.hidroh.tldroid) *(outdated)*
- [tldr-flutter](https://github.com/Techno-Disaster/tldr-flutter), available on
[Google Play](https://play.google.com/store/apps/details?id=wtf.technodisaster.tldr) or [F-Droid](https://f-droid.org/packages/wtf.technodisaster.tldr/)
- Bash clients:
- [tldr-sh-client](https://github.com/raylee/tldr-sh-client)
- [tldr-bash-client](https://gitlab.com/pepa65/tldr-bash-client)
- [C# client](https://github.com/principis/tldr-sharp)
- [C++ client](https://github.com/marchersimon/tldr-cpp):
`yay -S tldr-cpp-git`
- [C client](https://github.com/tldr-pages/tldr-c-client):
`brew install tldr`
- [Chrome Extension](https://github.com/hill/tldr-chrome) available on
[Chrome Web Store](https://chrome.google.com/webstore/detail/tldr-chrome/nnmlddkpgoecicoallmimonoboialpap)
- [Crystal client](https://github.com/porras/tlcr):
`brew install porras/tap/tlcr`
- [Dart client](https://github.com/hterkelsen/tldr):
`pub global activate tldr`
- [Dash docset](https://github.com/Moddus/tldr-python-dash-docset):
Open `Preferences` > `Downloads` > `User Contributed` and find `tldr pages` in the list
- [Discord Bot](https://github.com/sschr15/tldr-discord):
[Follow the building instructions](https://github.com/sschr15/tldr-discord#building) or
[use a privately hosted version](https://discord.com/api/oauth2/authorize?client_id=742800507210301520&permissions=18432&scope=bot)
- [Discord Slash Command Bot](https://github.com/Epictek/tldr-Discord): use the [hosted instance](https://discord.com/api/oauth2/authorize?client_id=839254228736278579&permissions=0&scope=applications.commands%20bot) or view the [readme](https://github.com/Epictek/tldr-Discord#self-host-guide) for self hosting instructions.
- Docker images:
- [tldr-docker](https://github.com/nutellinoit/tldr-docker) - Run the `tldr` command via a docker container: `alias tldr='docker run --rm -it -v ~/.tldr/:/root/.tldr/ nutellinoit/tldr'`
- Elixir clients:
- [ExTldr](https://github.com/tldr-pages/extldr).
- [TLDR Elixir Client](https://github.com/edgurgel/tldr_elixir_client)
(binaries not yet available)
- [Emacs client](https://github.com/kuanyui/tldr.el), available on
[MELPA](https://melpa.org/#/tldr)
- Go clients:
- [github.com/pranavraja/tldr](https://github.com/pranavraja/tldr):
`go get github.com/pranavraja/tldr`
(or [platform binaries](https://github.com/pranavraja/tldr/releases))
- [https://github.com/leighmcculloch/tldr](https://github.com/leighmcculloch/tldr):
`go get 4d63.com/tldr` or `brew install 4d63/tldr/tldr`
(or [platform binaries](https://github.com/leighmcculloch/tldr/releases))
- [github.com/elecprog/tldr](https://github.com/elecprog/tldr):
`go get github.com/elecprog/tldr`
(or [platform binaries](https://github.com/elecprog/tldr/releases))
- [github.com/isacikgoz/tldr](https://github.com/isacikgoz/tldr):
`go get github.com/isacikgoz/tldr`
(or [platform binaries](https://github.com/isacikgoz/tldr/releases))
- [github.com/HardDie/myTldr](https://github.com/HardDie/myTldr):
`go get github.com/HardDie/myTldr`
(or [platform binaries](https://github.com/HardDie/myTldr/releases)) (supports custom pages directories)
- iOS clients:
- [tldr-man-page](https://github.com/freesuraj/TLDR), available on
[App Store](https://appsto.re/sg/IQ0-_.i)
- [tldr-pages](https://github.com/mflint/ios-tldr-viewer), available on
[App Store](https://itunes.apple.com/us/app/tldt-pages/id1071725095?ls=1&mt=8)
- Haskell clients:
- [tldr-hs](https://github.com/psibi/tldr-hs):
`stack install tldr`
or `apt-get install tldr` on Debian-based distributions
- [fast-tldr](https://github.com/gutjuri/fast-tldr)
- [Java client](https://github.com/seenukarthi/tldr-java-client)
- [JetBrains IDEs plugin (IntelliJ IDEA, PyCharm, etc.)](https://github.com/AlexPl292/tldr-intellij) available on [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/17397-tldr-doc)
- [Keypirinha Plugin](https://github.com/ronan696/keypirinha-tldr)
- [Node.js client](https://github.com/tldr-pages/tldr-node-client):
`npm install -g tldr`
- [OCaml client](https://github.com/RosalesJ/tldr-ocaml): `opam install tldr`
- [Outfieldr](https://gitlab.com/ve-nt/outfieldr): A Zig client
- [Perl5 client](https://github.com/skaji/perl-tldr):
`cpanm App::tldr`
- [PHP client](https://github.com/BrainMaestro/tldr-php):
`composer global require brainmaestro/tldr`
- Python clients:
- [tldr-python-client](https://github.com/tldr-pages/tldr-python-client):
`pip install tldr` or `pacman -S tldr` on Arch Linux
- [tldr.py](https://github.com/lord63/tldr.py):
`pip install tldr.py` or `apt-get install tldr-py` on Debian-based distributions
- [R client](https://github.com/kirillseva/tldrrr):
`devtools::install_github('kirillseva/tldrrr')`
- [Ruby client](https://github.com/YellowApple/tldrb):
`gem install tldrb`
- [Rust client](https://github.com/dbrgn/tealdeer):
`cargo install tealdeer` or `brew install tealdeer`
- [Vim Client](https://github.com/wlemuel/vim-tldr)
- [Visual Studio Code extension](https://github.com/bmuskalla/vscode-tldr) available on [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=bmuskalla.vscode-tldr)
- Web clients:
- [tldr.dendron.so](https://github.com/kevinslin/seed-tldr): https://tldr.dendron.so
- [tldr.jsx](https://github.com/ostera/tldr.jsx): http://tldr.ostera.io
- [tldr.finzzz.net](https://git.finzzz.net/tldr/): https://tldr.finzzz.net
- [DistroWatch](https://distrowatch.com/dwres.php?resource=man-pages)
- [TLDR Persian](https://opoet7.github.io/tldr-persian/): Web Client in Persian

There is also a comprehensive
[list of clients in our Wiki](https://github.com/tldr-pages/tldr/wiki/tldr-pages-clients).
There are also **various other clients** provided by the community,
both for the command-line and for other platforms.
For a comprehensive list of clients, head over to our [Wiki](https://github.com/tldr-pages/tldr/wiki/tldr-pages-clients).

## How do I contribute?

Expand Down