jQuery Terminal Emulator - web based terminal
Latest commit dbfe907 Sep 18, 2018
Permalink
Failed to load latest commit information.
.github update PR template Aug 31, 2018
__tests__ testing overtyping underscore and from_ansi pallete Sep 17, 2018
css version 1.23.2 Sep 18, 2018
examples Fix wide characters #369 Feb 24, 2018
js version 1.23.2 Sep 18, 2018
scripts minor tweaks to cssnano script Sep 2, 2018
templates update contrubutors Sep 17, 2018
.gitattributes remove duplicated source maps #430 Sep 2, 2018
.gitignore Ignore coverage and reports Jun 18, 2016
.npmignore ignore test.ts file in .npmignore Sep 9, 2018
.travis.yml base for typechecking for travis + type test for echo and plugin call #… Aug 29, 2018
CHANGELOG.md fix too tall cursor (blink included underline) Sep 18, 2018
CONTRIBUTING.md update contributing file Aug 19, 2018
LICENSE update 2018 in copyright Jan 2, 2018
Makefile version 1.23.2 Sep 18, 2018
README.md version 1.23.2 Sep 18, 2018
bower.json version 1.23.2 Sep 18, 2018
contributors remove defunct github access token May 13, 2018
files better file script Apr 11, 2017
import.html Fix issue with scrolling in Firefox - found in #388 Apr 29, 2018
manifest change home page to jcubic.pl/me Apr 11, 2017
methods Add options and methods helper scripts Apr 6, 2017
options Add options and methods helper scripts Apr 6, 2017
package-lock.json fix align with prompt and cursor line Sep 7, 2018
package.json version 1.23.2 Sep 18, 2018
terminal.jquery.json version 1.23.2 Sep 18, 2018
test.ts persistent function prompt Sep 9, 2018
tsconfig.json base for typechecking for travis + type test for echo and plugin call #… Aug 29, 2018
update-contributors remove defunct github access token May 13, 2018
version remove duplicated source maps #430 Sep 2, 2018

README.md

      _______                 ________                        __
     / / _  /_ ____________ _/__  ___/______________  _____  / /
 __ / / // / // / _  / _/ // / / / _  / _/     / /  \/ / _ \/ /
/  / / // / // / ___/ // // / / / ___/ // / / / / /\  / // / /__
\___/____ \\__/____/_/ \__ / /_/____/_//_/_/_/_/_/  \/\__\_\___/
         \/          /____/                      version 1.23.2

http://terminal.jcubic.pl

npm bower travis Coverage Status downloads package quality

Summary

jQuery Terminal Emulator is a plugin for creating command line interpreters in your applications. It can automatically call JSON-RPC service when a user types commands or you can provide you own function in which you can parse user commands. It's ideal if you want to provide additional functionality for power users. It can also be used to debug your application.

You can use this JavaScript library to create web based terminal on any website.

Features:

  • You can create an interpreter for your JSON-RPC service with one line of code (just use url as first argument).

  • Support for authentication (you can provide functions when users enter login and password or if you use JSON-RPC it can automatically call login function on the server and pass token to all functions).

  • Stack of interpreters - you can create commands that trigger additional interpreters (eg. you can use couple of JSON-RPC service and run them when user type command)

  • Command Tree - you can use nested objects. Each command will invoke a function, if the value is an object it will create a new interpreter and use the function from that object as commands. You can use as many nested object/commands as you like. If the value is a string it will create JSON-RPC service.

  • Support for command line history, it uses Local Storage if possible.

  • Support for tab completion.

  • Includes keyboard shortcut from bash like CTRL+A, CTRL+D, CTRL+E etc.

  • Multiply terminals on one page (every terminal can have different command, it's own authentication function and it's own command history).

  • It catches all exceptions and displays error messages in the terminal (you can see errors in your javascript and php code in terminal if they are in the interpreter function).

  • Using extended commands you can change working of the terminal without touching the front-end code (using echo method and terminal formatting like syntax). Read more in docs

Installation

Include jQuery library, you can use cdn from http://jquery.com/download/

<script src="https://code.jquery.com/jquery-3.2.1.min.js"></script>

Then include js/jquery.terminal-1.23.2.min.js and css/jquery.terminal-1.23.2.min.css

You can grab the files from CDN:

<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery.terminal/1.23.2/js/jquery.terminal.min.js"></script>
<link href="https://cdnjs.cloudflare.com/ajax/libs/jquery.terminal/1.23.2/css/jquery.terminal.min.css" rel="stylesheet"/>

