yuuvis client CLI

The yuuvis client CLI is a command-line interface tool that you can use to initialize and scaffold yuuvis MOMENTUM client applications directly from a command shell.

Prerequisites

Required are:

Node.js 18 or later
git

Version Compatibility

This CLI package follows a synchronized versioning strategy with the Angular framework. Each major version of the CLI is designed to support the corresponding Angular version and corresponds to a specific major version of the @yuuvis/client-shell:

v18 of @yuuvis/client-cli is compatible with Angular 18 and corresponds to major version 1 of @yuuvis/client-shell
v19 of @yuuvis/client-cli is compatible with Angular 19 and corresponds to major version 2 of @yuuvis/client-shell

Make sure to install a CLI version that matches both your Angular version and the required @yuuvis/client-shell version for full compatibility.

Install

Install the yuuvis client CLI globally:

npm install -g @yuuvis/client-cli

Usage

yuv <command> <value> [options]

Supported Commands

new

Creates a new yuuvis client project based on Angular Schematics. The created application is based upon the standalone API and uses scss for style files.

yuv new <name> [options]

<name>: The name of the project.

Options

--skip-git: Do not initialize a git repository.
--skip-install: Do not install dependency packages.
--skip-tests: Do not generate spec.ts test files for the new project.

generate app

Creates an app in the current workspace. By default, the generated app contains both the UI and extension parts.

yuv generate app <name> [options]

# short form
yuv g a <name> [options]

<name>: The name of the app.

Options

--app-header: Use the shell's app header layout.
--app-id: The ID of the app.
--hide-from-nav: Do not show the app icon i the navigation bar.
--prefix: A prefix to apply to generated selectors.
--route: The route under which the app is registered in the client.
--skip-extension: Do not create extension for the app.

add app

Adds an existing app to the client.

yuv add app <name>

# short form
yuv a a <name>

<name>: The name of the app. Similar to npm install, you can use [<@scope>/]<name>@<version> or [<@scope>/]<name>@<tag> for adding a specific version or tag of the app, e. g.:

yuv add app @myscope/mylib@1.0.0

yuv add app @myscope/mylib@latest

patch list

Lists all available patches.

yuv patch list

# short form
yuv p l

patch apply

Applies the patch with the given ID to the current client project if necessary.

yuv patch apply <patchID>

# short form
yuv p a <patchID>