# hicat

> Command-line syntax highlighter.

Latest version **0.9.0** (published 2021-04-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install hicat
pnpm add hicat
yarn add hicat
bun add hicat
```

Provides the command `hicat`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.9.0 |
| Published | 2021-04-08 |
| First published | 2014-07-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 27.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 402 |
| Author | Rico Sta. Cruz |
| Maintainers | rstacruz |

## Links

- npm: https://www.npmjs.com/package/hicat
- Repository: https://github.com/rstacruz/hicat
- Homepage: https://github.com/rstacruz/hicat#readme
- Issues: https://github.com/rstacruz/hicat/issues
- npm.io page: https://npm.io/package/hicat

## Dependencies (3)

- [minimist](https://npm.io/package/minimist.md) ^1.2.5
- [highlight.js](https://npm.io/package/highlight.js.md) ^10.5.0
- [html-entities](https://npm.io/package/html-entities.md) ^2.0.6

## Recent versions

- 0.9.0 (latest) — 2021-04-08
- 0.8.0 — 2020-12-15
- 0.7.0 — 2015-05-20
- 0.6.2 — 2014-11-10
- 0.6.1 — 2014-08-04
- 0.6.0 — 2014-08-04
- 0.5.1 — 2014-08-03
- 0.5.0 — 2014-07-31
- 0.4.1 — 2014-07-31
- 0.4.0 — 2014-07-31
- 0.3.1 — 2014-07-30
- 0.3.0 — 2014-07-30
- 0.2.3 — 2014-07-30
- 0.2.2 — 2014-07-30
- 0.2.0 — 2014-07-30
- … 1 more at https://npm.io/package/hicat/versions

## 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].<br>
Authored and maintained by Rico Sta. Cruz with help from [contributors].

> [ricostacruz.com](http://ricostacruz.com) &nbsp;&middot;&nbsp;
> GitHub [@rstacruz](https://github.com/rstacruz) &nbsp;&middot;&nbsp;
> Twitter [@rstacruz](https://twitter.com/rstacruz)

[mit license]: https://mit-license.org/
[contributors]: https://github.com/rstacruz/hicat/contributors
[highlight.js]: https://highlightjs.org

---
_Source: https://npm.io/package/hicat · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._