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

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

downloadDownload 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"
exportExport the content of the bundle into another .json file.ExtendCli.exe bundle export <file path>-ExtendCli.exe bundle export "C:\mybundle.json"
importImport 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 -dOnly downloads missing extensions, will not create an archive.ExtendCli.exe bundle pack -d
templateManage 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 of 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 community

ExtendCli.exe bundle template add

product

labs

ExtendCli.exe bundle template add 14

ExtendCli.exe bundle template 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-stableAdd most recent stable version (LTS or Funcrel) - equivalent to not passing any version option at all.
  • -a | --absolute-latest - Add absolute latest version (including alpha and beta releases).
  • -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

<template id>

The template id refers to one of the predefined bundles available in CAST Extend.labs --latest-funcrel

ExtendCli.exe bundle template add

14

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

...

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

...