scholica-cli v1.4.7

Notice!

This package has been renamed to includable. Please install includable instead!

Scholica CLI

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

The Scholica 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 Scholica CLI through npm:

npm install -g scholica-cli

Usage

Create a new module. This will create a new directory with your module's chosen name, and add some standard content:

scholica create modulename

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

scholica run

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

Scholica 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:

Development

Code quality

Plugins

It is possible to extend the CLI functionality by building plugins. These 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:

'use strict';

module.exports = function(program) {

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

};

These can then be installed through scholica plugins install, which takes either a local directory path, or the name of an NPM package. Plugins are installed in the directory $HOME/.scholica-cli-plugins.