@leanix/reporting-cli/README.md

Command line interface to develop custom reports for LeanIX EAM

# leanix-reporting-cli

[![npm version](https://badge.fury.io/js/%40leanix%2Freporting-cli.svg)](https://badge.fury.io/js/%40leanix%2Freporting-cli)

Command line interface to initialise, develop and publish custom reports for LeanIX EAM Tool.
Please also have a look at the corresponding reporting library: https://github.com/leanix/leanix-reporting

## Documentation

The usage of the command line interface is shown when running `lxr --help`. Detailed help for individual
commands and their options can be obtained by running `lxr help [command]`.

For information on how to create a custom report, please refer to our [documentation](https://dev.leanix.net/docs/build-a-custom-report).

# For reporting-cli developers

## Publish new version

- Create new release by following git-flow
  - Create release branch
  - Bump version in `package.json` (decide whether patch, minor, major update)
  - Merge release branch to develop & main
  - Make sure a git tag is created for the new version
- Make sure you have logged in to publish to npm registry in scope `@leanix` (`npm login` - see: https://docs.npmjs.com/cli/adduser)
- Execute `npm publish --access public` on the main branch
- Add release notes to the release in github (https://github.com/leanix/leanix-reporting-cli/releases)