Product
Introducing Enhanced Alert Actions and Triage Functionality
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
hyper-xterm
Advanced tools
Readme
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)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:
npm 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.
<!doctype html>
<html>
<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 \x1B[1;3;31mxterm.js\x1B[0m $ ')
</script>
</body>
</html>
Finally instantiate the Terminal
object and then call the open
function with the DOM object of the div
.
The proposed way to load xterm.js is via the ES6 module syntax.
import { Terminal } from 'xterm';
The full API for xterm.js is contained within the TypeScript declaration file, use the branch/tag picker in GitHub (w
) to navigate to the correct version of the API.
Note that some APIs are marked experimental, these are added so we can experiment with new ideas without committing to support it like a normal semver API. Note that these APIs can change radically between versions so be sure to read release notes if you plan on using experimental APIs.
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:
import { Terminal } from xterm;
import * as fit from 'xterm/lib/addons/fit/fit';
Terminal.applyAddon(fit);
var xterm = new Terminal(); // Instantiate the terminal
xterm.fit(); // Use the `fit` method, provided by the `fit` addon
You will also need to include the addon's CSS file if it has one in the folder.
There are currently no typings for addons if they are accessed via extending Terminal prototype, so you will need to upcast if using TypeScript, eg. (<any>xterm).fit()
.
Alternatively, you can import addon function and enhance the terminal on demand. This would have better typing support and is friendly to treeshaking. E.g.:
import { Terminal } from 'xterm';
import { fit } from 'xterm/lib/addons/fit/fit';
const xterm = new Terminal();
// Fit the terminal when necessary:
fit(xterm);
There are also the following third party addons available:
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.
The current full API documentation is available in the TypeScript declaration file on the repository, switch the tag (press w
when viewing the file) to point at the specific version tag you're using.
Xterm.js is used in several world-class applications to provide great terminal experiences.
xterm.js
.xterm.js
, socket.io, and ssh2.xterm.js
.xterm.js
, SJCL & websockets.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. Note: Please add any new contributions to the end of the list only.
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.
You can read the guide on the wiki to learn how to contribute and setup xterm.js for development.
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)
FAQs
Full xterm terminal, in your browser
The npm package hyper-xterm receives a total of 0 weekly downloads. As such, hyper-xterm popularity was classified as not popular.
We found that hyper-xterm demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer 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.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.