Skip to content

Latest commit

 

History

History
54 lines (31 loc) · 2.52 KB

README.md

File metadata and controls

54 lines (31 loc) · 2.52 KB

ExTldr

Coverage Status Build Status Inline docs

ExTldr is an Elixir client for tldr-pages.

Requirement

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).
  • Check by default the operating system in which ExTldr is being executed (#2).

Inspiration

ExTldr is heavily inspired by the great and awesome work of the tldr-pages community and the actually archived TLDR Elixir Client developed by Eduardo Gurgel.

License

ExTldr is licensed under the GNU General Public License v3.0.