You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+24-24Lines changed: 24 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,11 +6,11 @@ Xterm.js is a front-end component written in TypeScript that lets applications b
6
6
7
7
## Features
8
8
9
-
-**Terminal apps just work**: Xterm.js works with most terminal apps such as `bash`, `vim` and `tmux`, this includes support for curses-based apps and mouse event support.
9
+
-**Terminal apps just work**: Xterm.js works with most terminal apps such as `bash`, `vim`, and `tmux`, including support for curses-based apps and mouse events.
10
10
-**Performant**: Xterm.js is *really* fast, it even includes a GPU-accelerated renderer.
11
-
-**Rich unicode support**: Supports CJK, emojis and IMEs.
11
+
-**Rich Unicode support**: Supports CJK, emojis, and IMEs.
12
12
-**Self-contained**: Requires zero dependencies to work.
13
-
-**Accessible**: Screen reader and minimum contrast ratio support can be turned on
13
+
-**Accessible**: Screen reader and minimum contrast ratio support can be turned on.
14
14
-**And much more**: Links, theming, addons, well documented API, etc.
15
15
16
16
## What xterm.js is not
@@ -20,13 +20,13 @@ Xterm.js is a front-end component written in TypeScript that lets applications b
20
20
21
21
## Getting Started
22
22
23
-
First you need to install the module, we ship exclusively through [npm](https://www.npmjs.com/) so you need that installed and then add xterm.js as a dependency by running:
23
+
First, you need to install the module, we ship exclusively through [npm](https://www.npmjs.com/), so you need that installed and then add xterm.js as a dependency by running:
24
24
25
-
```
25
+
```bash
26
26
npm install xterm
27
27
```
28
28
29
-
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. Finally instantiate the `Terminal` object and then call the `open` function with the DOM object of the `div`.
29
+
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. Finally, instantiate the `Terminal` object and then call the `open` function with the DOM object of the `div`.
30
30
31
31
```html
32
32
<!doctype html>
@@ -58,7 +58,7 @@ import { Terminal } from 'xterm';
58
58
59
59
⚠️ *This section describes the new addon format introduced in v3.14.0, see [here](https://github.com/xtermjs/xterm.js/blob/3.14.2/README.md#addons) for the instructions on the old format*
60
60
61
-
Addons are separate modules that extend the `Terminal` by building on the [xterm.js API](https://github.com/xtermjs/xterm.js/blob/master/typings/xterm.d.ts). To use an addon you first need to install it in your project:
61
+
Addons are separate modules that extend the `Terminal` by building on the [xterm.js API](https://github.com/xtermjs/xterm.js/blob/master/typings/xterm.d.ts). To use an addon, you first need to install it in your project:
62
62
63
63
```bash
64
64
npm i -S xterm-addon-web-links
@@ -76,7 +76,7 @@ const terminal = new Terminal();
76
76
terminal.loadAddon(newWebLinksAddon());
77
77
```
78
78
79
-
The xterm.js team maintains the following addons but they can be built by anyone:
79
+
The xterm.js team maintains the following addons, but anyone can build them:
80
80
81
81
-[`xterm-addon-attach`](https://github.com/xtermjs/xterm.js/tree/master/addons/xterm-addon-attach): Attaches to a server running a process via a websocket
82
82
-[`xterm-addon-fit`](https://github.com/xtermjs/xterm.js/tree/master/addons/xterm-addon-fit): Fits the terminal to the containing element
@@ -85,23 +85,23 @@ The xterm.js team maintains the following addons but they can be built by anyone
85
85
86
86
## Browser Support
87
87
88
-
Since xterm.js is typically implemented as a developer tool, only modern browsers are supported officially. Specifically the latest versions of *Chrome*, *Edge*, *Firefox* and *Safari*.
88
+
Since xterm.js is typically implemented as a developer tool, only modern browsers are supported officially. Specifically the latest versions of *Chrome*, *Edge*, *Firefox*, and *Safari*.
89
89
90
90
We also partially support *Internet Explorer 11*, meaning xterm.js should work for the most part, but we reserve the right to not provide workarounds specifically for it unless it's absolutely necessary to get the basic input/output flow working.
91
91
92
-
Xterm.js works seamlessly in [Electron](https://electronjs.org/) apps and may even work on earlier versions of the browsers, these are the versions we strive to keep working.
92
+
Xterm.js works seamlessly in [Electron](https://electronjs.org/) apps and may even work on earlier versions of the browsers. These are the versions we strive to keep working.
93
93
94
94
## API
95
95
96
96
The full API for xterm.js is contained within the [TypeScript declaration file](https://github.com/xtermjs/xterm.js/blob/master/typings/xterm.d.ts), use the branch/tag picker in GitHub (`w`) to navigate to the correct version of the API.
97
97
98
-
Note that some APIs are marked *experimental*, these are added to enable experimentation with new ideas without committing to support it like a normal [semver](https://semver.org/) API. Note that these APIs can change radically between versions so be sure to read release notes if you plan on using experimental APIs.
98
+
Note that some APIs are marked *experimental*, these are added to enable experimentation with new ideas without committing to support it like a normal [semver](https://semver.org/) API. Note that these APIs can change radically between versions, so be sure to read release notes if you plan on using experimental APIs.
99
99
100
100
## Real-world uses
101
101
Xterm.js is used in several world-class applications to provide great terminal experiences.
102
102
103
103
-[**SourceLair**](https://www.sourcelair.com/): In-browser IDE that provides its users with fully-featured Linux terminals based on xterm.js.
104
-
-[**Microsoft Visual Studio Code**](http://code.visualstudio.com/): Modern, versatile and powerful open source code editor that provides an integrated terminal based on xterm.js.
104
+
-[**Microsoft Visual Studio Code**](http://code.visualstudio.com/): Modern, versatile, and powerful open source code editor that provides an integrated terminal based on xterm.js.
105
105
-[**ttyd**](https://github.com/tsl0922/ttyd): A command-line tool for sharing terminal over the web, with fully-featured terminal emulation based on xterm.js.
106
106
-[**Katacoda**](https://www.katacoda.com/): Katacoda is an Interactive Learning Platform for software developers, covering the latest Cloud Native technologies.
@@ -113,10 +113,10 @@ Xterm.js is used in several world-class applications to provide great terminal e
113
113
-[**Next Tech**](https://next.tech"Next Tech"): Online platform for interactive coding and web development courses. Live container-backed terminal uses xterm.js.
114
114
-[**RStudio**](https://www.rstudio.com/products/RStudio"RStudio"): RStudio is an integrated development environment (IDE) for R.
115
115
-[**Terminal for Atom**](https://github.com/jsmecham/atom-terminal-tab): A simple terminal for the Atom text editor.
116
-
-[**Eclipse Orion**](https://orionhub.org): A modern, open source software development environment that runs in the cloud. Code, deploy and run in the cloud.
116
+
-[**Eclipse Orion**](https://orionhub.org): A modern, open source software development environment that runs in the cloud. Code, deploy, and run in the cloud.
117
117
-[**Gravitational Teleport**](https://github.com/gravitational/teleport): Gravitational Teleport is a modern SSH server for remotely accessing clusters of Linux servers via SSH or HTTPS.
118
118
-[**Hexlet**](https://en.hexlet.io): Practical programming courses (JavaScript, PHP, Unix, databases, functional programming). A steady path from the first line of code to the first job.
119
-
-[**Selenoid UI**](https://github.com/aerokube/selenoid-ui): Simple UI for the scallable golang implementation of Selenium Hub named Selenoid. We use XTerm for streaming logs over websockets from docker containers.
119
+
-[**Selenoid UI**](https://github.com/aerokube/selenoid-ui): Simple UI for the scalable golang implementation of Selenium Hub named Selenoid. We use XTerm for streaming logs over websockets from docker containers.
120
120
-[**Portainer**](https://portainer.io): Simple management UI for Docker.
121
121
-[**SSHy**](https://github.com/stuicey/SSHy): HTML5 Based SSHv2 Web Client with E2E encryption utilising xterm.js, SJCL & websockets.
122
122
-[**JupyterLab**](https://github.com/jupyterlab/jupyterlab): An extensible computational environment for Jupyter, supporting interactive data science and scientific computing across all programming languages.
@@ -167,17 +167,17 @@ Xterm.js is used in several world-class applications to provide great terminal e
167
167
-[**Laravel Ssh Web Client**](https://github.com/roke22/Laravel-ssh-client): Laravel server inventory with ssh web client to connect at server using xterm.js
168
168
-[**Repl.it**](https://repl.it): Collaborative browser based IDE with support for 50+ different languages.
169
169
-[**TeleType**](https://github.com/akshaykmr/TeleType): cli tool that allows you to share your terminal online conveniently. Show off mad cli-fu, help a colleague, teach, or troubleshoot.
170
-
-[**Intervue**](https://www.intervue.io): Pair programming for interviews. Multiple programming languages supported, with results displayed by xterm.js.
171
-
-[**TRASA**](https://trasa.io): Zero trust access to Web, SSH, RDP and Database services.
170
+
-[**Intervue**](https://www.intervue.io): Pair programming for interviews. Multiple programming languages are supported, with results displayed by xterm.js.
171
+
-[**TRASA**](https://trasa.io): Zero trust access to Web, SSH, RDP, and Database services.
172
172
-[**Commas**](https://github.com/CyanSalt/commas): Commas is a hackable terminal and command runner.
173
173
-[**Devtron**](https://github.com/devtron-labs/devtron): Software Delivery Workflow For Kubernetes.
174
174
-[**NxShell**](https://github.com/nxshell/nxshell): An easy to use new terminal for SSH.
175
175
-[**gifcast**](https://dstein64.github.io/gifcast/): Converts an asciinema cast to an animated GIF.
176
-
-[**WizardWebssh**](https://gitlab.com/mikeramsey/wizardwebssh): A terminal with Pyqt5 Widget for embedding which can be used as an ssh client to connect to your ssh servers. It is written in Python, based on tornado, paramiko and xterm.js.
177
-
-[**Wizard Assistant**](https://wizardassistant.com/): Wizard Assistant comes with advanced automation tools, preloaded common and special time-saving commands, and a builtin SSH terminal. Now you can remotely administer, troubleshoot, and analyze any system with ease.
176
+
-[**WizardWebssh**](https://gitlab.com/mikeramsey/wizardwebssh): A terminal with Pyqt5 Widget for embedding, which can be used as an ssh client to connect to your ssh servers. It is written in Python, based on tornado, paramiko, and xterm.js.
177
+
-[**Wizard Assistant**](https://wizardassistant.com/): Wizard Assistant comes with advanced automation tools, preloaded common and special time-saving commands, and a built-in SSH terminal. Now you can remotely administer, troubleshoot, and analyze any system with ease.
178
178
[And much more...](https://github.com/xtermjs/xterm.js/network/dependents)
179
179
180
-
Do you use xterm.js in your application as well? Please [open a Pull Request](https://github.com/sourcelair/xterm.js/pulls) 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.
180
+
Do you use xterm.js in your application as well? Please [open a Pull Request](https://github.com/sourcelair/xterm.js/pulls) to include it here. We would love to have it on our list. Note: Please add any new contributions to the end of the list only.
181
181
182
182
## Releases
183
183
@@ -187,21 +187,21 @@ All current and past releases are available on this repo's [Releases page](https
187
187
188
188
### Beta builds
189
189
190
-
Our CI releases beta builds to npm for every change that goes into master, install the latest beta build with:
190
+
Our CI releases beta builds to npm for every change that goes into master. Install the latest beta build with:
191
191
192
-
```
192
+
```bash
193
193
npm install -S xterm@beta
194
194
```
195
195
196
-
These should generally be stable but some bugs may slip in, we recommend using the beta build primarily to test out new features and for verifying bug fixes.
196
+
These should generally be stable, but some bugs may slip in. We recommend using the beta build primarily to test out new features and to verify bug fixes.
197
197
198
198
## Contributing
199
199
200
-
You can read the [guide on the wiki](https://github.com/xtermjs/xterm.js/wiki/Contributing) to learn how to contribute and setup xterm.js for development.
200
+
You can read the [guide on the wiki](https://github.com/xtermjs/xterm.js/wiki/Contributing) to learn how to contribute and set up xterm.js for development.
201
201
202
202
## License Agreement
203
203
204
-
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.
204
+
If you contribute code to this project, you implicitly allow your code to be distributed under the MIT license. You are also implicitly verifying that all code is your original work.
0 commit comments