/sapui5-cli

name: sapui5-cli
description: Manages SAPUI5/OpenUI5 projects using the UI5 Tooling CLI (@ui5/cli). Use when initializing UI5 projects, configuring ui5.yaml or ui5-workspace.yaml files, building UI5 applications or libraries, running development servers with HTTP/2 support, creating custom build tasks or server middleware, managing workspace/monorepo setups, troubleshooting UI5 CLI errors, migrating between UI5 CLI versions, or optimizing build performance. Supports both OpenUI5 and SAPUI5 frameworks with complete configuration and extensibility guidance.
license: GPL-3.0
metadata:
  maintainer: "Eduard Jiglau"
  maintainer_email: "hello@sap-ai-skills.com"
  website: "https://sap-ai-skills.com"
  version: "2.4.1"
  ui5_cli_version: "4.0.55"
  last_verified: "2026-05-31"
  official_docs: "https://ui5.github.io/cli/stable/"

SAPUI5/OpenUI5 CLI Management Skill

Related Skills

• **sap-dependency-security**: Use for secure CLI/toolchain upgrades, lockfile hardening, and deterministic installs in UI5 tooling workflows

Table of Contents

• [Overview](#overview)
• [When to Use This Skill](#when-to-use-this-skill)
• [Quick Start Workflow](#quick-start-workflow)
• [Project Types](#project-types)
• [Bundled Resources](#bundled-resources)

Overview

This skill provides comprehensive guidance for working with the UI5 CLI (UI5 Tooling), the official command-line interface for developing, building, and deploying SAPUI5 and OpenUI5 applications and libraries.

**Current CLI Version**: 4.0.55 (verified via npm on 2026-05-31) **Node.js Requirements**: v20.11.0+ or v22.0.0+ (v21 not supported) **npm Requirements**: v8.0.0+

When to Use This Skill

Use this skill when you need to:

• **Initialize** new UI5 projects or enable CLI support for existing projects
• **Configure** ui5.yaml for applications, libraries, theme-libraries, or modules
• **Build** UI5 projects with optimization, bundling, and minification
• **Run** local development servers with HTTP/2, SSL, and CSP support
• **Extend** build processes with custom tasks or server middleware
• **Manage** monorepo/workspace configurations with multiple UI5 projects
• **Troubleshoot** common UI5 CLI errors and build issues
• **Migrate** between CLI versions (v1 → v2 → v3 → v4)
• **Optimize** build performance and analyze dependencies

Quick Start Workflow

New Project Setup

# 1. Install UI5 CLI (choose one)
npm install --global @ui5/cli          # Global installation
npm install --save-dev @ui5/cli        # Project-level installation

# 2. Initialize project (if new)
npm init --yes                          # Initialize npm
ui5 init                                # Create ui5.yaml

# 3. Select framework variant
ui5 use openui5@latest                  # For OpenUI5
ui5 use sapui5@latest                   # For SAPUI5

# 4. Add framework libraries
ui5 add sap.ui.core sap.m sap.ui.table themelib_sap_fiori_3

# 5. Start development
ui5 serve                               # Start dev server
ui5 serve --open index.html            # Start and open browser

# 6. Build for production
ui5 build --all                         # Build with dependencies
ui5 build --clean-dest                  # Clean before building

Existing Project Setup

# 1. Enable CLI support
ui5 init

# 2. Configure framework (if ui5.yaml exists)
ui5 use openui5@latest                  # or sapui5@latest

# 3. Verify setup
ui5 tree                                # Show dependency tree
ui5 serve                               # Test development server

Project Types

UI5 CLI supports four project types, each with specific configurations:

1. Application

Standard UI5 applications with a `webapp` directory.

• Virtual path mapping: `webapp/` → `/`
• Generates Component-preload.js when Component.js exists
• See `templates/ui5.yaml.application` for configuration template

2. Library

Reusable component libraries for sharing across projects.

• Virtual path mappings: `src/` → `/resources`, `test/` → `/test-resources`
• Requires namespace directory structure (e.g., `src/my/company/library/`)
• See `templates/ui5.yaml.library` for configuration template

3. Theme Library

Provides theming resources for libraries.

• Same virtual mappings as standard libraries
• Resources organized by namespace (e.g., `my/library/themes/custom_theme/`)
• See `references/configuration.md` for detailed configuration

4. Module

Third-party resources with flexible path mapping.

• Resources copied without modification
• Custom virtual-to-physical path mappings
• See `references/project-structures.md` for module configuration

Core Commands Reference

Project Initialization

ui5 init                                # Initialize UI5 CLI configuration
ui5 use <framework>[@version]           # Set framework (openui5/sapui5)
ui5 add <libraries...>                  # Add framework libraries
ui5 remove <libraries...>               # Remove framework libraries

Development

ui5 serve [options]                     # Start development server
  --port <number>                       # Specify port (default: 8080)
  --open <path>                         # Open browser to path
  --h2                                  # Enable HTTP/2
  --accept-remote-connections           # Allow non-localhost access

ui5 tree [options]                      # Display dependency tree
  --flat                                # Show flat list
  --level <number>                      # Limit tree depth

Building

ui5 build [child-command] [options]     # Build project
  preload                               # Create preload bundles (default)
  self-contained                        # Create standalone bundle
  jsdoc                                 # Generate JSDoc documentation

  --all                                 # Include all dependencies
  --include-dependency <names>          # Include specific dependencies
  --exclude-dependency <names>