Info
Summary: Information about ExtendCli, a command line tool to create and manage bundles for CAST Extend local server / CAST Extend Offline.

What is ExtendCli?

CAST Extend local server and CAST Extend Offline (in v. ≥ 1.1.0) are delivered "empty" without any preconfigured extensions - you will therefore need to populate them with extensions before you can use them. In addition, you may want to update CAST Extend local server/Offline to add new extensions or to include more recent releases of extensions. The ExtendCli tool is designed to perform this job and will allow the integration of the following (see Contributor types for more information about the types of extensions that are available):

...

Info
ExtendCli does not replace CAST Extension Downloader - a tool used to download Extensions from CAST Extend (live or offline). All dependent extensions of a given extension will be included when using ExtendCli.

What's new

See ExtendCli - Release Notes for more information.

Prerequisites

To use ExtendCli, the following is required:

Supported Operating Systems

...

Where can you find ExtendCli?

ExtendCli is provided in two ways:

As a separate downloadable tool, available from CAST Extend: https://extend.castsoftware.com/#/extension?id=com.castsoftware.aip.extendcli&version=latest - CAST highly recommends that you use this tool to benefit from the most recent updates and changes.
On each Node instance in the following default location:

Code Block
Console ≥ 2.x Node %PROGRAMFILES%\CAST\AIP-Node\bin\ExtendCli\ExtendCli.exe Console 1.x Node %PROGRAMFILES%\CAST\AipConsole\AipNode\bin\ExtendCli\ExtendCli.exe

What's new

See ExtendCli - Release Notes for more information.

Prerequisites

To use ExtendCli, the following is required:

Supported Operating Systems

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 R2 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:

...

Code Block

language	text

ExtendCli.exe [command][options]

Available commands

...

Info

Note that before using ExtendCli with the bundle, download and install commands, you MUST first set the following two values with the config command:

ExtendCli.exe config set extend-url https://extend.castsoftware.com

ExtendCli.exe config set api-key <your_api_key>

See the examples below.

Available commands

bundle
config
download
install (available in ≥ 1.1.0-funcrel)
uninstall (available in ≥ 1.1.0-funcrel)

...

Info

You can determine the <extension id> of a given extension using the CAST Extend website:

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

-d | --skip-dependenciesThis option allows you to download an extension without any dependencies. CAST only recommends using this option if you understand the implication - an extension will not function correctly without its dependencies.

ExtendCli.exe download -d <extension id>

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

ExtendCli.exe download -d com.castsoftware.reactjs-s | --latest-stable <true|false>This option allows you to configure whether to download the most recent stable release of an extension (-LTS or funcrel). The default behaviour (i.e. when the option is omitted) the action is set to true and the latest-stable release will be downloaded. Explicitly add the option and set it to false to ensure that the latest stable release is not downloaded.

ExtendCli.exe download -s false <extension id>

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

ExtendCli.exe download -s false com.castsoftware.reactjs-a | --absolute-latest

Option

Description

Command line

Comment

Example of command line

add

Add extensions to the active bundle.

ExtendCli.exe bundle add <extension id> [options]

When no option is provided, the most recent stable release of the extension is taken.

Info
Note that [options] can be cumulative.

ExtendCli.exe bundle add com.castsoftware.reactjs

ExtendCli.exe bundle add <extension id> -D

ExtendCli.exe bundle add <extension id> --skip-dependencies

Skip extension dependencies.

ExtendCli.exe bundle add com.castsoftware.reactjs -D

ExtendCli.exe bundle add <extension id> -S

ExtendCli.exe bundle add <extension id> --latest-stable

Add most recent stable version (LTS or Funcrel).

ExtendCli.exe bundle add com.castsoftware.reactjs -S

ExtendCli.exe bundle add <extension id> -a

ExtendCli.exe bundle add <extension id> --absolute-latest

Add absolute latest version (including alpha and beta releases).

ExtendCli.exe bundle add com.castsoftware.reactjs -a

ExtendCli.exe bundle add <extension id> -f

ExtendCli.exe bundle add <extension id> --latest-funcrel

Add latest funcrel release.

ExtendCli.exe bundle add com.castsoftware.reactjs --latest-funcrel

ExtendCli.exe bundle add <extension id> -l

ExtendCli.exe bundle add <extension id> --latest-lts

