README.md

   1 # [![xterm.js logo](logo.png)](https://xtermjs.org)
   2
   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)
   4
   5 Xterm.js is a terminal front-end component written in JavaScript that works in the browser.
   6
   7 It enables applications to provide fully featured terminals to their users and create great development experiences.
   8
   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
  16 - **Modular, event-based API**: Lets you build addons and themes with ease
  17
  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
  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
  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
  28 - [**Katacoda**](https://www.katacoda.com/): Katacoda is an Interactive Learning Platform for software developers, covering the latest Cloud Native technologies.
  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.
  31 - [**CoderPad**](https://coderpad.io): Online interviewing platform for programmers. Run code in many programming languages, with results displayed by `xterm.js`.
  32 - [**WebSSH2**](https://github.com/billchurch/WebSSH2): A web based SSH2 client using `xterm.js`, socket.io, and ssh2.
  33 - [**Spyder Terminal**](https://github.com/spyder-ide/spyder-terminal): A full fledged system terminal embedded on Spyder IDE.
  34 - [**Cloud Commander**](https://cloudcmd.io "Cloud Commander"): Orthodox web file manager with console and editor.
  35 - [**Codevolve**](https://www.codevolve.com "Codevolve"): Online platform for interactive coding and web development courses. Live container-backed terminal uses `xterm.js`.
  36 - [**RStudio**](https://www.rstudio.com/products/RStudio "RStudio"): RStudio is an integrated development environment (IDE) for R.
  37 - [**Terminal for Atom**](https://github.com/jsmecham/atom-terminal-tab): A simple terminal for the Atom text editor.
  38 - [**Eclipse Orion**](https://orionhub.org): A modern, open source software development environment that runs in the cloud. Code, deploy and run in the cloud.
  39 - [**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.
  40 - [**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.
  41 - [**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.
  42 - [**Portainer**](https://portainer.io): Simple management UI for Docker.
  43 - [**SSHy**](https://github.com/stuicey/SSHy): HTML5 Based SSHv2 Web Client with E2E encryption utilising `xterm.js`, SJCL & websockets.
  44 - [**JupyterLab**](https://github.com/jupyterlab/jupyterlab): An extensible
  45 computational environment for Jupyter, supporting interactive data science and scientific computing across all programming languages.
  46 - [**Script Runner**](https://github.com/ioquatix/script-runner): Run scripts (or a shell) in Atom.
  47 - [**Whack Whack Terminal**](https://github.com/Microsoft/WhackWhackTerminal): Terminal emulator for Visual Studio 2017.
  48 - [**VTerm**](https://github.com/vterm/vterm): Extensible terminal emulator based on Electron and React.
  49
  50
  51 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.
  52
  53 ## Browser Support
  54
  55 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:
  56
  57 - Chrome 48+
  58 - Edge 13+
  59 - Firefox 44+
  60 - Internet Explorer 11+
  61 - Opera 35+
  62 - Safari 8+
  63
  64 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.
  65
  66 ## Demo
  67
  68 ### Linux or macOS
  69
  70 Run the following commands:
  71
  72 ```
  73 $ npm install
  74 $ npm start
  75 ```
  76
  77 Then open http://0.0.0.0:3000 in a web browser.
  78
  79 ### Windows
  80
  81 First, ensure [node-gyp](https://github.com/nodejs/node-gyp) is installed and configured correctly, then run these commands.
  82
  83 Note: Do not use ConEmu, as it seems to break the demo for some reason.
  84
  85 ```
  86 > npm install
  87 > npm start
  88 ```
  89
  90 Then open http://127.0.0.1:3000 in a web browser.
  91
  92 ## Getting Started
  93
  94 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.
  95 ```html
  96 <!doctype html>
  97   <html>
  98     <head>
  99       <link rel="stylesheet" href="bower_components/xterm.js/dist/xterm.css" />
 100       <script src="bower_components/xterm.js/dist/xterm.js"></script>
 101     </head>
 102     <body>
 103       <div id="terminal"></div>
 104       <script>
 105         var term = new Terminal();
 106         term.open(document.getElementById('terminal'));
 107         term.write('Hello from \033[1;3;31mxterm.js\033[0m $ ')
 108       </script>
 109     </body>
 110   </html>
 111 ```
 112 Finally instantiate the `Terminal` object and then call the `open` function with the DOM object of the `div`.
 113
 114 ## Addons
 115
 116 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).
 117
 118 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:
 119
 120 ```html
 121 <script src="node_modules/dist/xterm.js"></script>
 122 <script src="node_modules/dist/addons/fit/fit.js"></script>
 123 ```
 124
 125 ```js
 126 var xterm = new Terminal();
 127 // init code...
 128 xterm.fit();
 129 ```
 130
 131 ## Releases
 132
 133 Xterm.js follows a monthly release cycle roughly.
 134
 135 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).
 136
 137 ## Development and Contribution
 138
 139 Xterm.js is maintained by [SourceLair](https://www.sourcelair.com/) and a few external contributors, but we would love to receive contributions from everyone!
 140
 141 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.
 142
 143 ## License Agreement
 144
 145 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.
 146
 147 Copyright (c) 2014-2017, SourceLair, Private Company ([www.sourcelair.com](https://www.sourcelair.com/home)) (MIT License)
 148
 149 Copyright (c) 2012-2013, Christopher Jeffrey (MIT License)