Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/trskop/tldr-client
Configurable tldr-pages client with support for custom pages
https://github.com/trskop/tldr-client
Last synced: 10 days ago
JSON representation
Configurable tldr-pages client with support for custom pages
- Host: GitHub
- URL: https://github.com/trskop/tldr-client
- Owner: trskop
- License: other
- Created: 2021-08-16T22:08:41.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-11T20:31:34.000Z (6 months ago)
- Last Synced: 2024-05-11T21:29:26.033Z (6 months ago)
- Language: Haskell
- Size: 231 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog.md
- License: LICENSE
Awesome Lists containing this project
README
# TLDR Client
Highly configurable client for [tldr-pages](https://tldr.sh/) that supports
[Tldr-pages Client Specification v2.2
](https://github.com/tldr-pages/tldr/blob/v2.2/CLIENT-SPECIFICATION.md).
## Usage
```
tldr [--config=EXPR] [{--platform=PLATFORM|-p PLATFORM} [...]]
[{--language=LANGUAGE|-L LANGUAGE} [...]]
[{--source=SOURCE|-s SOURCE} [...]] COMMAND [SUBCOMMAND [...]]
tldr {--list|-l} [--config=EXPR] [{--platform=PLATFORM|-p PLATFORM} [...]]
[{--language=LANGUAGE|-L LANGUAGE} [...]]
[{--source=SOURCE|-s SOURCE} [...]]
tldr {--update|-u} [--config=EXPR] [{--platform=PLATFORM|-p PLATFORM} [...]]
[{--language=LANGUAGE|-L LANGUAGE} [...]]
[{--source=SOURCE|-s SOURCE} [...]]
tldr --clear-cache [--config=EXPR] [{--platform=PLATFORM|-p PLATFORM} [...]]
[{--language=LANGUAGE|-L LANGUAGE} [...]]
[{--source=SOURCE|-s SOURCE} [...]]
tldr {--config-typecheck|--config-print-type} [--config=EXPR]
tldr {--version|-v}
tldr {--help|-h}
```
## Configuration
Simple default configuration can look like:
```dhall
let Config = ./dhall/Config/package.dhall in Config::{=}
```
More complicated example that can be turned into a library can be found in
[`dhall/config.dhall`](./dhall/config.dhall) file.
## Features and Limitations
- [x] Dhall configuration file.
- [x] Support for multiple sources of pages including custom sources and local
pages.
- [x] Use index file/DB instead of guessing paths. This should allow us to do
more advanced search in the future.
- [ ] Support tarballs (`.tar`, `.tar.gz`, `.tar.bz2`, `.tar.xz`, etc.).
- [ ] Support removing subdirectories from a source. For example if the archive
has a root directory where `pages${locale}` directories are stored.
- [x] Command line completion.
- [x] [Command Wrapper](https://github.com/trskop/command-wrapper#readme)
support.
- [ ] Support source (see documentation of `--source=SOURCE` option)
preferences. When a page is provided by multiple sources it is a good idea
for certain sources to have precedence. For example, user will probably want
their custom pages to be preferred over standard tldr pages.
- [ ] Support language preferences/filtering when populating offline cache.