README.md

TLDR Java Client

This is a Java client for tldr-pages

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
• Caching support: #3.
• Local file rendering: #4.

Download

Download tldr from releases