Git Product home page Git Product logo

browser-terminal's Introduction

browser-terminal

pipe a shell into an interactive browser terminal

example

var terminal = require('browser-terminal');
var bashful = require('bashful');

var sh = bashful({
    env: {
        USER: 'guest',
        PS1: '\\[\\033[01;32m\\]\\u\\[\\033[00m\\] : '
            + '\\[\\033[01;34m\\]\\W\\[\\033[00m\\] $ ',
        HOME: '/home/guest',
        PWD: '/home/guest',
        UID: 1000
    },
    exists: function (file, cb) {
        cb(file === '/' || file === '/home' || file === '/home/guest');
    }
});
var term = terminal().appendTo('#terminal')
term.pipe(sh.createStream()).pipe(term);

window.addEventListener('keydown', term.keydown);

compile this with browserify into a bundle.js then write some html:

<html>
  <head>
    <title>terminal</title>
    <style>
      #terminal {
        position: absolute;
        left: 0px;
        top: 0px;
        bottom: 0px;
        right: 50%;
        padding: 10px 15px 10px 15px;
        background: black;
        font-family: monaco, monospace;
        font-size: 16px;
      }
    </style>
  </head>
  <body>
    <div id="terminal"></div>
    <script src="/bundle.js"></script>
  </body>
</html>

methods

var terminal = require('browser-terminal')

var term = terminal()

Create a new terminal duplex stream term.

term.appendTo(target)

Append the browser html element to the html element or query selector string target.

term.keydown(ev)

Respond to a keydown event ev. Unless you want to do fancy things, you can just forward along all keydown events:

window.addEventListener('keydown', term.keydown)

install

With npm do:

npm install browser-terminal

license

MIT

browser-terminal's People

Watchers

Naveen Kumar avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.