@metrological/cli

Metrological CLI

The Metrological CLI is the Command Line Interface tool for uploading Lightning Apps to the Metrological Dashboard.

Table of contents

• Prerequisites
• Migrating from lng upload to metro upload
• Usage
  • Method 1: Using npx (recommended)
  • Method 2: Installing as a devDependency
  • Method 3: Installing globally
• Available commands

Prerequisites

You need to have the @lightningjs/cli installed globally on your system. This is needed (for now) because under the hood it will trigger the lng build command. If you haven't done so, run this command:

npm install -g @lightningjs/cli

To verify if you have the Lightning CLI installed, run:

lng --version

⚠️ This should output a version of 2.9.0 or higher

Migrating from lng upload to metro upload

In the January 2023 release of the Lightning-CLI package, the upload command has been deprecated, as was announced in this blog post in October 2022. Luckily, it's easy to migrate from lng upload to metro upload:

1. Install the Metrological-CLI as described in the 'Usage' section below
2. Check for any references to lng upload in your tooling (like your package.json or any custom build configuration)
3. Change this reference to either npx @metrological/cli upload or metro upload, depending on the way you've installed the Metrological-CLI package. See 'Usage' for the recommend ways of installing it.

Usage

Method 1: Installing globally (Recommended)

You can install the Metrological CLI globally on your system, by running the following command:

npm install -g @metrological/cli

Then inside the root of a Lightning App you can run the following command.

metro upload

Method 2: Installing as a devDependency

Alternatively you can install the Metrological CLI as a devDependency by running the NPM command for it:

npm install --save-dev @metrological/cli

You can then add a script in your package.json to use it, like so:

{
  "name": "MyLightningApp",
  "scripts": {
    "upload": "metro upload"
  }
}

To execute this, run npm run upload inside the root folder of your App (this is default NPM behaviour)

Available commands

Command	Description
upload	:rocket: Upload the Lightning App to the Metrological Back Office to be published in an App Store
--help	Output the version number
--version	Display help for command
--debug	Output extra debugging info