Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Operating SystemSupportedSupported by reference
Microsoft Windows 8 64-bit
(tick)
Microsoft Windows 8.1 64-bit(tick)
Microsoft Windows 10 64-bit(tick)
Microsoft Windows Server 2008 R2 SP1 64-bit (Standard edition)
(tick)
Microsoft Windows Server 2012 64-bit (Standard edition)
(tick)
Microsoft Windows Server 2012 R2 64-bit (Standard edition)
(tick)

Microsoft Windows Server 2016

(tick)
Microsoft Windows Server 2019(tick)
Microsoft Windows Server 2022(tick)

Using ExtendCli

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

...

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] 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).


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

...

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

ExtendCli.exe

...

config set [

...

proxy]

...

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

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>

[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:8080

download

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

ExtendCli.exe download [options] <extension id>

a absolute-latest including alpha and beta releases and all dependencies.

ExtendCli.exe download -a <extension id>

ExtendCli.exe download --absolute-latest a

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 -s false <extension d <extension id>

ExtendCli.exe download --latestskip-stable false dependencies <extension id>

ExtendCli.exe download -s false comd 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
-f a | --absolute-latest-funcrelThis option allows you to download the most recent funcrel release of an extension and extension including alpha and beta releases and all dependencies.

ExtendCli.exe download -f <extension a <extension id>

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

ExtendCli.exe download -f a com.castsoftware.reactjs
-l f | --latest-ltsfuncrelThis option allows you to download the most recent LTS funcrel release of an extension and all dependencies.

ExtendCli.exe download -l f <extension id>

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

ExtendCli.exe download -l f com.castsoftware.reactjs
-v l | --latest-versionltsThis option allows you to download a specific the most recent LTS release of an extension and all dependencies.

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

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

ExtendCli.exe download -v 1l com.1.castsoftware.reactjs
-v | --versionThis option allows you to download a specific release of an extension and all dependencies.

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

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

ExtendCli.exe download -v 1.1.4-funcrel com.castsoftware.reactjs

...

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:

Advanced configuration settings - appsettings.json

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

Code Block
<extend_cli_unzip_folder>\appsettings.json

Timeout

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

Code Block
"SettingsPath": null

This setting (available in ≥ 2.1.1-funcrelis 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:

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


Info

Paths must conform to the following syntax:

  • Enclosed in double quotes
  • Absolute path (not relative)
  • Back slashes are required (forward slashes not accepted) and must be escaped with a back slash