Skip to content
This repository

A terminal for your browser, using node/express/

Octocat-spinner-32 bin misc. comments. March 02, 2014
Octocat-spinner-32 img readme again. remove src/ February 25, 2012
Octocat-spinner-32 lib misc. comments. March 02, 2014
Octocat-spinner-32 man misc. comments. January 03, 2013
Octocat-spinner-32 static remove old window focus shortcuts. August 18, 2013
Octocat-spinner-32 .gitignore move pty.node February 14, 2012
Octocat-spinner-32 .npmignore move example and tests to term.js. August 08, 2013
Octocat-spinner-32 LICENSE misc. comments. January 03, 2013
Octocat-spinner-32 misc. comments. March 02, 2014
Octocat-spinner-32 index.js up February 03, 2012
Octocat-spinner-32 package.json use pty.js v0.2.4. March 06, 2014


A terminal in your browser using node.js and Based on Fabrice Bellard's vt100 for jslinux.

For the standalone web terminal, see term.js.

For the lowlevel terminal spawner, see pty.js.



vim & alsamixer



  • Tabs, Stacking Windows, Maximizable Terminals
  • Screen/Tmux-like keys (optional)
  • Ability to efficiently render programs: vim, mc, irssi, vifm, etc.
  • Support for xterm mouse events
  • 256 color support
  • Persistent sessions


$ npm install tty.js


tty.js is an app, but it's also possible to hook into it programatically.

var tty = require('tty.js');

var app = tty.createServer({
  shell: 'bash',
  users: {
    foo: 'bar'
  port: 8000

app.get('/foo', function(req, res, next) {



Configuration is stored in ~/.tty.js/config.json or ~/.tty.js as a single JSON file. An example configuration file looks like:

  "users": {
    "hello": "world"
  "https": {
    "key": "./server.key",
    "cert": "./server.crt"
  "port": 8080,
  "hostname": "",
  "shell": "sh",
  "shellArgs": ["arg1", "arg2"],
  "static": "./static",
  "limitGlobal": 10000,
  "limitPerUser": 1000,
  "localOnly": false,
  "cwd": ".",
  "syncSession": false,
  "sessionTimeout": 600000,
  "log": true,
  "io": { "log": false },
  "debug": false,
  "term": {
    "termName": "xterm",
    "geometry": [80, 24],
    "scrollback": 1000,
    "visualBell": false,
    "popOnBell": false,
    "cursorBlink": false,
    "screenKeys": false,
    "colors": [

Usernames and passwords can be plaintext or sha1 hashes.

256 colors

If tty.js fails to check your terminfo properly, you can force your TERM to xterm-256color by setting "termName": "xterm-256color" in your config.


tty.js currently has https as an option. It also has express' default basic auth middleware as an option, until it possibly gets something more robust. It's ultimately up to you to make sure no one has access to your terminals but you.


  • tty.js --port 3000 - start and bind to port 3000.
  • tty.js --daemonize - daemonize process.
  • tty.js --config ~/my-config.json - specify config file.


The main goal of tty.js is to eventually write a full xterm emulator. This goal has almost been reached, but there are a few control sequences not implemented fully. TERM should render everything fine when set to xterm.


tty.js should ultimately be able to work on any unix that implements unix98 tty's and forkpty(3). tty.js builds on linux and osx, and it should build on NetBSD, FreeBSD, and OpenBSD as well. If you have trouble building, please post an issue.


The distance to go before full xterm compatibility.

  • VT52 codes for compatibility
  • All vt400 rectangle sequences
  • Remaining DEC private modes
  • Miscellaneous sequences: cursor shape, window title
  • Origin Mode, Insert Mode
  • Proper Tab Setting

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>


Copyright (c) 2012-2014, Christopher Jeffrey (MIT License)

Something went wrong with that request. Please try again.