cldr

cldr is a cli utility that can read and manage the databases of "tl;dr" pages for other cli tools. These community maintained help pages are known as tl;dr (too long; didn't read) pages, because they provide a simplification of the full man pages, showing off the most used options and giving examples on how to use them.

This specific project is an alternative anti-ai ethical-tldr client written in C (hence the name cldr). The official ethical-tldr client is written in Python, which contains slop contributions, and for most operations is over 20 times slower than this client.

By default, this client maintains a local database of tldr pages at "~/.local/share/cldr/", but this can be changed with paramaters and environment variables.

Dependancies

[Optional] wget can be installed for less reliance on other projects using ai, if wget is not found, curl will be used instead

Usage

Usage: cldr [options] <query>

Prints tl;dr page for the given query.

Pages are split into several platforms:
[linux, common, freebsd, netbsd, openbsd, osx, sunos, windows, and android]

Options:
 -h, --help        print this help page
 -v, --version     print program and database version
 -l, --list        list all pages
 -p <platform>, --platform <platform>
                   select which platform to try first
 -P, --plain       print the query in plain text
 -u, --update      update/reinstall the local pages database
 -S <url>, --source <url>
                   specify the url to download archives from. The default is: 
                   https://codeberg.org/ethical-foss/ethical-tldr/archive/main.zip
 --storage-path <path>
                   specify the path to the local database
                   the default is ~/.local/share/cldr/
 -d, --delete
                   deletes the local pages database
 -L <language>, --language <language>
                   specify which language to use, combines well with all other options
 -s, --search      search the database for the given query. Overrides [-l|--list]
 --short, --short-options
                   show only short options in pages (when available)
 --long, --long-options
                   show only long options in pages (when available)

Environment Variables

DEBUG_LEVEL=-1         | Use any integer, values less than 0 are counted as infinity
TLDR_LANGUAGE=es       | Same as the -L parameter
TLDR_PAGES_SOURCE_LOCATION="https://codeberg.org/ethical-foss/ethical-tldr/archive/main.zip"       | Same as -S
TLDR_DOWNLOAD_CACHE_LOCATION=/home/GirlNamedZERO/.local/share/cldr/                                | Same as --storage-path
TLDR_OPTIONS=short|both|long       | Same as --short and --long
TLDR_PLATFORM=linux                | Same as the -p parameter

Prebuilt binaries

It's recommended that you download the binary from the latest release page, as this will have the most stable code without any breaking changes. But if you wish, you can follow the next steps to build it from source, the main branch should always have stable code.

Building from Source

Running make will build and place the result in the build directory.

Run make clean to remove the built binaries