# ansi2html-extended
> Convert colored console output (ANSI shell escape codes) to HTML.
Latest version **0.0.4** (published 2015-04-10) · MIT license · 0 weekly downloads
## Install
```sh
npm install ansi2html-extended
pnpm add ansi2html-extended
yarn add ansi2html-extended
bun add ansi2html-extended
```
Provides the commands `a2h`, `ansi2html`.
## 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.0.4 |
| Published | 2015-04-10 |
| First published | 2015-02-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Jakub Gieryluk |
| Maintainers | jakub-g |
| Keywords | ansi, html, ansi2html, convert, console |
## Links
- npm: https://www.npmjs.com/package/ansi2html-extended
- Repository: https://github.com/jakub-g/ansi2html-extended
- Issues: https://github.com/jakub-g/ansi2html-extended/issues
- npm.io page: https://npm.io/package/ansi2html-extended
## Alternatives
- [@tsparticles/shape-image](https://npm.io/package/@tsparticles/shape-image.md) — 303.7K weekly downloads
- [@tsparticles/shape-line](https://npm.io/package/@tsparticles/shape-line.md) — 233.7K weekly downloads
- [stringify-attributes](https://npm.io/package/stringify-attributes.md) — 58.6K weekly downloads
- [mobile-drag-drop](https://npm.io/package/mobile-drag-drop.md) — 46.3K weekly downloads
- [@comunica/actor-rdf-parse-html](https://npm.io/package/@comunica/actor-rdf-parse-html.md) — 29.2K weekly downloads
## Recent versions
- 0.0.4 (latest) — 2015-04-10
- 0.0.3 — 2015-02-15
- 0.0.2 — 2015-02-15
- 0.0.1 — 2015-02-15
## README
# ansi2html-extended
[](http://travis-ci.org/jakub-g/ansi2html-extended)
[](https://www.npmjs.org/package/ansi2html-extended)
This module, written in JavaScript, is an extended fork of [https://github.com/mmalecki/ansispan](ansispan).
It converts an input string with ANSI escape codes (for colored console output etc.) into its
HTML equivalent. It can be used either as a nodejs module, or as a command-line utility.
Unlike original module, this module wraps text with ``s with defined CSS classes,
instead of hardcoded inline CSS strings.
Apart from that, it allows to:
- output either standalone HTML file, or just an HTML chunk
- pre-process the text by escaping HTML special characters
Tested on Windows (Git Bash / MINGW).
It requires nodejs and npm. If you don't have node, grab it at [nodejs.org](https://nodejs.org).
Node installer bundles npm (node package manager).
Tested on nodejs 0.10.
## API
##### `a2h.fromStream(cfg, inputStream, outputStream)`
Read text from `inputStream` and write HTML to `outputStream`.
##### `a2h.fromStream(cfg)`
Read text from `stdin` and write HTML to `stdout`.
##### `a2h.fromString(string)`
##### `a2h.fromString(cfg, string)`
Read input text String `string` and return HTML as `String`
## Configuration
##### `cfg.standalone` Boolean (default: `true` when input is stream, `false` when input is string)
If `true`, output will be a valid HTML file, and it will contain color palette in the ``,
as a `style` tag. Otherwise, only a HTML chunk will be generated.
##### `cfg.wrapped` Boolean (defaults to value of `cfg.standalone`)
Whether to wrap the passed string in ``.
##### `cfg.escapeHtml` Boolean (default: `true`)
Whether HTML entities in input string should be escaped (`&` -> `&` etc.).
##### `cfg.palette` Object (optional)
This allows you to override the default colors.
By default, it is assumed that console is `white` text on `black` background, and HTML
named colors are used for escape codes, i.e. ANSI 34 and 44 will use HTML `blue` color.
You can override each of the colors by passing any of the following keys:
`black`, `white`, `red`, `green`, `blue`, `yellow`, `purple`, `cyan`.
You can also override each of them *separately for foreground and background* using
`fg_black`, `bg_black` and so on.
You can override default colors of the console by either overriding `black` and `white`,
or directly via `bg` and `fg`.
Example:
```js
palette: {
bg: '#222222',
fg: '#eeeeee',
fg_red:'#ff0000',
bg_red:'#dd0000',
green: '#00cc3e'
}
```
## Usage as a nodejs module
```sh
$ npm install --save-dev ansi2html-extended
```
```js
var a2h = require('ansi2html-extended');
var cfg = {
standalone: true,
palette: {
black: '#222222',
white: '#eeeeee'
}
}
// read text from stdin and output HTML to stdout
a2h.fromStream(cfg);
// you can also just pass a string and get a string returned
a2h.fromString("[33mcommit d0fb3a8a5487559e8a2d76735f04b5a02b242838[m")
// returns `commit d0fb3a8a5487559e8a2d76735f04b5a02b242838`
// you can pass cfg as a first parameter too
a2h.fromString({
wrapped: true
}, "[33mcommit d0fb3a8a5487559e8a2d76735f04b5a02b242838[m")
// returns `commit d0fb3a8a5487559e8a2d76735f04b5a02b242838`
```
## Usage from command line
```sh
# this will create two symlinks in PATH: `ansi2html` and `a2h`
$ npm install -g ansi2html-extended
# Ask git for colored summary of last commit, and pipe it to a2h
# This prints to stdout by default
# Note we explicitly ask for --color; git disables colors when piping
$ git show --stat --color | a2h
# It will be more interesting when we save it to a file...
$ git show --stat --color | a2h > examples/git-show-stat.html
$ firefox examples/git-show-stat.html
```
See the live rendered [`examples/git-show-stat.html`](https://rawgit.com/jakub-g/ansi2html-extended/master/examples/git-show-stat.html)
The following options are used when `a2h` is invoked from command line:
```js
{
standalone: true,
escapeHtml: true,
palette: {
black: '#222222',
white: '#eeeeee',
red: '#dd0000',
green: '#00cc3e',
blue: '#0099ff',
yellow:'#eeee00',
purple:'#bb00bb',
cyan: '#eeeeee'
}
}
```
## License
MIT � [Jakub Gieryluk](http://jakub-g.github.io)
---
_Source: https://npm.io/package/ansi2html-extended · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._