amezghal / tldr

fast and interactive tldr client written with go

tldr++

Community driven man pages improved with smart user interaction. tldr++ seperates itself from any other tldr client with convenient user guidance feature.

Features

• Fully Interactive (fill the command arguments easily)
• Search from commands to find your desired command (exact + fuzzy search)
• Smart file suggestions (further suggestions will be added)
• Simple implementation
• One of the fastest clients, even fastest (see Benchmarks)
• Easy to install. Supports all mainstream OS and platforms (Linux, MacOS, Windows)(arm, x86)
• Pure-go (even contains built-in git)

Installation

Refer to Release Page for binaries.

Or, you can build from source: (min. go 1.13 compiler is recommended)

go get github.com/isacikgoz/tldr/cmd/tldr

macOS using brew

brew install isacikgoz/taps/tldr

Use for different OS

You can use tldr++ for another OS by setting TLDR_OS envrionment to your desired OS such as linux, windows, osx etc.

Let's say you want to set it to Linux run the following command:

export TLDR_OS=linux

To make it permenant, you can add the line above to your shell rc file (e.g. bashrc, zshrc etc.)

Credits

• tldr-pages
• go-prompt
• fuzzy
• go-git
• kingpin
• color