https://github.com/karthiks-oss/tldr-java-client

Java client for https://github.com/tldr-pages/tldr
https://github.com/karthiks-oss/tldr-java-client

cheatsheet cli help java tldr tldr-client

Last synced: 3 months ago
JSON representation

Java client for https://github.com/tldr-pages/tldr

• Host: GitHub
• URL: https://github.com/karthiks-oss/tldr-java-client
• Owner: karthiks-oss
• License: mit
• Created: 2020-10-12T15:30:38.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-02-23T06:36:57.000Z (11 months ago)
• Last Synced: 2024-07-30T20:54:24.219Z (6 months ago)
• Topics: cheatsheet, cli, help, java, tldr, tldr-client
• Language: Java
• Homepage:
• Size: 69.3 KB
• Stars: 1
• Watchers: 2
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# TLDR Java Client

This is a Java client for [tldr-pages](https://tldr.sh/)

## Building

### Prerequisite

- Java Development Kit 1.8.

- Maven 3.6.X.

### Build.

Run `mvn clean package` to build the project and extract `./target/tldr.zip` and add the `$EXTRACTED_FOLDER\bin` to the path.

## Usage

```

Usage: tldr [options] SEARCH

  Options:

    --help, -h

      Print help information and exit

    --platform, -p

      Platform [windows, macos|osx, linux]

    --version

      Print version and exit

```

## Work in progress.

* [Language Support: #2](https://github.com/seenukarthi/tldr-java-client/issues/2)

* [Caching support: #3](https://github.com/seenukarthi/tldr-java-client/issues/3).

* [Local file rendering: #4](https://github.com/seenukarthi/tldr-java-client/issues/4).

## Download

Download tldr from [releases](https://github.com/seenukarthi/tldr-java-client/releases)