# pty.js-prebuilt

> Prebuilt fork of Christopher Jeffrey's pty.js pseudo terminals for node.

Latest version **0.0.3** (published 2017-04-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install pty.js-prebuilt
pnpm add pty.js-prebuilt
yarn add pty.js-prebuilt
bun add pty.js-prebuilt
```

## 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.3 |
| Published | 2017-04-02 |
| First published | 2017-04-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | yes |
| GitHub stars | 0 |
| Author | Michael Marucheck |
| Maintainers | rightparen |
| Keywords | pty, tty, terminal |

## Links

- npm: https://www.npmjs.com/package/pty.js-prebuilt
- Repository: https://github.com/rightparen/pty.js-prebuilt
- Issues: https://github.com/rightparen/pty.js-prebuilt/issues
- npm.io page: https://npm.io/package/pty.js-prebuilt

## Dependencies (2)

- [extend](https://npm.io/package/extend.md) ~1.2.1
- [node-pre-gyp](https://npm.io/package/node-pre-gyp.md) ^0.6.34

## 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

- 0.0.3 (latest) — 2017-04-02
- 0.0.2 — 2017-04-02
- 0.0.1 — 2017-04-02
- 0.0.0 — 2017-04-02

## README

# pty.js

[![Build Status](https://travis-ci.org/rightparen/pty.js-prebuilt.svg?branch=master)](https://travis-ci.org/rightparen/pty.js-prebuilt)

STILL UNDER TESTING -- PLEASE DO NOT USE YET

Fork of [pty.js](https://github.com/chjj/pty.js) prebuilt for Mac and Linux.

## About

`pty.js-prebuilt` includes prebuilt binaries of [pty.js](https://github.com/chjj/pty.js) for Mac and Linux for major versions of node.js and electron. It is meant for use in [Atom packages](https://atom.io/packages) where your end-user might not have a proper build toolchain.

This module is not meant to be built by the end-user and does not include the necessary files to do so.

This module implements
`forkpty(3)` bindings for node.js. This allows you to fork processes with pseudo
terminal file descriptors. It returns a terminal object which allows reads
and writes.

This is useful for:

- Writing a terminal emulator.
- Getting certain programs to *think* you're a terminal. This is useful if
  you need a program to send you control sequences.

## Example Usage

``` js
var pty = require('pty.js-prebuilt');

var term = pty.spawn('bash', [], {
  name: 'xterm-color',
  cols: 80,
  rows: 30,
  cwd: process.env.HOME,
  env: process.env
});

term.on('data', function(data) {
  console.log(data);
});

term.write('ls\r');
term.resize(100, 40);
term.write('ls /\r');

console.log(term.process);
```

## Todo

- Add tcsetattr(3), tcgetattr(3).
- Add a way of determining the current foreground job for platforms other
  than Linux and OSX/Darwin.

## Contribution and License Agreement

If you contribute code to this project, you are implicitly allowing your code
to be distributed under the MIT license. You are also implicitly verifying that
all code is your original work. `</legalese>`

## License

Copyright (c) 2012-2015, Christopher Jeffrey (MIT License).
Copyright (c) 2017, Michael Marucheck (MIT License).

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