https://github.com/isacikgoz/tldr

fast and interactive tldr client written with go
https://github.com/isacikgoz/tldr

golang guidance interactive tldr tldr-pages

Last synced: about 2 months ago
JSON representation

fast and interactive tldr client written with go

• Host: GitHub
• URL: https://github.com/isacikgoz/tldr
• Owner: isacikgoz
• License: mit
• Created: 2018-12-19T13:11:36.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-06-23T13:36:07.000Z (over 1 year ago)
• Last Synced: 2024-06-18T20:19:05.347Z (3 months ago)
• Topics: golang, guidance, interactive, tldr, tldr-pages
• Language: Go
• Homepage: https://isacikgoz.me/tldr/
• Size: 10.9 MB
• Stars: 1,352
• Watchers: 12
• Forks: 48
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - tldr - fast and interactive tldr client written with go (Go)
• my-awesome - isacikgoz/tldr - pages pushed_at:2023-06 star:1.4k fork:0.0k fast and interactive tldr client written with go (Go)

README

        

![GitHub Actions](https://img.shields.io/github/actions/workflow/status/isacikgoz/tldr/ci.yml) ![GitHub All Releases](https://img.shields.io/github/downloads/isacikgoz/tldr/total.svg) [![Join the chat at https://gitter.im/tldrpp/community](https://badges.gitter.im/tldrpp/community.svg)](https://gitter.im/tldrpp/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) ![Release](https://img.shields.io/github/release/isacikgoz/tldr.svg)

# tldr++

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

![screenplay](img/screenplay.gif)

## 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](https://github.com/isacikgoz/tldr/wiki/Benchmarks))

- Easy to install. Supports all mainstream OS and platforms (Linux, MacOS, *Windows (*`v1.0` *excluded for a while*)(arm, x86)

- Pure-go (*even contains built-in git*)

## Installation

Refer to [Release Page](https://github.com/isacikgoz/tldr/releases) for binaries.

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

```bash

go install github.com/isacikgoz/tldr/cmd/tldr@latest

```

### macOS using brew

```bash

brew install isacikgoz/taps/tldr

```

### Windows using scoop

This is maintained by community and the version is `v0.6.1`. (`v1.0.0` does not have Windows support yet)

```powershell

scoop install 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:

```bash

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](https://github.com/tldr-pages/tldr)

- [go-prompt](https://github.com/c-bata/go-prompt)

- [fuzzy](https://github.com/sahilm/fuzzy)

- [go-git](https://github.com/src-d/go-git)

- [kingpin](https://github.com/alecthomas/kingpin)

- [color](https://github.com/fatih/color)