Download and install the Reporting CLI tool

Install the Reporting CLI tool from either the npm software registry or an archive downloaded from OpenSearch.org. The Reporting CLI requires Node.js.

To learn more about the npm software registry, see the npm documentation.

Installing the Reporting CLI from npm

To install the Reporting CLI from npm, run the following command:

npm install -g @opensearch-project/reporting-cli

The -g option installs the Reporting CLI globally so that the opensearch-reporting-cli command is available in every directory. If you install the package without -g, run the command from the installation directory using npx opensearch-reporting-cli.

Installing the Reporting CLI from an archive

Download the Reporting CLI archive, and then install the archive by running the following command:

npm install -g opensearch-reporting-cli-1.1.0.tgz

To confirm that the archive was published by the OpenSearch Project and has not been modified, verify its signature using the Reporting CLI signature file.

To learn more about verifying signatures, see How to verify signatures for downloadable artifacts.

Verifying the installation

To verify the installation and list all available options, run the following command:

opensearch-reporting-cli -h

Chromium

The Reporting CLI renders reports using Chromium, which npm downloads when it runs the Puppeteer installation script during installation. If your npm configuration skips installation scripts, Chromium is not downloaded.

The downloaded Chromium is an x86-64 binary on all macOS computers. On a Mac with Apple silicon, the Reporting CLI fails with the error spawn Unknown system error -86 unless Rosetta 2 is installed.

To use a different Chromium or Chrome binary, for example, an Arm64 build or a browser installed by your package manager, set the CHROMIUM_PATH environment variable to the path of the browser executable:

export CHROMIUM_PATH=<path-to-chromium-executable>