tlcr

This README is the one indexed from the repository at its latest ref, not from the tag for this version.

# TLCR [![Build Status](https://travis-ci.org/porras/tlcr.svg?branch=master)](https://travis-ci.org/porras/tlcr)

`tlcr` is a simple terminal-based client for [TLDR pages](http://tldr-pages.github.io/), written in
[Crystal](http://crystal-lang.org/).

> *TLDR pages* is a collection of simplified and community-driven man pages.

![TLCR](tlcr.png)

`tlcr` is under development. It works and can be used, but testing and reporting issues is appreciated.

## Features

* Simple CLI
* Colorized Markdown rendering in the terminal
* Local file based cache
* Bash completion
* No dependencies
* Local file rendering (for authors)
* Batch download

## Installation

### Mac

(tested on Yosemite, reports on other versions welcome)

    $ brew tap porras/tap
    $ brew install tlcr

Or, if you want to install the latest, unreleased version:

    $ brew tap porras/tap
    $ brew install tlcr --HEAD

### Linux

TODO: Create binary packages for easy installation. Help welcome!

### From source

If there are no binary packages for your OS version, you can install `tlcr` building it from source. See
[Development](#development) for instructions.

## Usage

    Usage: tlcr [options] [command]
        -u, --update                     Force update (default: cache for 30 days)
        -r, --render                     Render local file (for authors)
        -d, --download                   Download the whole TLDR archive
        -h, --help                       Show this help

### Examples

Displaying a page:

    $ tlcr ls

Displaying a page, forcing its download (and the download of the index):

    $ tlcr --update ls

Displaying a page from a local file (useful if you're contributing to [TLDR pages](https://github.com/tldr-pages/tldr)
and want to have a look before submitting a patch):

    $ tlcr --render tldr/pages/common/ls.md

Downloading the whole archive (it will download everything at once and store it in the normal cache, where it will
expire, in the normal way, after 30 days, when it can be downloaded either completely again, or on demand page by page,
as normal):

    $ tlcr --download

### Bash completion

After having `tlcr` installed, add this to your `.bashrc`:

    eval "$(tlcr --completion)"

## Development

You need [Crystal 0.19.x](http://crystal-lang.org/docs/installation/index.html) installed (it might work with older
or newer versions, but that's the one that's tested).

After checking out the repo (or decompressing the tarball with the source code), run `shards` to get the development
dependencies, and run `crystal build tlcr.cr` (`crystal build --release tlcr.cr` if you intend to install it for real
use). The `tlcr` binary generated in the directory can be copied anywhere in your `$PATH`.

## Contributing

1. Fork it ( https://github.com/porras/tlcr/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

## Contributors

- [porras](https://github.com/porras) Sergio Gil - creator, maintainer