Add latest LTS release.

ExtendCli.exe bundle add com.castsoftware.reactjs --latest-lts

ExtendCli.exe bundle add <extension id> -v

ExtendCli.exe bundle add <extension id> --version

Add a specific release of the extension.

ExtendCli.exe bundle add com.castsoftware.reactjs --version 1.1.0-funcrel

clear

Clear your bundle.

ExtendCli.exe bundle clear

-

ExtendCli.exe bundle clear

download

Download extensions in the current bundle as .nupkg files

ExtendCli.exe bundle download [options]

-

ExtendCli.exe bundle download

ExtendCli.exe bundle download -o | --outdir "<path>"

In < 1.1.0-funcrel, the specified folder must already exist. In ≥ 1.1.0-funcrel, the folder will be created if it does not exist.

ExtendCli.exe bundle download -o "C:\temp"

export

Export the content of the bundle into another .json file.

ExtendCli.exe bundle export <file path>

-

ExtendCli.exe bundle export "C:\mybundle.json"

import

Import the content of an existing exported .json file into your bundle.

ExtendCli.exe bundle import <file path>

-

ExtendCli.exe bundle import "C:\mybundle.json"

list

List the extension versions/releases in your bundle.

ExtendCli.exe bundle list

-

ExtendCli.exe bundle list

pack

Create an .extarchive file from your bundle that can be imported into CAST Extend Offline.

ExtendCli.exe bundle pack [options]

-

ExtendCli.exe bundle pack

ExtendCli.exe bundle pack -o "<path>"

Target folder where the archive will be saved. This folder must already exist.

ExtendCli.exe bundle pack -o "C:\Temp\Bundles"

ExtendCli.exe bundle pack -d

Only downloads missing extensions, will not create an archive.

ExtendCli.exe bundle pack -d

template

Manage predefined bundles.

ExtendCli.exe bundle template <command><options>

Manage predefined templates available in CAST Extend and include them in your extension.

-

ExtendCli.exe bundle template add product | community | labs | <template id>

Allows the addition of all production extensions into the absolute latest version (including alpha and beta releases) of all official / community / labs / or specific predefined bundle of extensions into a template bundle. Available in ≥ 1.1.0-funcrel.

ExtendCli.exe bundle template add product

ExtendCli.exe bundle template add

The template id refers to one of the predefined bundles available in CAST Extend.community

ExtendCli.exe bundle template add labs

ExtendCli.exe bundle template add 14

ExtendCli.exe bundle template

list

Lists the seven predefined bundles:

Id = 1 → All product extensions (note that this is deprecated from ≥ 1.1.0-funcrel - you should use "product" instead)
Id = 4 → Microsoft .NET
Id= 5 → Mobile
Id = 6 → Web
Id = 14 → Data
Id = 16 → Java / JEE
Id = 17 → Security (this bundle provides support for Security analysis for all technologies)
Id = product (from ≥ 1.1.0-funcrel)
Id = labs (from ≥ 1.1.0-funcrel)
Id = community (from ≥ 1.1.0-funcrel)

ExtendCli.exe bundle template list

ExtendCli.exe bundle template content <template Id>

Displays the content of one predefined bundle.

ExtendCli.exe bundle template content 17

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.

Info
Note that this command only needs to be used once (unless you decide to use a different api-key for an alternative CAST Extend (online) login).

...

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.

Info
Note that this command only needs to be used once (unless you decide to use a different URL).

...

[proxy] is optional. It should be used:

when your network environment uses a proxy for internet access.
when the machine you are running ExtendCli on does not have operating system level proxy settings enabled.

The syntax is as follows:

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

Note that if you are using the Use setup script option (1), CAST also recommends enabling the Automatically detect settings option (2):

Image Removed

...

add product | community | labs | <template id> -s | --latest-stable

ExtendCli.exe bundle template add product | community | labs | <template id> -a | --absolute-latest

ExtendCli.exe bundle template add product | community | labs | <template id> -f | --latest-funcrel

ExtendCli.exe bundle template add product | community | labs | <template id> -l | --latest-lts

Allows the addition of all official / community / labs / or specific predefined bundle of extensions into a template bundle AND allows you to specify the release of extensions you require:

