tldr

README

tldr

A lightweight tldr client that allows for custom pages.

Description

This tldr client, will download and install the initial cache of tldr pages from https://codeload.github.com/tldr-pages/tldr/zip/refs/heads/main/tldr-main.zip.

The file will be downloaded and saved locally to ~/.cache/tldr/tldr-main.zip.

The archive is unpacked to ~/.cache/tldr/tldr-main/.

This implementation allows for local pages to be stored in ~/.config/tldr/custom.

These pages will be available to be displayed along with the official repo pages. Options are provided to allow for hiding the custom or official pages. Options are also provided to update the local cache from the official repo pages. The binary will let you know of the cache of tldr pages is older than 7 days.

The same colors and help file parsing mechanism as in the original python script have been replicated.

Hard Fork - Initial Code

The initial code was lifted from the following repos.
https://github.com/HardDie/myTldr
https://github.com/free2k/myTldr

How to install

Clone repository run make install

This will install the binary in ~/bin/