JSPM

Build modules for Includable from the comfort of your command line.

About

The Includable command line utility allows you to build, debug and test modules by using your own editor and local environment, but by seeing the results in realtime on an online demo environment. No need to install virtual machines or container software on your own machine.

Installation

Install Node.js (version 4+), and install the Includable CLI through npm:

npm install -g includable

Usage

View all commands by simply executing:

inc

Create a new module:

inc create

Start debugging it by executing this command in a module directory (needs to contain a module.json file):

inc run

This will automatically open the browser and sign in as a user. Alternatively, add -e manager to sign in to the Includable Manager with the module installed, or -e main to not automatically sign in (public homepage/login screen of community).

Includable will automatically synchronise any changes you make to local files as long as you leave the command running. After you save a file, refresh the browser to see your changes.

Demo

A quick demo video can be seen here:

Plugins

It is possible to extend the CLI functionality by building plugins.

Installing plugins

Plugins can be installed by running inc plugins:add <npm-package>. NPM packages that follow the format @includable/cli-<name> can be simply installed by using <name>, any other NPM packages can only be installed if they contain cli-.

If you wish to publish a CLI plugin, please let us know, so that we can publish it in the @includable organization on NPM.

Plugin API

Includable CLI plugins are simple Node packages, which export a function (in their main file, specified in package.json) with a single argument, which is an instance of a commander.js program:

module.exports = function(includable) {
    includable
        .command('ping')
        .description('Get a pong')
        .action(function() {
            program.output.notice('pong');
        });
};

Also, the includable object has the following additional keys:

• util: utilty class
• output: output class
• plugins: plugins class
• module: module class
• request: HTTP request method