UNPKG

1.72 kBMarkdownView Raw
1# hicat :cat:
2
3<img src="http://ricostacruz.com/hicat/hicat.gif">
4
5`cat` with syntax highlighting. The language is auto-detected through the file
6extension.
7
8 hicat index.js
9
10Pipe something to `hicat`. The language will be inferred from the contents.
11
12 curl http://site.com | hicat
13
14If hicat fails to detect a language, specify it using `-l LANG`.
15
16 curl http://site.com | hicat -l xml
17
18[![Status](https://travis-ci.org/rstacruz/hicat.svg?branch=master)](https://travis-ci.org/rstacruz/hicat)
19
20Installation
21------------
22
23 $ npm install -g hicat
24
25[![npm version](https://badge.fury.io/js/hicat.svg)](https://npmjs.org/package/hicat "View this project on npm")
26
27Usage:
28
29 $ hicat --help
30
31 Usage:
32 hicat [options] FILE
33 ... | hicat [options]
34
35 Options:
36 -h, --help print usage information
37 -v, --version show version info and exit
38 -l, --lang LANG use a given language
39 --languages list available languages
40 --no-pager disable the pager
41
42Tips and tricks
43---------------
44
45Add an alias to your `~/.bashrc` to save a few keystrokes.
46
47 alias hi=hicat
48
49Btw
50---
51
52[highlight.js] powers the syntax highlighter engine.
53
54Thanks
55------
56
57**hicat** © 2014+, Rico Sta. Cruz. Released under the [MIT License].<br>
58Authored and maintained by Rico Sta. Cruz with help from [contributors].
59
60> [ricostacruz.com](http://ricostacruz.com) &nbsp;&middot;&nbsp;
61> GitHub [@rstacruz](https://github.com/rstacruz) &nbsp;&middot;&nbsp;
62> Twitter [@rstacruz](https://twitter.com/rstacruz)
63
64[MIT License]: http://mit-license.org/
65[contributors]: http://github.com/rstacruz/hicat/contributors
66[highlight.js]: http://highlightjs.org