https://github.com/rstacruz/hicat

Command-line syntax highlighter
https://github.com/rstacruz/hicat

Last synced: about 6 hours ago
JSON representation

Command-line syntax highlighter

• Host: GitHub
• URL: https://github.com/rstacruz/hicat
• Owner: rstacruz
• Created: 2014-07-30T03:33:57.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2022-11-10T10:22:02.000Z (about 2 years ago)
• Last Synced: 2024-12-13T07:14:24.841Z (8 days ago)
• Language: JavaScript
• Size: 2.39 MB
• Stars: 406
• Watchers: 9
• Forks: 54
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: History.md

Awesome Lists containing this project

• fucking-awesome-readme - rstacruz/hicat - GIF demo. Easy installation and setup sections with screenshots. Build badges. Great examples of use cases. (Examples)
• awesome-readme - rstacruz/hicat - GIF demo. Easy installation and setup sections with screenshots. Build badges. Great examples of use cases. (Examples)
• awesome-readme - rstacruz/hicat - GIF demo. Easy installation and setup sections with screenshots. Build badges. Great examples of use cases. (Examples)

README

        
# hicat :cat:

![image](https://raw.githubusercontent.com/rstacruz/hicat/gh-pages/hicat.gif)

`cat` with syntax highlighting. The language is auto-detected through the file

extension.

```sh

hicat index.js

```

Pipe something to `hicat`. The language will be inferred from the contents.

```sh

curl http://example.com | hicat

```

If hicat fails to detect a language, specify it using `-l LANG`.

```sh

curl http://example.com | hicat -l xml

```

[![Status](https://travis-ci.org/rstacruz/hicat.svg?branch=master)](https://travis-ci.org/rstacruz/hicat)

## Installation

```sh

npm install -g hicat

```

[![npm version](https://badge.fury.io/js/hicat.svg)](https://npmjs.org/package/hicat "View this project on npm")

Usage:

    $ hicat --help

      Usage:

          hicat [options] FILE

          ... | hicat [options]

      Options:

          -h, --help         print usage information

          -v, --version      show version info and exit

          -l, --lang LANG    use a given language

              --languages    list available languages

              --no-pager     disable the pager

## Tips and tricks

Add an alias to your `~/.bashrc` to save a few keystrokes.

```sh

alias hi=hicat

```

## Btw

[highlight.js] powers the syntax highlighter engine.

## Thanks

**hicat** © 2014+, Rico Sta. Cruz. Released under the [MIT License].


Authored and maintained by Rico Sta. Cruz with help from [contributors].

> [ricostacruz.com](http://ricostacruz.com)  · 

> GitHub [@rstacruz](https://github.com/rstacruz)  · 

> Twitter [@rstacruz](https://twitter.com/rstacruz)

[mit license]: https://mit-license.org/

[contributors]: https://github.com/rstacruz/hicat/contributors

[highlight.js]: https://highlightjs.org