create-lxr

Scaffolding Your First LeanIX Custom Report

Compatibility Note: Requires Node.js version >=12.0.0.

With NPM:

$ npm init lxr@latest

With Yarn:

$ yarn create lxr

With PNPM:

$ pnpx create-lxr

Then follow the prompts!

You can also directly specify the project name and the template you want to use via additional command line options. For example, to scaffold a LeanIX Custom Report using Vue, run:

# npm 6.x
npm init lxr@latest my-custom-report --template vue

# npm 7+, extra double-dash is needed:
npm init lxr@latest my-custom-report -- --template vue

# yarn
yarn create lxr my-custom-report --template vue

# pnpm
pnpx create-lxr my-custom-report --template vue

Currently supported template presets include:

• vanilla
• vanilla-ts
• vue
• vue-ts
• react
• react-ts
• preact
• preact-ts
• svelte
• svelte-ts