cmdrjs

A JavaScript based command line interface for web pages.

Installing the module

NPM

npm i cmdrjs

Loading the module

The cmdr module is bundled using the standalone option in browserify which uses the umd library. This allows the module to be loaded in various ways.

IE and older browser support

The babel-polyfill is not included in the bundle. Older browsers and IE may require the polyfill for cmdrjs to function properly.

CommonJS

var cmdr = require('cmdr.js');
var terminal = new cmdr.Terminal(...);

RequireJS

require('cmdr.js', function(cmdr) {
    var terminal = new cmdr.Terminal(...);
});

Global/Window

<script src="cmdr.js"></script>
<script>
    var terminal = new cmdr.Terminal(...);
</script>

Documentation

See the wiki for full documentation.

Dependencies

The cmdr module is bundled with its dependencies and therefore has no external dependencies.

See package.json for accurate versions.