npm install node-pty2

node-pty

![Build Status](https://travis-ci.org/Tyriar/node-pty)

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

This is useful for:

- Writing a terminal emulator (eg. via xterm.js).
- Getting certain programs to think you're a terminal, such as when you need a program to send you control sequences.

node-pty supports Linux, macOS and Windows. Windows support is possible by utilizing the winpty library.

Real-world Uses

node-pty powers many different terminal emulators, including:

- Microsoft Visual Studio Code
- Hyper
- Upterm

Do you use node-pty in your application as well? Please open a Pull Request to include it here. We would love to have it in our list.

Example Usage

js

var os = require('os');

var pty = require('node-pty');



var shell = os.platform() === 'win32' ? 'powershell.exe' : 'bash';



var ptyProcess = pty.spawn(shell, [], {

  name: 'xterm-color',

  cols: 80,

  rows: 30,

  cwd: process.env.HOME,

  env: process.env

});



ptyProcess.on('data', function(data) {

  console.log(data);

});



ptyProcess.write('ls\r');

ptyProcess.resize(100, 40);

ptyProcess.write('ls\r');





Building

bash

Install dependencies and build C++

npm install

Compile TypeScript -> JavaScript

npm run tsc





Debugging



On Windows, you can show the winpty agent console window by adding the environment variable

WINPTY_SHOW_CONSOLE=1

 to the pty's environment. See https://github.com/rprichard/winpty#debugging-winpty for more information.



Troubleshooting



Powershell gives error 8009001d



> Internal Windows PowerShell error.  Loading managed Windows PowerShell failed with error 8009001d.



This happens when PowerShell is launched with no

SystemRoot` environment variable present.

pty.js

This project is forked from chjj/pty.js with the primary goals being to provide better support for later Node.JS versions and Windows.

License