Gritty

Web terminal emulator. Based on node-pty and xterm.js.

Install

npm i gritty -g

Usage

Usage: gritty [options] Options: -h, --help display this help and exit -v, --version output version information and exit --path output path of a gritty and exit --port set port number

Windows

On Windows there is no build tools by default. When can't install gritty try to install windows-build-tools first.

npm i windows-build-tools -g
npm i gritty -g

Use as standalone

Start gritty, and go to url http://localhost:1337

API

Client API

gritty(element [, options])

const prefix = '/gritty'; // default
const env = {}; // default

gritty('body', {
    prefix,
    env,
});

Server API

gritty.listen(socket, options)

Gritty could be used as middleware:

const prefix = '/gritty'; // default
const authCheck = (socket, success) => {}; // optional

gritty.listen(socket, {
    prefix,
    authCheck,
})

gritty(options)

Middleware function:

const prefix = '/gritty'; // default

gritty({prefix});

Usage as middleware

To use gritty in your programs you should make local install:

npm i gritty socket.io express --save

And use it this way:

// server.js

const gritty = require('gritty');
const http = require('http');
const express = require('express');
const io = require('socket.io');

const app = express();
const server = http.createServer(app);
const socket = io.listen(server);

const port = 1337;
const ip = '0.0.0.0';

app.use(gritty())
app.use(express.static(__dirname));

gritty.listen(socket);
server.listen(port, ip);

<!-- index.html -->

<div class="gritty"></div>
<script src="/gritty/gritty.js"></script>
<script>
    const options = {
        prefix: 'console',
        env: {
            TERMINAL: 'gritty',
            CURRENT: getCurrentFile,
        }
    };
    
    gritty('.console', options);
    
    function getCurrentFile() {
        return 'filename.txt';
    }
</script>

Environments

In old node.js environments that not fully supports es2015, gritty could be used with:

var gritty = require('gritty/legacy');

License

MIT