# @sap-ux/environment-check

> SAP Fiori environment check

Latest version **1.0.38** (published 2026-11-03) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @sap-ux/environment-check
pnpm add @sap-ux/environment-check
yarn add @sap-ux/environment-check
bun add @sap-ux/environment-check
```

Provides the command `envcheck`.

## Health

**Score 65/100 (B)** — status: active.

Positive: esm support; no vulnerabilities; has provenance; recently updated; high maintenance score.

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 1.0.38 |
| Published | 2026-11-03 |
| First published | 2022-08-26 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=22.x |
| Dependencies | 14 |
| Unpacked size | 178.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 162 |
| Maintainers | tqueck, kranthie.sap, sap_extncrepos, sap-ospo-admin, devinea |

## Links

- npm: https://www.npmjs.com/package/@sap-ux/environment-check
- Repository: https://github.com/SAP/open-ux-tools
- npm.io page: https://npm.io/package/@sap-ux/environment-check

## Dependencies (14)

- [axios](https://npm.io/package/axios.md) 1.20.0
- [yamljs](https://npm.io/package/yamljs.md) 0.3.0
- [i18next](https://npm.io/package/i18next.md) 26.5.11
- [prompts](https://npm.io/package/prompts.md) 2.4.2
- [archiver](https://npm.io/package/archiver.md) 7.0.1
- [minimist](https://npm.io/package/minimist.md) 1.2.8
- [@sap/bas-sdk](https://npm.io/package/@sap/bas-sdk.md) 3.13.16
- [@sap-ux/store](https://npm.io/package/@sap-ux/store.md) 2.0.8
- [@sap-ux/logger](https://npm.io/package/@sap-ux/logger.md) 1.0.3
- [glob-gitignore](https://npm.io/package/glob-gitignore.md) 1.0.15
- [@sap-ux/btp-utils](https://npm.io/package/@sap-ux/btp-utils.md) 2.0.8
- [@sap-ux/ui5-config](https://npm.io/package/@sap-ux/ui5-config.md) 1.0.11
- [@sap-ux/project-access](https://npm.io/package/@sap-ux/project-access.md) 2.3.4
- [@sap-ux/axios-extension](https://npm.io/package/@sap-ux/axios-extension.md) 2.1.6

## Recent versions

- 1.0.38 (latest) — 2026-11-03
- 1.0.36 — 2026-10-30
- 1.0.35 — 2026-10-28
- 1.0.34 — 2026-10-23
- 1.0.33 — 2026-10-16
- 1.0.32 — 2026-10-14
- 1.0.31 — 2026-10-08
- 1.0.30 — 2026-10-06
- 1.0.29 — 2026-09-22
- 1.0.28 — 2026-09-17
- 1.0.27 — 2026-09-11
- 1.0.26 — 2026-09-10
- 1.0.25 — 2026-08-27
- 1.0.24 — 2026-08-25
- 1.0.23 — 2026-08-25
- … 439 more at https://npm.io/package/@sap-ux/environment-check/versions

## README

[![Changelog](https://img.shields.io/badge/changelog-8A2BE2)](https://github.com/SAP/open-ux-tools/blob/main/packages/environment-check/CHANGELOG.md) [![Github repo](https://img.shields.io/badge/github-repo-blue)](https://github.com/SAP/open-ux-tools/tree/main/packages/environment-check)

# [`@sap-ux/environment-check`](https://github.com/SAP/open-ux-tools/tree/main/packages/environment-check)

Environment check for Business Application Studio and Visual Studio Code.

## Installation
Npm
`npm install --save @sap-ux/environment-check`

Yarn
`yarn add @sap-ux/environment-check`

Pnpm
`pnpm add @sap-ux/environment-check`

## Usage

```javascript
import {
    getEnvironment,
    checkBASDestinations,
    checkBASDestination, 
    checkEndpoints,
    checkEndpoint,
} from '@sap-ux/environment-check';

/**
 * Returns the environment, including ide, versions, extensions ...
 */
const environmentResults = await getEnvironment();

/**
 * Checks the destinations and returns a list
 */
const destinationResults = await checkBASDestinations();

/**
 * Check a BAS destination for v2 & v4 catalog service 
 */
const destResult = await checkBASDestination(destination, username, password);

/**
 * Checks the stored SAP Systems (or destinations on BAS) and returns a list
 */
const endpointResults = await checkEndpoints();

/**
 * Check the stored SAP System (or destination on BAS) for v2 & v4 catalog service and other services 
 */
const endpointResult = await checkEndpoint(destination, username, password);

```

## CLI

A CLI application is also available to investigate the environment and destinations.

## Usage

```
$ envcheck --help

Usage 
    $ envcheck --destination <DESTINATION> --output <OUTPUT> <WORKSPACE_ROOT>

Options
    --destination       destination or stored SAP system to perform deep check, multiple destinations can be passed
    --output            json | markdown | verbose | zip format for output, if not specified all messages   except 'info' are shown

    <WORKSPACE_ROOT*>   path the root folder of a workspace. Multiple roots can be defined. We search for apps with destinations in workspaces
```
## Keywords
SAP Fiori Tools

---
_Source: https://npm.io/package/@sap-ux/environment-check · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._