-s | --latest-stable - Add most recent stable version (LTS or Funcrel)
-a | --absolute-latest - Add absolute latest version (including alpha and beta releases) - equivalent to not passing any version option at all (i.e. the default).
-f | --latest-funcrel - Add latest funcrel release.
-l | --latest-lts - Add latest LTS release.

Available in ≥ 3.0.0-funcrel.

ExtendCli.exe bundle template add product --latest-stable

ExtendCli.exe bundle template add community --absolute-latest

ExtendCli.exe bundle template add labs --latest-funcrel

ExtendCli.exe bundle template add 14 --latest-lts

ExtendCli.exe bundle template list

Lists the seven predefined bundles:

Id = 1 → All product extensions (note that this is deprecated from ≥ 1.1.0-funcrel - you should use "product" instead)
Id = 4 → Microsoft .NET
Id= 5 → Mobile
Id = 6 → Web
Id = 14 → Data
Id = 16 → Java / JEE
Id = 17 → Security (this bundle provides support for Security analysis for all technologies)
Id = product (from ≥ 1.1.0-funcrel)
Id = labs (from ≥ 1.1.0-funcrel)
Id = community (from ≥ 1.1.0-funcrel)

ExtendCli.exe bundle template list

ExtendCli.exe bundle template content <template Id>

Displays the content of one predefined bundle.

ExtendCli.exe bundle template content 17

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

Comment

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.

Info
Note that this command only needs to be used once (unless you decide to use a different api-key for an alternative CAST Extend (online) login).

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

ExtendCli.exe config set [extend-url]

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

Info
Note that this command only needs to be used once (unless you decide to use a different URL).

extendCli.exe config set extend-url "your URL"

ExtendCli.exe config set [storage-dir]

[storage-dir] refers to the location where extension packages will be downloaded to when using the download option. When no option is provided, the default value is used:

%PROGRAMDATA%\CAST\ExtendCLI\packages

If ExtendCli is being run using the executable provided with a Node, then the default storage location is set to:

%PROGRAMDATA%\CAST\AIP-Node\ExtendCliConfig\packages
%PROGRAMDATA%\CAST\AIP-Console-Standalone\ExtendCliConfig\packages

extendCli.exe config set storage-dir C:\CAST\temp

ExtendCli.exe config set [proxy] <proxy_address>

Info
Where possible ExtendCli.exe config proxy <proxy_address> [-options] introduced in 3.0.0 should be used instead.

[proxy] is optional. It should be used:

when your network environment uses a proxy for internet access.
when the machine you are running ExtendCli on does not have operating system level proxy settings enabled.

The syntax is as follows:

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

Note that if you are using the Use setup script option (1), CAST also recommends enabling the Automatically detect settings option (2):

Image Added

extendCli.exe config set proxy http://proxy_user:proxy_password@proxy.corp.com:3128

proxy

Configure a connection via a proxy (available in ≥ 3.0.0)

ExtendCli.exe config proxy <proxy_address> [-options]

This option should be used instead of ExtendCli.exe config set [proxy] where possible.

when your network environment uses a proxy for internet access.
and when the machine you are running ExtendCli on does not have operating system level proxy settings enabled.

The syntax is as follows:

Code Block
ExtendCli.exe config proxy <protocol://host[:port]> [-options]

The following options are available:

-b | --bypass-on-local > Do not use the configured proxy settings for local requests.
-c | --default-credentials > Use the current Microsoft Windows account to authenticate with the proxy server.
-i | --bypass > Specifies one single address that will not use the proxy. Can be used multiple times in a command.
-u | --username > Specifies the username to authenticate with the proxy server if authentication is required.
-p | --password > Specifies the password for the username used to authenticate with the proxy server if authentication is required.
-d | --domain > Specifies the domain for domain restricted proxy servers.
-r | --reset > Will reset any previously configured proxy settings, i.e. when using ExtendCli commands in a batch file or consecutively in a CMD window.

Note that if you are using the Use setup script option (1), CAST also recommends enabling the Automatically detect settings option (2):

Image Added

ExtendCli.exe config proxy http://proxy.corp.com:3128

ExtendCli.exe config proxy http://proxy.corp.com:3128 -c

ExtendCli.exe config proxy http://proxy.corp.com:3128 -u my_user -p my_password

