# terminal.js

> terminal emulation library for javascript.

Latest version **1.0.11** (published 2021-02-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install terminal.js
pnpm add terminal.js
yarn add terminal.js
bun add terminal.js
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.0.11 |
| Published | 2021-02-21 |
| First published | 2012-05-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 1.2 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 604 |
| Author | Enno Boland |
| Maintainers | gottox |
| Keywords | vt100, xterm, vt, terminal |

## Links

- npm: https://www.npmjs.com/package/terminal.js
- Repository: https://github.com/Gottox/terminal.js
- Homepage: http://github.com/Gottox/terminal.js
- Issues: https://github.com/Gottox/terminal.js/issues
- npm.io page: https://npm.io/package/terminal.js

## Alternatives

- [localforage](https://npm.io/package/localforage.md) — 6.2M weekly downloads
- [localforage-observable](https://npm.io/package/localforage-observable.md) — 30.8K weekly downloads
- [@y/y](https://npm.io/package/@y/y.md) — 30.1K weekly downloads
- [@metaobjectsdev/render](https://npm.io/package/@metaobjectsdev/render.md) — 3.5K weekly downloads
- [@ledgerhq/coin-algorand](https://npm.io/package/@ledgerhq/coin-algorand.md) — 1.1K weekly downloads

## Recent versions

- 1.0.11 (latest) — 2021-02-21
- 1.0.10 — 2017-09-07
- 1.0.9 — 2017-04-26
- 1.0.8 — 2017-02-09
- 1.0.7 — 2016-01-20
- 1.0.6 — 2015-10-14
- 1.0.5 — 2015-04-20
- 1.0.4 — 2015-04-16
- 1.0.3 — 2015-01-23
- 1.0.2 — 2015-01-23
- 1.0.1 — 2014-12-19
- 1.0.0 — 2014-12-16
- 0.1.2 — 2014-04-16
- 0.1.0 — 2013-04-30
- 0.0.3 — 2013-04-15
- … 2 more at https://npm.io/package/terminal.js/versions

## README

# terminal.js: terminal emulator library for browsers and node.js

[![Build Status](https://travis-ci.org/Gottox/terminal.js.png)](https://travis-ci.org/Gottox/terminal.js)

Terminal.js is a rendering engine for vt100-like terminals.
It is written from scratch and supports most commonly used escape sequences.

## Example

a simple demo using the [colors](https://www.npmjs.com/package/colors) module:

```javascript
var colors = require('colors'),
	Terminal = require('./index');

var terminal = new Terminal({columns: 20, rows: 2});

terminal.write("Terminal.js in rainbows".rainbow);

console.log(terminal.toString('ansi'));
```

There's also a webterminal using terminal.js:
[node-webterm](https://github.com/Gottox/node-webterm)

## Documentation

The documentation is generated using [JSDoc](http://usejsdoc.org/) and can be
found [here](http://gottox.de/terminal.js)

## Source

Source is developed at [Github](http://github.com/Gottox/terminal.js)

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