README.md

   1 # xterm.js
   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
  34 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.
  35
  36 ## Browser Support
  37
  38 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:
  39
  40 - Chrome 48+
  41 - Edge 13+
  42 - Firefox 44+
  43 - Internet Explorer 11+
  44 - Opera 35+
  45 - Safari 8+
  46
  47 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.
  48
  49 ## Demo
  50
  51 ### Linux or macOS
  52
  53 Run the following commands:
  54
  55 ```
  56 $ npm install
  57 $ npm start
  58 ```
  59
  60 Then open http://0.0.0.0:3000 in a web browser.
  61
  62 ### Windows
  63
  64 First, ensure [node-gyp](https://github.com/nodejs/node-gyp) is installed and configured correctly, then run these commands.
  65
  66 Note: Do not use ConEmu, as it seems to break the demo for some reason.
  67
  68 ```
  69 > npm install
  70 > npm start
  71 ```
  72
  73 Then open http://127.0.0.1:3000 in a web browser.
  74
  75 ## Getting Started
  76
  77 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.
  78 ```html
  79 <!doctype html>
  80   <html>
  81     <head>
  82       <link rel="stylesheet" href="bower_components/xterm.js/dist/xterm.css" />
  83       <script src="bower_components/xterm.js/dist/xterm.js"></script>
  84     </head>
  85     <body>
  86       <div id="terminal"></div>
  87       <script>
  88         var term = new Terminal();
  89         term.open(document.getElementById('terminal'));
  90         term.write('Hello from \033[1;3;31mxterm.js\033[0m $ ')
  91       </script>
  92     </body>
  93   </html>
  94 ```
  95 Finally instantiate the `Terminal` object and then call the `open` function with the DOM object of the `div`.
  96
  97 ## Addons
  98
  99 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).
 100
 101 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:
 102
 103 ```html
 104 <script src="node_modules/dist/xterm.js"></script>
 105 <script src="node_modules/dist/addons/fit/fit.js"></script>
 106 ```
 107
 108 ```js
 109 var xterm = new Terminal();
 110 // init code...
 111 xterm.fit();
 112 ```
 113
 114 ## Releases
 115
 116 Xterm.js follows a monthly release cycle roughly.
 117
 118 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).
 119
 120 ## Development and Contribution
 121
 122 Xterm.js is maintained by [SourceLair](https://www.sourcelair.com/) and a few external contributors, but we would love to receive contributions from everyone!
 123
 124 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.
 125
 126 ## License Agreement
 127
 128 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.
 129
 130 Copyright (c) 2014-2016, SourceLair, Private Company ([www.sourcelair.com](https://www.sourcelair.com/home)) (MIT License)
 131
 132 Copyright (c) 2012-2013, Christopher Jeffrey (MIT License)