https://github.com/tldr-pages/extldr

Elixir command-line client for tldr pages
https://github.com/tldr-pages/extldr

elixir-client hacktoberfest tldr tldr-client tldr-elixir tldr-pages

Last synced: 4 months ago
JSON representation

Elixir command-line client for tldr pages

• Host: GitHub
• URL: https://github.com/tldr-pages/extldr
• Owner: tldr-pages
• License: gpl-3.0
• Created: 2020-05-09T01:17:39.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2023-10-03T17:05:50.000Z (about 2 years ago)
• Last Synced: 2025-06-27T00:18:53.532Z (4 months ago)
• Topics: elixir-client, hacktoberfest, tldr, tldr-client, tldr-elixir, tldr-pages
• Language: Elixir
• Homepage:
• Size: 1.57 MB
• Stars: 15
• Watchers: 3
• Forks: 2
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: COPYING
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# ExTldr

[![Coverage Status](https://coveralls.io/repos/github/tldr-pages/extldr/badge.svg?branch=main)](https://coveralls.io/github/tldr-pages/extldr?branch=main)

[![Build Status](https://img.shields.io/github/actions/workflow/status/tldr-pages/extldr/.github/workflows/ci.yml?branch=master)](https://github.com/tldr-pages/extldr/actions)

[![Inline docs](http://inch-ci.org/github/tldr-pages/extldr.svg?branch=HEAD&style=shields)](http://inch-ci.org/github/tldr-pages/extldr)

ExTldr is an Elixir client for [tldr-pages](https://github.com/tldr-pages/tldr).

## Requirement

  - Erlang/OTP installed (it does not require Elixir, because Elixir is embedded in the script).

    - Read [*Erlang package from official repositories (Linux)*](https://github.com/tldr-pages/extldr/wiki/Erlang-package-from-official-repositories-(Linux)) to know about tested versions of Erlang available on some Linux distributions.

  - Download ExTldr. You can:

    - [Download the latest release](https://github.com/tldr-pages/extldr/releases).

    - Clone this repository.

## Usage

Once you have downloaded ExTldr, and unzipped in the case you downloaded a release, you can execute the script: `./extldr`

The script's first argument is the operating system, and the second argument is the command/term you want to search. Below there are some examples:

  - Search command `feh` in the pages of your current operating system:

    `extldr feh`

  - Search Linux command `adduser`:

    `extldr linux adduser`

  - Search a common command, `chroot`, in different operating systems:

    `extldr common chroot`

  - Search Linux command `cat`, available in common pages due it is available in different operating systems:

    `extldr linux cat`

Then, if you like, you can make it globally available with a symbolic link or adding it to your `PATH`.

## Planned for next versions

Although I prefer to track possible enhancements and ideas in the issues, below there are some essentials:

  - [ ] Multilingual support ([#1](https://github.com/tldr-pages/extldr/issues/1)).

  - [x] Check by default the operating system in which ExTldr is being executed ([#2](https://github.com/tldr-pages/extldr/issues/2)).

## Inspiration

ExTldr is heavily inspired by the great and awesome work of the tldr-pages community and the actually archived [TLDR Elixir Client](https://github.com/edgurgel/tldr_elixir_client) developed by [Eduardo Gurgel](https://github.com/edgurgel).

## License

ExTldr is licensed under the [GNU General Public License v3.0](https://github.com/tldr-pages/extldr/blob/master/COPYING).