cds:install-cdsdk

Full name:

com.sap.cds:cds-maven-plugin:1.26.0:install-cdsdk

Description:

Install @sap/cds-dk in the current CAP Java project.
By default, this goal looks for an already installed @sap/cds-dk and skips installation if it was found. It doesn't validate the found version against the requested version to install and the installed @sap/cds-dk could be outdated. Add property -Dcds.install-cdsdk.force=true to the Maven command line to force the installation of a @sap/cds-dk in the configured version.

Attributes:

  • Requires a Maven project to be executed.
  • Executes as an aggregator plugin.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Since version: 1.7.0.
  • Binds by default to the lifecycle phase: initialize.

Required Parameters

Name Type Since Description
<version> String 1.7.0 Version of @sap/cds-dk to install. The version value has to be a valid semantic version that is used for NPM modules.
Default value is: ^4.
User property is: cds.install-cdsdk.version.

Optional Parameters

Name Type Since Description
<arguments> String 1.23.0 Defines additional arguments that are passed to the command line that is executed to install the @sap/cds-dk. The arguments are separated by spaces. For example it can be used to enable the verbose output of npm with the additional argument --dd.
User property is: cds.install-cdsdk.arguments.
<environmentVariables> Map 1.26.0 Additional environment variables to set on the command line.
<force> boolean 1.7.0 Force installation of @sap/cds-dk, even if it's already installed in any version.
Default value is: false.
User property is: cds.install-cdsdk.force.
<global> boolean 1.7.0 Enables global installation of @sap/cds-dk.
Default value is: false.
User property is: cds.install-cdsdk.global.
<npmRegistry> String 1.7.0 URL of NPM registry to use.
User property is: npmRegistry.
<skip> boolean 1.7.0 Skip execution of this goal.
Default value is: false.
User property is: cds.install-cdsdk.skip.
<workingDirectory> File 1.7.0 The working directory to be used for installation of @sap/cds-dk. If it's not specified, this goal is using the directory that contains a .cdsrc.json or package.json file. The goal goes up the project hierarchy on the filesystem until one of these files is found or the topmost project directory has been reached.

Parameter Details

<arguments>

Defines additional arguments that are passed to the command line that is executed to install the @sap/cds-dk. The arguments are separated by spaces. For example it can be used to enable the verbose output of npm with the additional argument --dd.
  • Type: java.lang.String
  • Since: 1.23.0
  • Required: No
  • User Property: cds.install-cdsdk.arguments

<environmentVariables>

Additional environment variables to set on the command line.
  • Type: java.util.Map
  • Since: 1.26.0
  • Required: No

<force>

Force installation of @sap/cds-dk, even if it's already installed in any version.
  • Type: boolean
  • Since: 1.7.0
  • Required: No
  • User Property: cds.install-cdsdk.force
  • Default: false

<global>

Enables global installation of @sap/cds-dk.
  • Type: boolean
  • Since: 1.7.0
  • Required: No
  • User Property: cds.install-cdsdk.global
  • Default: false

<npmRegistry>

URL of NPM registry to use.
  • Type: java.lang.String
  • Since: 1.7.0
  • Required: No
  • User Property: npmRegistry

<skip>

Skip execution of this goal.
  • Type: boolean
  • Since: 1.7.0
  • Required: No
  • User Property: cds.install-cdsdk.skip
  • Default: false

<version>

Version of @sap/cds-dk to install. The version value has to be a valid semantic version that is used for NPM modules.
  • Type: java.lang.String
  • Since: 1.7.0
  • Required: Yes
  • User Property: cds.install-cdsdk.version
  • Default: ^4

<workingDirectory>

The working directory to be used for installation of @sap/cds-dk. If it's not specified, this goal is using the directory that contains a .cdsrc.json or package.json file. The goal goes up the project hierarchy on the filesystem until one of these files is found or the topmost project directory has been reached.
  • Type: java.io.File
  • Since: 1.7.0
  • Required: No