...

Operating System	Supported	Supported by reference
Microsoft Windows 8 64-bit
Microsoft Windows 8.1 64-bit
Microsoft Windows 10 64-bit
Microsoft Windows Server 2008 R2 SP1 64-bit (Standard edition)
Microsoft Windows Server 2012 64-bit (Standard edition)
Microsoft Windows Server 2012 R2 64-bit (Standard edition)
Microsoft Windows Server 2016
Microsoft Windows Server 2019
Microsoft Windows Server 2022

Using ExtendCli

ExtendCli is provided as an executable (ExtendCli.exe) and must be used in command line mode. To do so, either:

...

uninstall

config

The config command configures the parameters to allow the tool to connect to CAST Extend over the internet to fetch the required extensions (extensions) for the bundle:

...

Option

...

Description

...

Command line

...

Example of command line

...

set

...

Setup the CAST Extend (online) connection parameters.

...

ExtendCli.exe config set <api-key>

<api-key> is specific to a login for CAST Extend (online). You can find this in your profile.

...

extendCli.exe config set api-key w9876xyz-d999-32ii-9fb0-0123cde45

...

[extend-url] is optional. It refers to the URL to use for CAST Extend (online). When no option is provided, the default value is used: https://extend.castsoftware.com.

...

ExtendCli.exe config set proxy <protocol://[user:password@]host[:port]>]

...

download

This option allows you to download an extension in .nupkg format:

ExtendCli.exe download [options] <extension id>

...

Option

...

Description

...

Command line

...

Example of command line

...

ExtendCli.exe download -d <extension id>

ExtendCli.exe download --skip-dependencies <extension id>

...

ExtendCli.exe download -s false <extension id>

ExtendCli.exe download --latest-stable false <extension id>

...

ExtendCli.exe download -a <extension id>

ExtendCli.exe download --absolute-latest <extension id>

...

ExtendCli.exe download -f <extension id>

ExtendCli.exe download --latest-funcrel <extension id>

...

ExtendCli.exe download -l <extension id>

ExtendCli.exe download --latest-lts <extension id>

...

ExtendCli.exe download -v <release><extension id>

ExtendCli.exe download --version <release><extension id>

...

install

This option allows you to download an extension from CAST Extend and store it on the local machine in %PROGRAMDATA%\CAST\CAST\Extensions (or an alternative location if you have modified the CAST_PLUGINS_ROOT_PATH option in the CastGlobalSettings.ini file):

...

<extensionId>

[--version <version>]

[--ignore-dependencies]

[--username <username>]

[--password <password>]

Use this option to specify an extension that you want to download on to your local machine. Note that you may also need to specify the --username and --password options if the remote server requires authentication

config

The config command configures the parameters to allow the tool to connect to CAST Extend over the internet to fetch the required extensions (extensions) for the bundle:

ExtendCli.exe config set proxy <protocol://[user:password@]host[:port]>]

download

This option allows you to download an extension in .nupkg format:

ExtendCli.exe download [options] <extension id>

install

This option allows you to download an extension from CAST Extend and store it on the local machine in %PROGRAMDATA%\CAST\CAST\Extensions (or an alternative location if you have modified the CAST_PLUGINS_ROOT_PATH option in the CastGlobalSettings.ini file):

Extension com.castsoftware.test version : 1.2.0-funcrel is not present on this machine,
and some schemas are using it. Please use ExtensionDownloader to download it and rerun Servman.

Usage examples

Set the CAST Extend (online) connection properties

Set the api key:

extendCli.exe config set api-key w9876xyz-d999-32ii-9fb0-0123cde45

Image Removed

Set the CAST Extend URL:

ExtendCli.exe config set extend-url "Your URL"

Define the extensions to package

Add one extension

The extension and any dependencies will be added to the list of extensions in the bundle with the following command:

extendCli.exe bundle add com.castsoftware.typescript

You can also use certain [options] as follows:

ExtendCli.exe bundle add com.castsoftware.typescript [options]

These options can be cumulative, for instance to download the absolute latest release (including alpha/beta) or the latest funcrel release or the latest LTS, use the following:

extendCli.exe bundle add com.castsoftware.typescript -a -f -l

To download the absolute latest release (including alpha/beta) or the latest LTS, use the following:

extendCli.exe bundle add com.castsoftware.typescript -a -l

E.g.:

Image Removed

Add extensions from predefined bundles

The "add template" command allows you to add extensions to your bundle that belong to a specific predefined bundle (predefined in CAST Extend (online)). The following command will add template number 14 to the bundle:

ExtendCli.exe bundle template add 14

Image Removed

The following commands will add all "product", "user community" and "labs" extensions:

ExtendCli.exe bundle template add product
ExtendCli.exe bundle template add community
ExtendCli.exe bundle template add labs

Save the bundle

Once you have defined the content of your bundle using the bundle add or template add commands, you can save it to a .json file, so that you can use the same bundle in the future:

Image Removed

Generate the package

When you generate the package, it will create the .extarchive file <last package name|default package name>.extarchive which can then be uploaded into your CAST Extend local server/Offline instance. You must define a folder where the archive file will be placed and the folder must exist already:

ExtendCli.exe bundle pack -o "C:\PRODUCT\Extend Offline\My package"

Image Removed

Navigate to the folder you have defined as output (in the above example the path is C:\PRODUCT\Extend Offline\My package) - it will contain the generated .extarchive file that you can upload into your CAST Extend local server/Offline instance by following the steps described in Upload the bundle to CAST Extend local server or Upload the bundle to CAST Extend Offline:

...

uninstall

Extension com.castsoftware.test version : 1.2.0-funcrel is not present on this machine,
and some schemas are using it. Please use ExtensionDownloader to download it and rerun Servman.

Usage examples

Set the CAST Extend (online) connection properties

Set the api key:

extendCli.exe config set api-key w9876xyz-d999-32ii-9fb0-0123cde45

Image Added

Set the CAST Extend URL:

ExtendCli.exe config set extend-url "Your URL"

Define the extensions to package

Add one extension

The extension and any dependencies will be added to the list of extensions in the bundle with the following command:

extendCli.exe bundle add com.castsoftware.typescript

You can also use certain [options] as follows:

ExtendCli.exe bundle add com.castsoftware.typescript [options]

These options can be cumulative, for instance to download the absolute latest release (including alpha/beta) or the latest funcrel release or the latest LTS, use the following:

extendCli.exe bundle add com.castsoftware.typescript -a -f -l

To download the absolute latest release (including alpha/beta) or the latest LTS, use the following:

extendCli.exe bundle add com.castsoftware.typescript -a -l

E.g.:

Image Added

Add extensions from predefined bundles

The "add template" command allows you to add extensions to your bundle that belong to a specific predefined bundle (predefined in CAST Extend (online)). The following command will add template number 14 to the bundle:

ExtendCli.exe bundle template add 14

Image Added

The following commands will add all "product", "user community" and "labs" extensions:

ExtendCli.exe bundle template add product
ExtendCli.exe bundle template add community
ExtendCli.exe bundle template add labs

Save the bundle

Once you have defined the content of your bundle using the bundle add or template add commands, you can save it to a .json file, so that you can use the same bundle in the future:

Image Added

Generate the package

When you generate the package, it will create the .extarchive file <last package name|default package name>.extarchive which can then be uploaded into your CAST Extend local server/Offline instance. You must define a folder where the archive file will be placed and the folder must exist already:

ExtendCli.exe bundle pack -o "C:\PRODUCT\Extend Offline\My package"

Image Added

Navigate to the folder you have defined as output (in the above example the path is C:\PRODUCT\Extend Offline\My package) - it will contain the generated .extarchive file that you can upload into your CAST Extend local server/Offline instance by following the steps described in Upload the bundle to CAST Extend local server or Upload the bundle to CAST Extend Offline:

Image Added

Advanced configuration settings - appsettings.json

Some additional advanced settings can be configured using the following file which can be edited with a text editor:

<extend_cli_unzip_folder>\appsettings.json

Timeout

"Timeout": 10800

This setting (available in ≥ 2.1.1-funcrel) is specifically for those with very slow network connections. The value is in seconds (the default value is 10800, or 3 hrs) and should only be increased if you are facing timeouts when fetching data from CAST Extend, i.e. when the total time required for CAST Extend to build the bundle and then for ExtendCli to download it exceeds 3 hrs. CAST does NOT recommend decreasing this value.

SettingsPath

"SettingsPath": null

This setting (available in ≥ 2.1.1-funcrel) is set by default to %PROGRAMDATA%\CAST\ExtendCLI and defines where the current instance of ExtendCli will store configuration settings and cache files. If you need to run multiple instances of ExtendCli on one machine, and you want to ensure clear separation of data between each instance, you can define a custom path for the configuration data using this option. For example to set the path to D:\CAST\temp\ExtendCli:

"SettingsPath": "D:\\CAST\\temp\\ExtendCli"