ExtendCli.exe config proxy http://proxy.corp.com:3128 -u my_user -p my_password -i http://some.address.com -i http://some.other.address.com -i *:8080 -i https://*:*

download

This option allows you to download an extension in .nupkg format. The package will NOT be downloaded to %PROGRAMDATA%\CAST\CAST\Extensions, instead the package will be downloaded to the following default locations:

%PROGRAMDATA%\CAST\ExtendCLI\packages

If ExtendCli is being run using the executable provided with a Node, then the default storage location is set to:

%PROGRAMDATA%\CAST\AIP-Node\ExtendCliConfig\packages
%PROGRAMDATA%\CAST\AIP-Console-Standalone\ExtendCliConfig\packages

The download folder can be set to an alternative location using the config set storage-dir option.

ExtendCli.exe download [options] <extension id>

Option	Description	Command line	Example of command line
-d \| --skip-dependencies	This option allows you to download an extension without any dependencies. CAST only recommends using this option if you understand the implication - an extension will not function correctly without its dependencies.	ExtendCli.exe download -d <extension id> ExtendCli.exe download --skip-dependencies <extension id>	ExtendCli.exe download -d com.castsoftware.reactjs
-s \| --latest-stable <true\|false>	This option allows you to configure whether to download the most recent stable release of an extension (-LTS or funcrel). The default behaviour (i.e. when the option is omitted) the action is set to true and the latest-stable release will be downloaded. Explicitly add the option and set it to false to ensure that the latest stable release is not downloaded.	ExtendCli.exe download -s false <extension id> ExtendCli.exe download --latest-stable false <extension id>	ExtendCli.exe download -s false com.castsoftware.reactjs
-a \| --absolute-latest	This option allows you to download the most recent release of an extension including alpha and beta releases and all dependencies.	ExtendCli.exe download -a <extension id> ExtendCli.exe download --absolute-latest <extension id>	ExtendCli.exe download -a com.castsoftware.reactjs
-f \| --latest-funcrel	This option allows you to download the most recent funcrel release of an extension and all dependencies.	ExtendCli.exe download -f <extension id> ExtendCli.exe download --latest-funcrel <extension id>	ExtendCli.exe download -f com.castsoftware.reactjs
-l \| --latest-lts	This option allows you to download the most recent LTS release of an extension including alpha and beta releases and extension and all dependencies.	ExtendCli.exe download -a <extension l <extension id> ExtendCli.exe download --absolutelatest-latest lts <extension id>	ExtendCli.exe download -a l com.castsoftware.reactjs
-f v \| --latest-funcrelversion	This option allows you to download the most recent funcrel a specific release of an extension and all dependencies.	ExtendCli.exe download -f <extension v <release><extension id> ExtendCli.exe download --latest-funcrel <extension version <release><extension id>	ExtendCli.exe download -f v 1.1.4-funcrel com.castsoftware.reactjs-l \| --latest-lts

install

This option allows you to download

...

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>

...

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):

install

<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

Option	Description
<extensionId>	This option allows you to

...

install

<extensionId>

[--version <version>]

specify a particular extension for download using its ID - this is a mandatory option. The ID of a CAST AIP extension always takes the form com.castsoftware.<name>, without any version numbers. Note that the most recent versions of an extension's dependencies will always be downloaded alongside the extension, unless you are using the [--ignore-dependencies]

[--username <username>]

option - see below.

[--

password <password>

version <version>]

Use this

This option allows you 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

