Skip to content

x tldr: a new client for tldr pages using shawk #11110

Description

@edwinjhlee

Hello, friends.

I am the author of x-cmd. website.
We implement a tldr client using posix shell and awk, which come along with x-cmd distribution as a module.

We think x tldr is one of the best clients for tldr-pages for three reasons:

  1. Comparing to the clients using nodejs, python, or other advanced programming language, x-cmd itself is lightweight. It only use posix shell, awk and curl in your system.
  2. We provide an interactive tui app. You could see the demo here. As we upgrade our termianl ui framework in the future, the userbility can even be much better.
  3. We redistribute the tldr pages for two purposes:
    • In cases where GitHub is inaccessible for users in China, we provide hosting within China.
    • We believe that the original size (2MB) may be too large for certain embedded hardware. To address this, we have divided the package based on languages. Typically, users only need to download the English package (400KB), along with their preferred language if desired.

To use the x tldr, all you need to do is:

  1. install x-cmd: eval "$(curl https://get.x-cmd.com)". Reference: get-started
  2. just type x tldr.

We hope tldr-pages can take x-cmd as one of the recommandation client. If you have any questions or requirements for x tldr. Please let us know in this issue.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions