{"id":28408424,"url":"https://github.com/tldr-pages/extldr","last_synced_at":"2025-06-30T02:32:53.557Z","repository":{"id":65983035,"uuid":"262462027","full_name":"tldr-pages/extldr","owner":"tldr-pages","description":"Elixir command-line client for tldr pages","archived":false,"fork":false,"pushed_at":"2023-10-03T17:05:50.000Z","size":1646,"stargazers_count":15,"open_issues_count":9,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-06-27T00:18:53.532Z","etag":null,"topics":["elixir-client","hacktoberfest","tldr","tldr-client","tldr-elixir","tldr-pages"],"latest_commit_sha":null,"homepage":"","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tldr-pages.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"COPYING","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null},"funding":{"liberapay":"tldr-pages"}},"created_at":"2020-05-09T01:17:39.000Z","updated_at":"2024-06-03T00:28:18.000Z","dependencies_parsed_at":"2023-02-19T19:31:27.467Z","dependency_job_id":"323ba7f1-a66a-42ff-9cdb-3ccb1253887d","html_url":"https://github.com/tldr-pages/extldr","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/tldr-pages/extldr","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tldr-pages%2Fextldr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tldr-pages%2Fextldr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tldr-pages%2Fextldr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tldr-pages%2Fextldr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tldr-pages","download_url":"https://codeload.github.com/tldr-pages/extldr/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tldr-pages%2Fextldr/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262698948,"owners_count":23350207,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["elixir-client","hacktoberfest","tldr","tldr-client","tldr-elixir","tldr-pages"],"created_at":"2025-06-02T03:10:09.270Z","updated_at":"2025-06-30T02:32:53.528Z","avatar_url":"https://github.com/tldr-pages.png","language":"Elixir","funding_links":["https://liberapay.com/tldr-pages"],"categories":[],"sub_categories":[],"readme":"# ExTldr\n\n[![Coverage Status](https://coveralls.io/repos/github/tldr-pages/extldr/badge.svg?branch=main)](https://coveralls.io/github/tldr-pages/extldr?branch=main)\n[![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)\n[![Inline docs](http://inch-ci.org/github/tldr-pages/extldr.svg?branch=HEAD\u0026style=shields)](http://inch-ci.org/github/tldr-pages/extldr)\n\nExTldr is an Elixir client for [tldr-pages](https://github.com/tldr-pages/tldr).\n\n## Requirement\n\n  - Erlang/OTP installed (it does not require Elixir, because Elixir is embedded in the script).\n    - 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.\n  - Download ExTldr. You can:\n    - [Download the latest release](https://github.com/tldr-pages/extldr/releases).\n    - Clone this repository.\n\n## Usage\n\nOnce you have downloaded ExTldr, and unzipped in the case you downloaded a release, you can execute the script: `./extldr`\n\nThe 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:\n\n  - Search command `feh` in the pages of your current operating system:\n\n    `extldr feh`\n\n  - Search Linux command `adduser`:\n\n    `extldr linux adduser`\n\n  - Search a common command, `chroot`, in different operating systems:\n\n    `extldr common chroot`\n\n  - Search Linux command `cat`, available in common pages due it is available in different operating systems:\n\n    `extldr linux cat`\n\nThen, if you like, you can make it globally available with a symbolic link or adding it to your `PATH`.\n\n## Planned for next versions\n\nAlthough I prefer to track possible enhancements and ideas in the issues, below there are some essentials:\n\n  - [ ] Multilingual support ([#1](https://github.com/tldr-pages/extldr/issues/1)).\n  - [x] Check by default the operating system in which ExTldr is being executed ([#2](https://github.com/tldr-pages/extldr/issues/2)).\n\n## Inspiration\n\nExTldr 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).\n\n## License\n\nExTldr is licensed under the [GNU General Public License v3.0](https://github.com/tldr-pages/extldr/blob/master/COPYING).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftldr-pages%2Fextldr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftldr-pages%2Fextldr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftldr-pages%2Fextldr/lists"}