https://github.com/guicaulada/jsterm

A terminal emulator made with Node.js and xterm.js
https://github.com/guicaulada/jsterm

Last synced: 3 months ago
JSON representation

A terminal emulator made with Node.js and xterm.js

• Host: GitHub
• URL: https://github.com/guicaulada/jsterm
• Owner: guicaulada
• License: gpl-3.0
• Created: 2019-02-17T02:01:30.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-09T13:02:32.000Z (about 2 years ago)
• Last Synced: 2024-10-03T11:48:13.529Z (3 months ago)
• Language: JavaScript
• Size: 76.2 KB
• Stars: 4
• Watchers: 1
• Forks: 2
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# jsterm #

**jsterm** is a terminal emulator made with Node.js and xterm.js.

## Requirements

* [xterm](https://www.npmjs.com/package/xterm)

* [express](https://www.npmjs.com/package/express)

* [socket.io](https://www.npmjs.com/package/socket.io) 

* [ejs](https://www.npmjs.com/package/ejs)

## Documentation ##

### Getting Started

Install jsterm using npm:

```bash

$ npm install jsterm

```

You can now use jsterm like so:

```js

let Terminal = require('jsterm')

let term = new Terminal(1337) // localhost:1337 - Default shell

term.add('cmd.exe')  // localhost:1337/cmd.exe

term.add('bash.exe') // localhost:1337/bash.exe

term.add('node.exe') // localhost:1337/node.exe

term.listen()

console.log('Terminal listening on localhost:1337')

```

Refer to the [jsterm examples](https://github.com/Sighmir/jsterm/tree/master/example) for more information.  

## License ##

```

jsterm - A terminal emulator made with Node.js and xterm.js.

Copyright (C) 2019  Guilherme Caulada (Sighmir)

This program is free software: you can redistribute it and/or modify

it under the terms of the GNU General Public License as published by

the Free Software Foundation, either version 3 of the License, or

(at your option) any later version.

This program is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

GNU General Public License for more details.

You should have received a copy of the GNU General Public License

along with this program.  If not, see .

```