xterm is a terminal emulator library that can be used to create terminal interfaces in web applications. It provides a way to embed a terminal in a web page, allowing users to interact with a command-line interface directly from their browser.
Basic Terminal Initialization
This code initializes a basic terminal instance and attaches it to a DOM element with the ID 'terminal-container'.
const { Terminal } = require('xterm');
const terminal = new Terminal();
terminal.open(document.getElementById('terminal-container'));Customizing Terminal Appearance
This code demonstrates how to customize the appearance of the terminal, including the number of columns and rows, as well as the theme colors for the background and foreground.
const { Terminal } = require('xterm');
const terminal = new Terminal({
cols: 80,
rows: 24,
theme: {
background: '#1e1e1e',
foreground: '#ffffff'
}
});
terminal.open(document.getElementById('terminal-container'));Handling Terminal Input
This code sets up an event listener to handle user input in the terminal. The input data is logged to the console.
const { Terminal } = require('xterm');
const terminal = new Terminal();
terminal.open(document.getElementById('terminal-container'));
terminal.onData(data => {
console.log('User input:', data);
});Writing Data to Terminal
This code demonstrates how to write data to the terminal. The text 'Hello, World!' is written to the terminal, followed by a carriage return and newline.
const { Terminal } = require('xterm');
const terminal = new Terminal();
terminal.open(document.getElementById('terminal-container'));
terminal.write('Hello, World!\r\n');Blessed is a curses-like library for creating terminal user interfaces in Node.js. It provides a higher-level abstraction for building complex terminal applications, including support for widgets like buttons, text boxes, and more. Compared to xterm, blessed is more focused on creating full-fledged terminal applications rather than embedding a terminal emulator in a web page.
Terminal-kit is a comprehensive library for creating terminal applications in Node.js. It offers a wide range of features, including support for colors, styles, input handling, and more. Terminal-kit is similar to blessed in that it is designed for building terminal applications, but it provides more low-level control and flexibility. Unlike xterm, terminal-kit is not focused on web-based terminal emulation.
Node-pty is a library that provides bindings to pseudo terminals (PTYs) in Node.js. It allows you to spawn and interact with terminal processes programmatically. While node-pty does not provide a terminal emulator like xterm, it can be used in conjunction with xterm to handle the backend process management for a web-based terminal interface.
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.
bash, git etc.vim, tmux etc.bash. Xterm.js can be connected to processes like bash and let you interact with them (provide input, receive output)Xterm.js is used in several world-class applications to provide great terminal experiences.
xterm.js.xterm.js, socket.io, and ssh2.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.
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.
Run the following commands:
$ npm install
$ npm start
Then open http://0.0.0.0:3000 in a web browser.
First, ensure node-gyp is installed and configured correctly, then run these commands.
Note: Do not use ConEmu, as it seems to break the demo for some reason.
> npm install
> npm start
Then open http://127.0.0.1:3000 in a web browser.
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.
<!doctype html>
<html>
<head>
<link rel="stylesheet" href="bower_components/xterm.js/dist/xterm.css" />
<script src="bower_components/xterm.js/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.
Addons are JavaScript modules that attach functions to the Terminal prototype to extend its functionality. There are a handful available in the main repository in the dist/addons directory, you can even write your own (though they may break when the internals of xterm.js change across versions).
To use an addon, just include the JavaScript file after xterm.js and before the Terminal object has been instantiated. The function should then be exposed on the Terminal object:
<script src="node_modules/dist/xterm.js"></script>
<script src="node_modules/dist/addons/fit/fit.js"></script>
var xterm = new Terminal();
// init code...
xterm.fit();
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.
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 before.
The development of xterm.js does not require any special tool. All you need is an editor that supports JavaScript and a browser (if you would like to run the demo you will need Node.js to get all features).
It is recommended though to use a development tool that uses xterm.js internally, to develop for xterm.js. Eating our own dogfood has been proved extremely beneficial for this project. Known tools that use xterm.js internally are:
Visit https://lair.io/sourcelair/xterm and follow the instructions. All development will happen in your browser.
Download Visual Studio Code, clone xterm.js and you are all set.
You can start Eclipse Che with docker run eclipse/che start.
You can create a trial account or install an enterprise version with docker run codenvy/cli start.
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) 2014-2016, SourceLair, Private Company (www.sourcelair.com) (MIT License)
Copyright (c) 2012-2013, Christopher Jeffrey (MIT License)
FAQs
Full xterm terminal, in your browser
The npm package xterm receives a total of 269,084 weekly downloads. As such, xterm popularity was classified as popular.
We found that xterm demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.