https://github.com/eprovst/tldr

A tldr client in Go focusing on speed.
https://github.com/eprovst/tldr

Last synced: 3 months ago
JSON representation

A tldr client in Go focusing on speed.

• Host: GitHub
• URL: https://github.com/eprovst/tldr
• Owner: eprovst
• License: gpl-3.0
• Archived: true
• Created: 2018-12-10T14:24:23.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2022-08-03T12:42:23.000Z (over 2 years ago)
• Last Synced: 2024-08-02T20:48:07.385Z (6 months ago)
• Language: Go
• Homepage:
• Size: 175 KB
• Stars: 11
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• my-awesome - eprovst/tldr - 08 star:0.0k fork:0.0k A tldr client in Go focusing on speed. (Go)

README

        
> **Warning**  

> This client is, currently, **unmaintained**. Another fast implementation you could try is [tealdeer](https://github.com/dbrgn/tealdeer) written in Rust.  

> For other options, see [the tldr wiki](https://github.com/tldr-pages/tldr/wiki/tldr-pages-clients).

tldr

====

A [tldr](https://github.com/tldr-pages/tldr) client in Go, focusing on speed by storing pages in a database.

tldr is a collection of simplified, community-driven man pages. This application provides a fast and convenient access to these pages from the command line.

Here you see this client displaying the tldr page for Go:

![screenshot](screenshot.png)

As already mentioned is this client written in Go, we also uses etcd's [bbolt database](https://github.com/etcd-io/bbolt) which makes this client super fast.

Apart from being fast, the choice of Go also allows us to support all platforms which Go compiles to.

## Installation

You can use [Go](https://golang.org/)'s tooling

```

go get github.com/elecprog/tldr

go install github.com/elecprog/tldr

```

or download a binary for Linux or Windows from the [release page](https://github.com/elecprog/tldr/releases/latest/).

### Bash completion

On platforms that support it you can add bash completion by running:

```

sudo env "PATH=$PATH" sh -c "tldr --bash-completion > /etc/bash_completion.d/tldr"

sudo chmod 644 /etc/bash_completion.d/tldr

```

## Usage

- You can print the tldr page for a command by using:

  ```

  tldr command

  ```

- This client downloads all tldr pages on the first run (resulting in a database of about 800 KB) which should only take a couple of seconds. To redownload the pages and rebuild the database you can use:

  ```

  tldr -u

  ```

  The database is then stored in the cache directory of your platform.

- If you want all the commands matching a grep style regex, let's say `g[ie]t$`, use:

  ```

  tldr -s 'g[ie]t$'

  ```