open-index/open-npm huggingface dataset:
npm package: @sap/create-leanix-custom-report
Description: Scaffolding tool to quickly bootstrap new SAP LeanIX custom reports
Latest version: 2.4.2

# @sap/create-leanix-custom-report

## Scaffolding Your First SAP LeanIX Custom Report

> **Compatibility Note:**
> Requires [Node.js](https://nodejs.org/en/) version >=24.0.0.

With NPM:

```bash
$ npm create @sap/leanix-custom-report@latest
```

With Yarn:

```bash
$ yarn create @sap/leanix-custom-report
```

With PNPM:

```bash
$ pnpm create @sap/leanix-custom-report
```

Then follow the prompts!

You can also directly specify the project name via command line:

```bash
# npm
npm create @sap/leanix-custom-report@latest my-custom-report

# yarn
yarn create @sap/leanix-custom-report my-custom-report

# pnpm
pnpm create @sap/leanix-custom-report my-custom-report
```

All projects are scaffolded using **React with TypeScript**, providing a modern, type-safe development experience with excellent IDE support and maintainability.

## Non-Interactive / CI Usage

Every interactive prompt can be bypassed by passing the corresponding flag. This is useful for
CI pipelines, automation scripts, or any environment where stdin is not a TTY. Consider using
environment variables for passing the apitoken as the token might be persisted in your shell
history otherwise.

```bash
npm create @sap/leanix-custom-report@latest my-report \
  --id net.leanix.myreport \
  --author "LeanIX GmbH" \
  --title "My Report" \
  --description "A custom report" \
  --packageName my-report \
  --host demo-eu.leanix.net \
  --apitoken <your-api-token> \
  --overwrite
```

To skip LeanIX authentication entirely (e.g. for offline scaffolding):

```bash
npm create @sap/leanix-custom-report@latest my-report \
  --skipAuth \
  --id net.leanix.myreport \
  --author "LeanIX GmbH" \
  --title "My Report" \
  --description "A custom report"
```

### All available flags

| Flag | Type | Description |
|---|---|---|
| `project-name` | positional | Directory name for the new project (default: `leanix-custom-report`) |
| `--id` | string | Unique report id in Java package notation (e.g. `net.leanix.barcharts`) |
| `--author` | string | Report author (e.g. `LeanIX GmbH`) |
| `--title` | string | Title shown in LeanIX when the report is installed |
| `--description` | string | Short description of the report |
| `--packageName` | string | npm package name (default: derived from project-name) |
| `--host` | string | LeanIX host (default: `demo-eu.leanix.net`) |
| `--apitoken` | string | API token for authentication |
| `--proxyURL` | string | HTTP/S proxy URL — also suppresses the proxy toggle prompt |
| `--overwrite` | boolean | Overwrite target directory if it already exists |
| `--skipAuth` | boolean | Skip LeanIX authentication entirely |
| `--setupMcpServers` | boolean | Generate MCP server config files (requires feature flag) |
| `--no-setupMcpServers` | boolean | Skip MCP server config generation without prompting |
| `--help` | boolean | Print this flag reference and exit |

Any flag that is omitted will fall back to its interactive prompt, so partial automation is
fully supported.
npm package: @sap/csn-interop-renderer
Description: Converts documents defined using CSN Interoperability Specification into markdown/HTML human readable documentation pages.
Author: SAP SE
Latest version: 0.4.0

[![REUSE status](https://api.reuse.software/badge/github.com/SAP/csn-interop-renderer)](https://api.reuse.software/info/github.com/SAP/csn-interop-renderer)

# CSN Interop Document Renderer

Converts documents defined using [CSN Interoperability Specification](https://sap.github.io/csn-interop-specification/) into markdown/HTML human readable documentation pages.

🌎 DOCUMENTATION: <https://sap.github.io/csn-interop-renderer/>

## Support, Feedback, Contributing

This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/SAP/csn-interop-renderer/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).

## Security / Disclosure

If you find any bug that may be a security problem, please follow our instructions at [in our security policy](https://github.com/SAP/csn-interop-renderer/security/policy) on how to report it. Please do not create GitHub issues for security-related doubts or problems.

## Code of Conduct

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its [Code of Conduct](https://github.com/SAP/.github/blob/main/CODE_OF_CONDUCT.md) at all times.

## Licensing

Copyright 2025 SAP SE or an SAP affiliate company and csn-interop-renderer contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/SAP/csn-interop-renderer).