xtermjs/xterm.js

Name: xterm.js

Owner: xterm.js

Description: Full xterm terminal, in your browser

Created: 2014-03-24 16:04:04.0

Updated: 2018-01-19 04:23:15.0

Pushed: 2018-01-19 03:01:17.0

Homepage: https://xtermjs.org/

Size: 3781

Language: TypeScript

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

xterm.js logo

xterm.js build status Coverage Status Gitter jsDelivr Hits

Xterm.js is a terminal front-end component written in JavaScript that works in the browser.

It enables applications to provide fully featured terminals to their users and create great development experiences.

Features
What xterm.js is not
Getting Started

First you need to install the module, we ship exclusively through npm so you need that installed and then add xterm.js as a dependency by running:

install xterm

To start using xterm.js on your browser, add the xterm.js and xterm.css to the head of your html page. Then create a <div id="terminal"></div> onto which xterm can attach itself.

ctype html>
tml>
<head>
  <link rel="stylesheet" href="node_modules/xterm/dist/xterm.css" />
  <script src="node_modules/xterm/dist/xterm.js"></script>
</head>
<body>
  <div id="terminal"></div>
  <script>
    var term = new Terminal();
    term.open(document.getElementById('terminal'));
    term.write('Hello from \033[1;3;31mxterm.js\033[0m $ ')
  </script>
</body>
html>

Finally instantiate the Terminal object and then call the open function with the DOM object of the div.

Importing

The proposed way to load xterm.js is via the ES6 module syntax.

rt { Terminal } from 'xterm';

Note: There are currently no typings for addons so you will need to upcast if using TypeScript, eg. (<any>xterm).fit().

Addons

Addons are JavaScript modules that extend the Terminal prototype with new methods and attributes to provide additional functionality. There are a handful available in the main repository in the src/addons directory and you can even write your own, by using xterm.js' public API.

To use an addon, just import the JavaScript module and pass it to Terminal's applyAddon method:

rt { Terminal } from xterm;
rt * as fit from 'xterm/lib/addons/fit/fit';


inal.applyAddon(fit);

xterm = new Terminal();  // Instantiate the terminal
m.fit();                 // Use the `fit` method, provided by the `fit` addon
Browser Support

Since xterm.js is typically implemented as a developer tool, only modern browsers are supported officially. Here is a list of the versions we aim to support:

Xterm.js works seamlessly in Electron apps and may even work on earlier versions of the browsers but these are the browsers we strive to keep working.

Real-world uses

Xterm.js is used in several world-class applications to provide great terminal experiences.

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

Demo

Xterm.js ships with a barebones demo implementation, designed for the development and evaluation of the library only. Exposing the demo to the public as is would introduce security risks for the host.

Below you can find instructions on how to run the demo on different platforms.

SourceLair

SourceLair will run the demo and builder in parallel automatically. Just make sure to choose the “Node.js” project type, when cloning the xterm.js repo (or just use this shortcut; https://lair.io/xtermjs/xtermjs).

Then open your project's Public URL to access the demo.

Docker

First, make sure you have Docker Engine 1.13.0 (or newer) and Docker Compose 1.10.0 (or newer). To run the demo and builder in parallel, run the following command in your terminal:

er-compose up

Then open http://0.0.0.0:3000 in a web browser to access the demo. If you prefer a different port than 3000 to access the xterm.js demo, then set the XTERMJS_PORT environment variable to the desired port.

Foreman (or other Procfile runner)

First, be sure that a C++ compiler such as GCC-C++ or Clang is installed, then run the following commands in your terminal:

install
man start  # Replace foreman with "honcho", "forego" etc. depending on your runner

Then open http://0.0.0.0:3000 in a web browser to access the demo.

Linux or macOS

First, be sure that a C++ compiler such as GCC-C++ or Clang is installed, then run the following commands in your terminal:

install
start      # Run this in its own terminal
run watch  # Run this in its own terminal

Then open http://0.0.0.0:3000 in a web browser to access the demo.

Windows

First, ensure node-gyp is installed and configured correctly, then run the following commands in your terminal:

install
start      # Run this in its own terminal
run watch  # Run this in its own terminal

Then open http://127.0.0.1:3000 in a web browser to access the demo.

Note: Do not use ConEmu, as it seems to break the demo for some reason.

Releases

Xterm.js follows a monthly release cycle roughly.

The existing releases are available at this GitHub repo's Releases, while the roadmap is available as Milestones.

Development and Contribution

Xterm.js is maintained by SourceLair and a few external contributors, but we would love to receive contributions from everyone!

To contribute either code, documentation or issues to xterm.js please read the Contributing document beforehand. The development of xterm.js does not require any special tool. All you need is an editor that supports JavaScript/TypeScript and a browser. You will need Node.js installed locally to get all the features working in the demo.

Code structure

src/ is roughly split up into areas of functionality such as renderer/ that handles all rendering and utils/ which provides general utility functions. The shared/ folder contains code that can be used from either the main thread or a web worker thread, all code inside a shared/ folder should only ever import other code from a shared/ folder to minimize the amount of code run what launching a web worker.

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.

Copyright (c) 2017-2018, The xterm.js authors (MIT License) Copyright (c) 2014-2017, SourceLair, Private Company (www.sourcelair.com) (MIT License) Copyright (c) 2012-2013, Christopher Jeffrey (MIT License)

This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.