• Getting Started

Includable CLI

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 using Homebrew

If you are on a Mac and have Homebrew installed, use the following command:

brew install includable/tap/includable

Install using Node.js

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

npm install -g includable

Install using binary

Prebuilt binaries are available for Windows, Mac OS, Linux x86 and Alpine Linux.

Usage

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.

Source code

The Includable CLI is an open source application, for which the code can be found on Github.