Tutorial 02: querying workspace data from a custom report

Tutorial on how to query workspace data from a custom report

Table of Contents

• Project setup
• Available scripts

Project setup

This project was bootstrapped with leanix-reporting-cli.

1. npm install -g @leanix/reporting-cli
2. npm install in project directory
3. create a lxr.json file in project directory (please see Getting started)

Available scripts

In the project directory, one can run:

npm start

This command will start the local development server. Please make sure you have properly configured lxr.json first. It will take the specified API Token from lxr.json and automatically do a login to the workspace.

npm run build

Builds the report and outputs the build result into dist folder.

npm run upload

Uploads the report to the workspace configured in lxr.json. Please see Uploading to LeanIX workspace.