or

<script src="https://cdn.jsdelivr.net/npm/jquery.terminal@1.23.2/js/jquery.terminal.min.js"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/jquery.terminal@1.23.2/css/jquery.terminal.min.css">

If you always want latest version, you can grab the files directly from github using rawgit.com (that service grab the files from github and use propert MIME type so you can use it in your page, you can also grab from devel branch):

<script src="https://cdn.rawgit.com/jcubic/jquery.terminal/master/js/jquery.terminal.min.js"></script>
<link href="https://cdn.rawgit.com/jcubic/jquery.terminal/master/css/jquery.terminal.min.css" rel="stylesheet"/>

or get it from unpkg without specifying version, it will redirect to the latest version:

<script src="https://unpkg.com/jquery.terminal/js/jquery.terminal.min.js"></script>
<link href="https://unpkg.com/jquery.terminal/css/jquery.terminal.min.css" rel="stylesheet"/>

NOTE: From version 1.0.0 if you want to support old browsers then you'll need to use key event property polyfill. You can check the support for it on can I use.

<script src="https://cdn.rawgit.com/inexorabletash/polyfill/master/keyboard.js"></script>

You can also install jQuery Terminal using command line, from bower repository:

bower install jquery.terminal

or npm registry:

npm install jquery.terminal

Example of usage

This is code that uses low level function, that gives you full control of the commands, just pass anything that the user types into a function.

jQuery(function($, undefined) {
    $('#term_demo').terminal(function(command) {
        if (command !== '') {
            var result = window.eval(command);
            if (result != undefined) {
                this.echo(String(result));
            }
        }
    }, {
        greetings: 'Javascript Interpreter',
        name: 'js_demo',
        height: 200,
        width: 450,
        prompt: 'js> '
    });
});

Here is a higher level call, using an object as an interpreter, By default the terminal will parse commands that a user types and replace number like strings with real numbers regex with regexes and process escape characters in double quoted strings.

jQuery(function($, undefined) {
    $('#term_demo').terminal({
        add: function(a, b) {
            this.echo(a + b);
        },
        foo: 'foo.php',
        bar: {
            sub: function(a, b) {
                this.echo(a - b);
            }
        }
    }, {
        height: 200,
        width: 450,
        prompt: 'demo> '
    });
});

Command foo will execute json-rpc from foo.php file.

You can create JSON-RPC interpreter with authentication in just one line:

$('#term_demo').terminal('service.php', {login: true});

More examples here. You can also check full documentation.

Security

Because of security in version 1.20.0 links with protocols different then ftp or http(s) (it was possible to enter javascript protocol, that could lead to XSS if author of hte app echo user input and save it in DB) was turn off by default. To enable it, you need to use anyLinks: true option.

In version 1.21.0 executing terminal methods using extendend commands [[ terminal::clear() ]] was also disabled by default because attacker (depending on your application) could execute terminal::echo with raw option to enter any html and execute any javascript. To enable this feature from this version you need to use invokeMethods: true option.

The features are safe to enable, if you don't save user input in DB and don't echo it back to different users (like with chat application). It's also safe if you escape formatting before you echo stuff.

If you don't save user input in DB but allow to echo back what user types and have enabled execHash options, you may have reflected XSS vulnerability if you enable this features. If you escape formatting this options are also safe.

Contributors

If you want to contrubite read CONTRIBUTING.md first. Here are project contributors:


Jakub Jankiewicz

commits

Zuo Qiyang

commits

Marcel Link

commits

Sébastien Warin

commits

Christopher John Ryan

commits

Johan

commits

Florian Schäfer

commits

David Refoua

commits

Ishan Ratnapala

commits

Tomasz Ducin

commits

Abdelrahman Omran

commits

Anton Vasilev

commits

finlob

commits

Hasan

commits

Hraban Luyat

commits

Martin v. Löwis

commits

Mateusz Paprocki

commits

exit1

commits

Robert Wikman

commits

Steve Phillips

commits

Yutong Luo

commits

coderaiser

commits

mrkaiser

commits

stereobooster

commits

Juraj Vitko

commits

jQuery Terminal Website contributors:


Jakub Jankiewicz

commits

Rich Morin

commits

DInesh51297

commits

Logan Rosen

commits

License

Licensed under MIT license

Copyright (c) 2011-2018 Jakub Jankiewicz