Skip to content
This repository has been archived by the owner on Apr 11, 2024. It is now read-only.

Latest commit

 

History

History
91 lines (58 loc) · 2.79 KB

README.md

File metadata and controls

91 lines (58 loc) · 2.79 KB
Raw

TLCR Build Status

tlcr is a simple terminal-based client for TLDR pages, written in Crystal.

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

TLCR

tlcr is on an early stage of development. It mostly works and can be used, but testing and issues reporting 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 update
$ brew install tlcr

Linux

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

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 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.10.0 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 Sergio Gil - creator, maintainer