When connecting to a server that requires authentication (for example https://extend.castsoftware.com:443/api) to download an extension (with the install option), use these two options to specify your credentials. You will require an account on the remote server to authenticate when using CAST Extend. You can find out about registering for an account in CAST Extend website

Option	Description
<extensionId> a specific version of the extension for download using its version number. This option is not mandatory. When not included, the most recent version of the extension you require will always be downloaded.
[--ignore-dependencies]	This option allows you to specify a particular extension for download using its ID - this is a mandatory option. The ID of a CAST AIP extension always takes the form com.castsoftware.<name>, without any version numbers. Note that download an extension without any dependencies. CAST only recommends using this option if you understand the implication - an extension will not function correctly without its dependencies. This option is not mandatory. When not included, the most recent versions of an extension's dependencies will always be downloaded alongside the extension, unless you are using the [--ignore-dependencies] option - see below.
[--version <version>]	This option allows you to specify a specific version of the extension for download using its version number. This option is not mandatory. When not included, the most recent version of the extension you require will always be downloaded.
[--ignore-dependencies]	This option allows you to download an extension without any dependencies. CAST only recommends using this option if you understand the implication - an extension will not function correctly without its dependencies. This option is not mandatory. When not included, the most recent versions of an extension's dependencies will always be downloaded.
[--username <username>] [--password <password>]	.
[--username <username>] [--password <password>]	When connecting to a server that requires authentication (for example https://extend.castsoftware.com:443/api) to download an extension (with the install option), use these two options to specify your credentials. You will require an account on the remote server to authenticate when using CAST Extend. You can find out about registering for an account in CAST Extend website.

SHA256 data integrity checks

Info
Available in ≥ 3.1.0. An integrity check is only performed if the source Extend server generates a hash code.

When using the install command, ExtendCLI will automatically verify each extension using a unique SHA256 hash code generated by the source Extend server (whether this is CAST's official Extend server, or an Extend Local server) to ensure the integrity of the downloaded data::

If the integrity check passes, then the extension will be installed without issue
If the integrity check fails, then an error is thrown and the downloaded extension is deleted and will not be installed. In this scenario, you should attempt the install procedure again - if they integrity check fails again, please contact CAST Support.

uninstall

uninstall

extensionId

[--version <version>]

Use this option to specify an extension that you have downloaded to your machine and that you now want to remove from your machine:

Option	Description
extensionId	This option allows you to specify a particular extension for removal using its ID - this is a mandatory option. The ID of a CAST AIP extension always takes the form com.castsoftware.<name>, without any version numbers.
[--version <version>]	This option allows you to specify a specific version of the extension for download using its version number. This option is not mandatory. When not included, the most recent version of the extension you require will always be deleted from your machine.

Note that:

removing an extension will only delete the extension files on the local machine. It does not remove the extension from any CAST AIP databases/schemas that it has been installed to.
removing an extension only removes the specific extension. Any dependencies are left on the machine as other extensions may require them.
removing an extension from your machine will cause the following log message to be displayed in CAST Server Manager when CAST AIP databases/schemas that use the extension are detected:

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.

Anchor
examples
examples
Usage examples

Set the CAST Extend (online) connection properties

Set the api keyCAST Extend URL:

Code Block
extendCliExtendCli.exe config set api-key w9876xyz-d999-32ii-9fb0-0123cde45

Image Removed

...

extend-url "Your URL"

Set the api key:

Code Block
ExtendCli.exe config set extend-url "Your URL"api-key w9876xyz-d999-32ii-9fb0-0123cde45

Image Added

Define the extensions to package

...

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

...

can be edited with a text editor:

Code Block

Downloadable tool
<extend_cli_unzip_folder>\appsettings.json

Console ≥ 2.x Node
%PROGRAMFILES%\CAST\AIP-Node\bin\ExtendCli\appsettings.json

Console 1.x Node
%PROGRAMFILES%\CAST\AipConsole\AipNode\bin\ExtendCli\appsettings.json

Timeout

Code Block
"Timeout": 10800

This setting is (available in ≥ 2.1.1-funcrel) is specifically for those with very slow network connections. The default 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.

...

Code Block
"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:

...

Page tree

Versions Compared

Old Version 63

New Version Current

Key

What is ExtendCli?

What's new

Prerequisites

Supported Operating Systems

Where can you find ExtendCli?

What's new

Prerequisites

Supported Operating Systems

Using ExtendCli

Available commands

Available commands

download

config

config

download

install

SHA256 data integrity checks

uninstall

Anchor
examples
examples
Usage examples

Set the CAST Extend (online) connection properties

Define the extensions to package

Timeout

Page tree

Page History

Versions Compared

Old Version 63

New Version Current

Key

What is ExtendCli?

What's new

Prerequisites

Supported Operating Systems

Where can you find ExtendCli?

What's new

Prerequisites

Supported Operating Systems

Using ExtendCli

Available commands

Available commands

download

config

config

download

install

SHA256 data integrity checks

uninstall

AnchorexamplesexamplesUsage examples

Set the CAST Extend (online) connection properties

Define the extensions to package

Timeout

Anchor
examples
examples
Usage examples