Preparing your environment

Prerequisites

The Singular Widget SDK requires a local installation of Node.js. Download it from https://nodejs.org/en/.

This document describes how to install singular-cli. For details about Singular's other CLIs, singularwidget-cli and singularapp-cli, see https://github.com/singularlive/ and https://www.npmjs.com/~singularlive.

Installing the Singular CLI

After installing Node.js, open a console and install singular-cli by running this command:

npm install singular-cli -g

After the installing the CLI, console commands to create and deploy Singular widgets and apps will become available.

The create commands serve to clone the Singular boilerplates into a specified folder.

The deploy commands check, package, and upload your widget or app code to Singular.live. Every widget and app is identified by a unique deploy key. Generating a deploy key is covered here.

Create Singular widget boilerplate

singular createwidget <folder name>

Deploy a Singular widget

singular deploywidget <folder name>

For more information about the Singlar.live CLI see https://github.com/singularlive/singular-cli.