Skip to content

README.md

Latest commit

 

History

History
120 lines (70 loc) · 1.91 KB

README.md

File metadata and controls

120 lines (70 loc) · 1.91 KB

Lightning CLI

Tooling for Lightning development

Getting Started

Install the Lightning-CLI globally on your system

npm install -g WebPlatformForEmbedded/Lightning-CLI

Usage:

lng <command> [options]

Commands

Overview

Display an overview of all available commands

lng

Create

Create a new Lightning App from scratch

lng create

Build

Build a standalone Lightning App

lng build

Run this command in the root of the Lightning App you want to build

Serve

Serve a built Lightning App in a webbrowser

lng serve

Run this command in the root of the Lightning App you want to serve

Watch

Watch the src folder for changes and rebuild the Lightning App upon every change

lng watch

Run this command in the root of the Lightning App you want to watch

Dev

Spins up a local server to serve a Lightning App and watches for changes

lng dev

Run this command in the root of the Lightning App you want to serve and watch

Docs

Open the Lightning SDK documentation of the App you're developing

lng docs

Run this command in the root of the Lightning App for which you want to see the documentation

Release

Create a release package of a Lightning App

lng release

Run this command in the root of the Lightning App you want to release

Upload

Upload a release package of a Lightning App to the Metrological Back Office

lng upload

Run this command in the root of the Lightning App you want to upload

Contributing

If you want to contribute to the Lightning-CLI, please consider the following:

  • the master branch is the latest stable release
  • the dev branch is used for upcoming releases
  • all development should be done in dedicated topic branches (from latest dev-branch)
  • please send in your PR against the dev-branch