Note
tldr_ruby_client is a community port that is not affiliated with the tldr-pages team.
tldr_ruby_client is a command line client for tldr pages. It allows you to browse cheatsheets as supplement to man pages.
Warning
tldr_ruby_client is currently in an early stage of development. Use at your own risk.
Please join our announce mailing list at https://lists.sr.ht/~kerrick/tldr_ruby_client-announce to stay up-to-date on new releases and announcements.
This project was started because of CosmoRuby, an actually portable executable of Ruby built with Cosmopolitan Libc. As such, tldr_ruby_client is designed to run on everything Cosmopolitan supports, including:
- GNU/Linux, macOS, Windows, OpenBSD, FreeBSD, and NetBSD; and
- x86_64 (AMD, Intel) and ARM (Apple Silicon, Raspberry Pi).
For the quickstart, see the quickstart.
For the full documentation on how to use tldr_ruby_client, see our docs.
Bug reports and pull requests are welcome on sourcehut at https://sr.ht/~kerrick/tldr_ruby_client/. This project is intended to be a safe, productive collaboration, and contributors are expected to adhere to the Ruby Community Conduct Guideline.
Issues for the cheatsheets should be filed at tldr.
Want to help develop tldr_ruby_client? Check out our contribution guide.
tldr_ruby_client is copyright 2025, Kerrick Long. tldr_ruby_client is licensed under the GNU Affero General Public License v3.0 or later; see LICENSES/AGPL-3.0-or-later.txt for the full text.
Some parts of this program are copied from other sources under appropriate reuse licenses, and the copyright belongs to their respective owners. See the REUSE Specification – Version 3.3 for information about how we comply with attribution and licensing requirements.