Go client for rprieto/tldr, with static binary downloads
Go
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib/tldr
.gitignore
LICENSE
README.md
main.go

README.md

Build Status

A work-in-progress Go client for tldr.

Setup

If you have Go installed, grab the latest version:

go get github.com/pranavraja/tldr

Binary releases for common platforms are available under Releases. These work without Go installed.

Prerequisites

If you installed using go get, make sure $GOPATH/bin is in your $PATH.

Usage

tldr <command>

Fetch the docs for command and render them to the terminal.

Hacking

Once you have cloned the repo, build using go build, run the tests using go test.

TODO (contributions welcome)

  • Improve rendering of command placeholders, like in sed 's/a/b/' {{filename}}
  • Caching of commands
  • Add a command-line flag to override the platform (currently only "common" is supported)
  • Improve multi-line command rendering