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.
- Simple CLI
- Colorized Markdown rendering in the terminal
- Local file based cache
- Bash completion
- No dependencies
TODO: Simple installation instructions will follow soon. For the time being, see Development.
Usage: tlcr [options] [command]
-u, --update Force update (default: cache for 30 days)
-h, --help Show this help
After having tlcr installed, add this to your .bashrc:
eval "$(tlcr --completion)"
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.
- Fork it ( https://github.com/porras/tlcr/fork )
- Create your feature branch (git checkout -b my-new-feature)
- Commit your changes (git commit -am 'Add some feature')
- Push to the branch (git push origin my-new-feature)
- Create a new Pull Request
- porras Sergio Gil - creator, maintainer