]>
Commit | Line | Data |
---|---|---|
22cc8079 | 1 | # [![xterm.js logo](logo.png)](https://xtermjs.org) |
51946a73 | 2 | |
e569b566 | 3 | [![xterm.js build status](https://api.travis-ci.org/sourcelair/xterm.js.svg)](https://travis-ci.org/sourcelair/xterm.js) [![Coverage Status](https://coveralls.io/repos/github/sourcelair/xterm.js/badge.svg)](https://coveralls.io/github/sourcelair/xterm.js) [![Gitter](https://badges.gitter.im/sourcelair/xterm.js.svg)](https://gitter.im/sourcelair/xterm.js?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) |
ab1526b0 | 4 | |
7e905763 | 5 | Xterm.js is a terminal front-end component written in JavaScript that works in the browser. |
561fc59d | 6 | |
0a74b9aa | 7 | It enables applications to provide fully featured terminals to their users and create great development experiences. |
561fc59d | 8 | |
7e905763 PK |
9 | ## Features |
10 | - **Text-based application support**: Use xterm.js to work with applications like `bash`, `git` etc. | |
11 | - **Curses-based application support**: Use xterm.js to work with applications like `vim`, `tmux` etc. | |
12 | - **Mouse events support**: Xterm.js captures mouse events like click and scroll and passes them to the terminal's back-end controlling process | |
13 | - **CJK (Chinese, Japanese, Korean) character support**: Xterm.js renders CJK characters seamlessly | |
14 | - **IME support**: Insert international (including CJK) characters using IME input with your keyboard | |
15 | - **Self-contained library**: Xterm.js works on its own. It does not require any external libraries like jQuery or React to work | |
0a74b9aa | 16 | - **Modular, event-based API**: Lets you build addons and themes with ease |
561fc59d | 17 | |
7e905763 PK |
18 | ## What xterm.js is not |
19 | - Xterm.js is not a terminal application that you can download and use on your computer | |
20 | - Xterm.js is not `bash`. Xterm.js can be connected to processes like `bash` and let you interact with them (provide input, receive output) | |
21 | ||
22 | ## Real-world uses | |
23 | Xterm.js is used in several world-class applications to provide great terminal experiences. | |
24 | ||
25 | - [**SourceLair**](https://www.sourcelair.com/): In-browser IDE that provides its users with fully-featured Linux terminals based on xterm.js | |
68b012ca | 26 | - [**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 |
771642d1 | 27 | - [**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 |
cd44fe7b | 28 | - [**Katacoda**](https://www.katacoda.com/): Katacoda is an Interactive Learning Platform for software developers, covering the latest Cloud Native technologies. |
6c29ccfb TJ |
29 | - [**Eclipse Che**](http://www.eclipse.org/che): Developer workspace server, cloud IDE, and Eclipse next-generation IDE. |
30 | - [**Codenvy**](http://www.codenvy.com): Cloud workspaces for development teams. | |
e7714830 | 31 | - [**CoderPad**](https://coderpad.io): Online interviewing platform for programmers. Run code in many programming languages, with results displayed by `xterm.js`. |
e58a6975 | 32 | - [**WebSSH2**](https://github.com/billchurch/WebSSH2): A web based SSH2 client using `xterm.js`, socket.io, and ssh2. |
365f9b4c | 33 | - [**Spyder Terminal**](https://github.com/spyder-ide/spyder-terminal): A full fledged system terminal embedded on Spyder IDE. |
44cfb2dc | 34 | - [**Cloud Commander**](https://cloudcmd.io "Cloud Commander"): Orthodox web file manager with console and editor. |
7e905763 PK |
35 | |
36 | 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. | |
74848936 | 37 | |
f3db84de DI |
38 | ## Browser Support |
39 | ||
7e905763 | 40 | 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: |
2c810ce7 | 41 | |
b61e81d5 DI |
42 | - Chrome 48+ |
43 | - Edge 13+ | |
44 | - Firefox 44+ | |
45 | - Internet Explorer 11+ | |
46 | - Opera 35+ | |
47 | - Safari 8+ | |
f3db84de | 48 | |
7e905763 | 49 | 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. |
2c810ce7 | 50 | |
289ff809 DI |
51 | ## Demo |
52 | ||
514eba0e BM |
53 | ### Linux or macOS |
54 | ||
55 | Run the following commands: | |
56 | ||
57 | ``` | |
58 | $ npm install | |
59 | $ npm start | |
60 | ``` | |
61 | ||
62 | Then open http://0.0.0.0:3000 in a web browser. | |
63 | ||
64 | ### Windows | |
65 | ||
66 | First, ensure [node-gyp](https://github.com/nodejs/node-gyp) is installed and configured correctly, then run these commands. | |
67 | ||
68 | Note: Do not use ConEmu, as it seems to break the demo for some reason. | |
289ff809 DI |
69 | |
70 | ``` | |
514eba0e BM |
71 | > npm install |
72 | > npm start | |
289ff809 DI |
73 | ``` |
74 | ||
514eba0e | 75 | Then open http://127.0.0.1:3000 in a web browser. |
289ff809 | 76 | |
4ee1e008 SD |
77 | ## Getting Started |
78 | ||
d018a547 | 79 | 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. |
4ee1e008 | 80 | ```html |
d018a547 SD |
81 | <!doctype html> |
82 | <html> | |
83 | <head> | |
84 | <link rel="stylesheet" href="bower_components/xterm.js/dist/xterm.css" /> | |
85 | <script src="bower_components/xterm.js/dist/xterm.js"></script> | |
86 | </head> | |
87 | <body> | |
88 | <div id="terminal"></div> | |
89 | <script> | |
90 | var term = new Terminal(); | |
d8f8b060 | 91 | term.open(document.getElementById('terminal')); |
d018a547 SD |
92 | term.write('Hello from \033[1;3;31mxterm.js\033[0m $ ') |
93 | </script> | |
94 | </body> | |
95 | </html> | |
4ee1e008 | 96 | ``` |
514eba0e | 97 | Finally instantiate the `Terminal` object and then call the `open` function with the DOM object of the `div`. |
4ee1e008 | 98 | |
dab80b58 DI |
99 | ## Addons |
100 | ||
c9eaae6b | 101 | 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). |
dab80b58 DI |
102 | |
103 | 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: | |
104 | ||
105 | ```html | |
c46e799d | 106 | <script src="node_modules/dist/xterm.js"></script> |
c9eaae6b | 107 | <script src="node_modules/dist/addons/fit/fit.js"></script> |
dab80b58 DI |
108 | ``` |
109 | ||
110 | ```js | |
111 | var xterm = new Terminal(); | |
112 | // init code... | |
9dd64dfb | 113 | xterm.fit(); |
dab80b58 DI |
114 | ``` |
115 | ||
7e905763 PK |
116 | ## Releases |
117 | ||
118 | Xterm.js follows a monthly release cycle roughly. | |
119 | ||
120 | The existing releases are available at this GitHub repo's [Releases](https://github.com/sourcelair/xterm.js/releases), while the roadmap is available as [Milestones](https://github.com/sourcelair/xterm.js/milestones). | |
121 | ||
7cd99d15 | 122 | ## Development and Contribution |
8ac7a6eb | 123 | |
7e905763 PK |
124 | Xterm.js is maintained by [SourceLair](https://www.sourcelair.com/) and a few external contributors, but we would love to receive contributions from everyone! |
125 | ||
8cf76cc6 | 126 | To contribute either code, documentation or issues to xterm.js please read the [Contributing document](CONTRIBUTING.md) 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. |
520f2bc9 | 127 | |
7cd99d15 PK |
128 | ## License Agreement |
129 | ||
130 | 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. | |
51946a73 | 131 | |
dd93e62a | 132 | Copyright (c) 2014-2016, SourceLair, Private Company ([www.sourcelair.com](https://www.sourcelair.com/home)) (MIT License) |
d24e0055 | 133 | |
51946a73 | 134 | Copyright (c) 2012-2013, Christopher Jeffrey (MIT License) |