Contrail CLI

The Contrail CLI is the best way to manage your instance data through a programmatic interface.

* Contrail CLI
* Usage
* Autocomplete
* Commands

Usage

``sh-session
$ npm install -g @contrail/cli
$ contrail COMMAND
running command...
$ contrail (--version)
@contrail/cli/3.4.2 win32-x64 node-v22.20.0
$ contrail --help [COMMAND]
USAGE
$ contrail COMMAND
...
`


Autocomplete

To get instructions on how to set up autocomplete for your shell, run contrail autocomplete.

Commands


* contrail app create
* contrail app delete
* contrail app extension deploy
* contrail app extension deployment list
* contrail app getApiKey
* contrail app init
* contrail app install
* contrail app publish
* contrail app uninstall
* contrail app upgrade
* contrail app version major
* contrail app version minor
* contrail app version patch
* [contrail autocomplete [SHELL]](#contrail-autocomplete-shell)
* contrail config create
* [contrail config describe [NAME]](#contrail-config-describe-name)
* contrail config list
* contrail config set
* [contrail config use [NAME]](#contrail-config-use-name)
* contrail file upload FILELOCATION CONTENTTYPE
* contrail groups export
* contrail groups import GROUPSFILE
* [contrail help [COMMANDS]](#contrail-help-commands)
* contrail instance export
* contrail instance import
* contrail load colors DATAFILE CONFIGFILE
* contrail load custom-entity DATAFILE CONFIGFILE
* contrail load line-sheet DATAFILE CONFIGFILE
* contrail load upload-and-load INCOMINGFILE CONFIGFILENAME
* contrail projects export PROJECTNAME
* contrail projects list
* contrail projects load TEMPLATEFILELOCATION
* contrail types exportOptionSetHierarchies
* contrail types getAll
* contrail types getOptionSets
* contrail types loadAll
* contrail types mergeOptionSets FILE
* contrail types mergeTypeProperties FILE TYPEPATHS
* contrail types parseOptionSetsHierarchyLocalFile FILE
* contrail types parseOptionSetsHierarchyValuesToKeysLocalFile FILE
* contrail types parseOptionSetsLocalFiles FILE
* contrail types parseOptionSetsToFolderStructure FILE
* contrail types parseTypesFromFiles TYPEPATHS
* contrail types parseTypesFromLocalFiles TYPEPATHS
* contrail types parseTypesFromTemplateAndDataFromLocalFiles TEMPLATEFILE FILEPATHS
* contrail types parseTypesFromTemplateFromLocalFiles TEMPLATEFILE FILEPATH
* contrail types uploadOptionSetHierarchies
* contrail types uploadOptionSets
* contrail types uploadOptionSetsHierarchyLocalFile FILE NAME
* contrail types uploadRuleSets
* contrail types uploadTypePolicies
* contrail types uploadTypePropertyPolicies
* contrail types uploadTypes
* contrail types uploadUsageInfo
* contrail users export
* contrail users import USERSFILE
* contrail webhooks create
* [contrail webhooks delete [WEBHOOKID]](#contrail-webhooks-delete-webhookid)
* [contrail webhooks getWebhookTrigger [WEBHOOKID]](#contrail-webhooks-getwebhooktrigger-webhookid)
* contrail webhooks list
* contrail workflow-template-definitions install
* contrail workflow-template-definitions list
* contrail workflow-templates delete
* contrail workflow-templates export
* contrail workflow-templates list
* contrail workflow-templates load FILELOCATION

contrail app create

Create a new app. The current organization will be set as the owner of the app

`
USAGE
$ contrail app create [-l error|warn|info|debug] [-e true|false]

FLAGS
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-l, --logLevel= The Log Level


DESCRIPTION
Create a new app. The current organization will be set as the owner of the app

EXAMPLES
$ contrail app create
`

contrail app delete

Delete the app from the app marketplace

`
USAGE
$ contrail app delete [-l error|warn|info|debug] [-e true|false]

FLAGS
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-l, --logLevel= The Log Level


DESCRIPTION
Delete the app from the app marketplace

EXAMPLES
$ contrail app delete
`

contrail app extension deploy

Deploy an extension from the extensions directory to a VibeIQ managed URL.

`
USAGE
$ contrail app extension deploy -i [-l error|warn|info|debug] [-e true|false] [-d]

FLAGS
-d, --debug Enable debug mode
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-i, --identifier= (required) The extension identifier to deploy. The identifier of the extension is the
"identifier" property in the extension defined in the app.yml
-l, --logLevel= The Log Level


DESCRIPTION
Deploy an extension from the extensions directory to a VibeIQ managed URL.

EXAMPLES
$ contrail extension deploy --identifier
`

contrail app extension deployment list

List extension deployments

`
USAGE
$ contrail app extension deployment list [-l error|warn|info|debug] [-e true|false] [-a]

FLAGS
-a, --all List all extension deployments. By default, only the latest 20 are shown
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-l, --logLevel= The Log Level


DESCRIPTION
List extension deployments

EXAMPLES
$ contrail extension deployment list
`

contrail app getApiKey

Get an api key for an installed app

`
USAGE
$ contrail app getApiKey [-l error|warn|info|debug] [-e true|false] [-a ]

FLAGS
-a, --appIdentifier= The app identifier
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-l, --logLevel= The Log Level


DESCRIPTION
Get an api key for an installed app

EXAMPLES
$ contrail app getApiKey
`

contrail app init

Initialize an app directory from a template

`
USAGE
$ contrail app init [-l error|warn|info|debug] [-e true|false]

FLAGS
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-l, --logLevel= The Log Level


DESCRIPTION
Initialize an app directory from a template

EXAMPLES
$ contrail app init
`

contrail app install

Install an app from the marketplace to a specific organization

`
USAGE
$ contrail app install [-l error|warn|info|debug] [-e true|false] [-i ] [-w]

FLAGS
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-i, --appIdentifier= The identifier of the app to install
-l, --logLevel= The Log Level

-w, --installWorkflowTemplates "Install the app's accompanying workflows"

DESCRIPTION
Install an app from the marketplace to a specific organization

EXAMPLES
$ contrail app install --appIdentifier @VibeIQ/Flex-PLM-Connector
`

contrail app publish

Publish the app to the marketplace. This visibility of your app depends on the app.yml configuration ("visibility" property)

`
USAGE
$ contrail app publish [-l error|warn|info|debug] [-e true|false] [-u] [-v] [-d]

FLAGS
-d, --dryRun Dry run the upgrade without actually updating the app.
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-l, --logLevel= The Log Level

-u, --upgrade In addition to deploying, upgrade the installed version of the app in this org to the
latest one.
-v, --verbose Debug the app deployment step and do not remove the intermediate build artifacts.

DESCRIPTION
Publish the app to the marketplace. This visibility of your app depends on the app.yml configuration ("visibility"
property)

EXAMPLES
$ contrail app publish
`

contrail app uninstall

Uninstall an app that is currently installed in a specific organization

`
USAGE
$ contrail app uninstall [-l error|warn|info|debug] [-e true|false] [-i ]

FLAGS
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-i, --appIdentifier= "The identifier of the app to uninstall. The identifier can be found on the app's
page in the marketplace."
-l, --logLevel= The Log Level


DESCRIPTION
Uninstall an app that is currently installed in a specific organization

EXAMPLES
$ contrail app uninstall --name @vibeiq/flexplm-connector
`

contrail app upgrade

Upgrade an installed app in a specific organization

`
USAGE
$ contrail app upgrade [-l error|warn|info|debug] [-e true|false] [-i ] [-l]

FLAGS
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-i, --appIdentifier= The appIdentifier of the app to install
-l, --latest Upgrade to the latest version of the app
-l, --logLevel= The Log Level


DESCRIPTION
Upgrade an installed app in a specific organization

EXAMPLES
$ contrail app upgrade --appIdentifier @VibeIQ/Flex-PLM-Connector --latest
`

contrail app version major

Upgrade the Major app version

`
USAGE
$ contrail app version major [-l error|warn|info|debug] [-e true|false]

FLAGS
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-l, --logLevel= The Log Level


DESCRIPTION
Upgrade the Major app version

EXAMPLES
$ contrail app version major
`

contrail app version minor

Upgrade the Minor app version

`
USAGE
$ contrail app version minor [-l error|warn|info|debug] [-e true|false]

FLAGS
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-l, --logLevel= The Log Level


DESCRIPTION
Upgrade the Minor app version

EXAMPLES
$ contrail app version minor
`

contrail app version patch

Upgrade the Patch app version

`
USAGE
$ contrail app version patch [-l error|warn|info|debug] [-e true|false]

FLAGS
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-l, --logLevel= The Log Level


DESCRIPTION
Upgrade the Patch app version

EXAMPLES
$ contrail app version patch
`

contrail autocomplete [SHELL]

display autocomplete installation instructions

`
USAGE
$ contrail autocomplete [SHELL] [-r]

ARGUMENTS
SHELL shell type

FLAGS
-r, --refresh-cache Refresh cache (ignores displaying instructions)

DESCRIPTION
display autocomplete installation instructions

EXAMPLES
$ contrail autocomplete

$ contrail autocomplete bash

$ contrail autocomplete zsh

$ contrail autocomplete --refresh-cache
`

_See code: @oclif/plugin-autocomplete_

contrail config create

Create a new configuration file

`
USAGE
$ contrail config create --name [-l error|warn|info|debug] [-e true|false]

FLAGS
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-l, --logLevel= The Log Level

--name= (required) The config name

DESCRIPTION
Create a new configuration file

EXAMPLES
$ contrail config create --name demo-org
`

contrail config describe [NAME]

Display the contents of a configuration file

`
USAGE
$ contrail config describe [NAME] [-l error|warn|info|debug] [-e true|false]

ARGUMENTS
NAME The config name

FLAGS
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-l, --logLevel= The Log Level


DESCRIPTION
Display the contents of a configuration file

EXAMPLES
$ contrail config describe demo-org
`

contrail config list

List the configurations

`
USAGE
$ contrail config list [-l error|warn|info|debug] [-e true|false]

FLAGS
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-l, --logLevel= The Log Level


DESCRIPTION
List the configurations

EXAMPLES
$ contrail config list
`

contrail config set

Set a variable in the configuration

`
USAGE
$ contrail config set [-l error|warn|info|debug] [-e true|false] [--orgSlug ] [--environment
dev|development|prod|production] [--apiUserToken ] [--config ]

FLAGS
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-l, --logLevel= The Log Level

--apiUserToken= The API User Token
--config= The config name
--environment= The Environment

--orgSlug= The org slug

DESCRIPTION
Set a variable in the configuration

EXAMPLES
$ contrail config set --orgId 1234
`

contrail config use [NAME]

Use a specific configuration

`
USAGE
$ contrail config use [NAME] [-l error|warn|info|debug] [-e true|false]

ARGUMENTS
NAME The config name

FLAGS
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-l, --logLevel= The Log Level


DESCRIPTION
Use a specific configuration

EXAMPLES
$ contrail config use demo-org
`

contrail file upload FILELOCATION CONTENTTYPE

Uploads a file to the VibeIQ platform

`
USAGE
$ contrail file upload FILELOCATION CONTENTTYPE [-l error|warn|info|debug] [-e true|false]

ARGUMENTS
FILELOCATION The location of the file on upload
CONTENTTYPE [default: application/text] The Content Type of the file being uploaded. Defaults to application/text

FLAGS
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-l, --logLevel= The Log Level


DESCRIPTION
Uploads a file to the VibeIQ platform

EXAMPLES
$ contrail file upload
`

contrail groups export

Export all groups in the org.

`
USAGE
$ contrail groups export [-l error|warn|info|debug] [-e true|false] [-f ] [--overwrite]

FLAGS
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-f, --outFile= [default: groups.yml] The location for the file to be saved
-l, --logLevel= The Log Level

--overwrite Replaces existing files if they exist

DESCRIPTION
Export all groups in the org.

EXAMPLES
$ contrail groups export
`

contrail groups import GROUPSFILE

Import all groups from a yml. Uses the groups.yml file in the current directory.

`
USAGE
$ contrail groups import GROUPSFILE [-l error|warn|info|debug] [-e true|false]

ARGUMENTS
GROUPSFILE The .yml file containing the groups

FLAGS
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-l, --logLevel= The Log Level


DESCRIPTION
Import all groups from a yml. Uses the groups.yml file in the current directory.

EXAMPLES
$ contrail groups import

$ contrail groups import --groupsFile
`

contrail help [COMMANDS]

Display help for contrail.

`
USAGE
$ contrail help [COMMANDS] [-n]

ARGUMENTS
COMMANDS Command to show help for.

FLAGS
-n, --nested-commands Include all nested commands in the output.

DESCRIPTION
Display help for contrail.
`

_See code: @oclif/plugin-help_

contrail instance export

Exports an data of an instance including types and users

`
USAGE
$ contrail instance export [-l error|warn|info|debug] [-e true|false] [-d ] [-f]

FLAGS
-d, --outDir= [default: .] The directory to which to export the instance data. Defaults to the
current directory
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-f, --overwrite Replaces any existing export files in outDir
-l, --logLevel= The Log Level


DESCRIPTION
Exports an data of an instance including types and users

EXAMPLES
$ contrail instance export
`

contrail instance import

Import the data to an instance, including types and users

`
USAGE
$ contrail instance import [-l error|warn|info|debug] [-e true|false] [-d ]

FLAGS
-d, --dir= [default: .] The directory from which to export the instance data. Defaults to the
current directory
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-l, --logLevel= The Log Level


DESCRIPTION
Import the data to an instance, including types and users

EXAMPLES
$ contrail instance import
`

contrail load colors DATAFILE CONFIGFILE

Loads colors object from a CSV file and config YAML

`
USAGE
$ contrail load colors DATAFILE CONFIGFILE [-l error|warn|info|debug] [-e true|false]

ARGUMENTS
DATAFILE The CSV data file
CONFIGFILE The YAML configuration file

FLAGS
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-l, --logLevel= The Log Level


DESCRIPTION
Loads colors object from a CSV file and config YAML

EXAMPLES
$ contrail load colors
`

contrail load custom-entity DATAFILE CONFIGFILE

Loads custom-entity object from a CSV file and config YAML

`
USAGE
$ contrail load custom-entity DATAFILE CONFIGFILE [-l error|warn|info|debug] [-e true|false]

ARGUMENTS
DATAFILE The CSV data file
CONFIGFILE The YAML configuration file

FLAGS
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-l, --logLevel= The Log Level


DESCRIPTION
Loads custom-entity object from a CSV file and config YAML

EXAMPLES
$ contrail load custom-entity
`

contrail load line-sheet DATAFILE CONFIGFILE

Loads line sheet data from a CSV file and config YAML

`
USAGE
$ contrail load line-sheet DATAFILE CONFIGFILE [-l error|warn|info|debug] [-e true|false]

ARGUMENTS
DATAFILE The CSV data file
CONFIGFILE The YAML configuration file

FLAGS
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-l, --logLevel= The Log Level


DESCRIPTION
Loads line sheet data from a CSV file and config YAML

EXAMPLES
$ contrail load line-sheet
`

contrail load upload-and-load INCOMINGFILE CONFIGFILENAME

Upload a csv file and kick off a load job for the uploaded file. The file path must be a reference to a .csv file and the config path must be a reference to a .json or a .yml file

`
USAGE
$ contrail load upload-and-load INCOMINGFILE CONFIGFILENAME [-l error|warn|info|debug] [-e true|false]

ARGUMENTS
INCOMINGFILE The incoming file location
CONFIGFILENAME The configuration file location

FLAGS
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-l, --logLevel= The Log Level


DESCRIPTION
Upload a csv file and kick off a load job for the uploaded file. The file path must be a reference to a .csv file and
the config path must be a reference to a .json or a .yml file

EXAMPLES
$ contrail load-processor upload-and-load
`

contrail projects export PROJECTNAME

Export a project.

`
USAGE
$ contrail projects export PROJECTNAME [-l error|warn|info|debug] [-e true|false]

FLAGS
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-l, --logLevel= The Log Level


DESCRIPTION
Export a project.

EXAMPLES
$ contrail project export
`

contrail projects list

Get a list of all projects.

`
USAGE
$ contrail projects list [-l error|warn|info|debug] [-e true|false]

FLAGS
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-l, --logLevel= The Log Level


DESCRIPTION
Get a list of all projects.

EXAMPLES
$ contrail project list
`

contrail projects load TEMPLATEFILELOCATION

Configure a project from a yml file.

`
USAGE
$ contrail projects load TEMPLATEFILELOCATION [-l error|warn|info|debug] [-e true|false]

ARGUMENTS
TEMPLATEFILELOCATION The location to the template file

FLAGS
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-l, --logLevel= The Log Level


DESCRIPTION
Configure a project from a yml file.

EXAMPLES
$ contrail project load
`

contrail types exportOptionSetHierarchies

export OptionSetHierarchies into CSVs.

`
USAGE
$ contrail types exportOptionSetHierarchies [-l error|warn|info|debug] [-e true|false]

FLAGS
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-l, --logLevel= The Log Level


DESCRIPTION
export OptionSetHierarchies into CSVs.

EXAMPLES
$ contrail types exportOptionSetsHierarchies
`

contrail types getAll

Get all Types and associated data for your Org

`
USAGE
$ contrail types getAll [-l error|warn|info|debug] [-e true|false] [-d ] [-f]

FLAGS
-d, --outDir= [default: .] The directory to which to export the type data. Defaults to the current
directory
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-f, --overwrite Replaces any existing export files in outDir
-l, --logLevel= The Log Level


DESCRIPTION
Get all Types and associated data for your Org

EXAMPLES
$ contrail types getAll
`

contrail types getOptionSets

Get all option sets and associated data for your Org

`
USAGE
$ contrail types getOptionSets [-l error|warn|info|debug] [-e true|false] [--format YAML|CSV] [-d ] [-f]

FLAGS
-d, --outDir= [default: .] The directory to which to export the option sets data. Defaults to the
current directory
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-f, --overwrite Replaces any existing export files in outDir
-l, --logLevel= The Log Level

--format=

DESCRIPTION
Get all option sets and associated data for your Org

EXAMPLES
$ contrail types getOptionSets --format
`

contrail types loadAll

loads all the type data that has been exported by getAll

`
USAGE
$ contrail types loadAll [-l error|warn|info|debug] [-e true|false] [-d ]

FLAGS
-d, --dir= [default: .] The directory from which to load the types data. Defaults to the current
directory.
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-l, --logLevel= The Log Level


DESCRIPTION
loads all the type data that has been exported by getAll

EXAMPLES
$ contrail types loadAll
`

contrail types mergeOptionSets FILE

Merge the OptionSets from an existing org and the OptionSets passed in. OptionSets File must be .yml or a directory with yml files. The files can contain a single option set or an array of option sets.

`
USAGE
$ contrail types mergeOptionSets FILE [-l error|warn|info|debug] [-e true|false]

ARGUMENTS
FILE File (or directory) to merge with the cloud option sets

FLAGS
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-l, --logLevel= The Log Level


DESCRIPTION
Merge the OptionSets from an existing org and the OptionSets passed in. OptionSets File must be .yml or a directory
with yml files. The files can contain a single option set or an array of option sets.

EXAMPLES
$ contrail types mergeOptionSets
`

contrail types mergeTypeProperties FILE TYPEPATHS

Merge the TypeProperties from an existing org and the TypeProperties passed in. Add to Types via TypePath File must be .yml

`
USAGE
$ contrail types mergeTypeProperties FILE TYPEPATHS [-l error|warn|info|debug] [-e true|false]

ARGUMENTS
FILE File to parse
TYPEPATHS A list of the type paths to merge

FLAGS
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-l, --logLevel= The Log Level


DESCRIPTION
Merge the TypeProperties from an existing org and the TypeProperties passed in. Add to Types via TypePath File must be
.yml

EXAMPLES
$ contrail types mergeTypeProperties
`

contrail types parseOptionSetsHierarchyLocalFile FILE

Parse CSV file into OptionSetHierarchy

`
USAGE
$ contrail types parseOptionSetsHierarchyLocalFile FILE [-l error|warn|info|debug] [-e true|false]

ARGUMENTS
FILE File to parse

FLAGS
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-l, --logLevel= The Log Level


DESCRIPTION
Parse CSV file into OptionSetHierarchy

EXAMPLES
$ contrail types parseOptionSetsHierarchyLocalFile
`

contrail types parseOptionSetsHierarchyValuesToKeysLocalFile FILE

Parse CSV file into OptionSetHierarchy

`
USAGE
$ contrail types parseOptionSetsHierarchyValuesToKeysLocalFile FILE [-l error|warn|info|debug] [-e true|false]

ARGUMENTS
FILE File to parse

FLAGS
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-l, --logLevel= The Log Level


DESCRIPTION
Parse CSV file into OptionSetHierarchy

EXAMPLES
$ contrail types parseOptionSetsHierarchyValuesToKeysLocalFile
`

contrail types parseOptionSetsLocalFiles FILE

Parse CSV files into OptionSets. Style denotes the format the csv is in. If the csv file has a column for option setname, option key, and option label, use "NameAndLabelAndKey". If the file has one column for each option set with the rows being the label value use "LabelsInColumn". In the case of LabelsInColumn, the keys are autogenerated.

`
USAGE
$ contrail types parseOptionSetsLocalFiles FILE --csvStyle NameAndLabelAndKey|LabelsInColumn [-l error|warn|info|debug] [-e
true|false]

ARGUMENTS
FILE File to parse

FLAGS
-e, --alwaysConfirmEnv= [default: true] The Environment variables

-l, --logLevel= The Log Level

--csvStyle= (required)


DESCRIPTION
Parse CSV files into OptionSets. Style denotes the format the csv is in. If the csv file has a column for option
setname, option key, and option label, use "NameAndLabelAndKey". If the file has one column for each option set with
the rows being the label value use "LabelsInColumn". In the case of LabelsInColumn, the keys are autogenerated.

Example file for LabelsInColumn would be

Gender, Countries, Brands
men, spain, prada
women, france, converse
unisex, australia
, usa
, egypt

Example file for NameAndLabelAndKey would be

Gender, g_men, Men
Bender, g_women, Women
Gender g_uni, Unisex
Countries, co_spain, Spain
Countries, co_france, France
Countries, co_aus, Australia
Countries, co_usa, United States of America,
Countries, co_egypt, Egypt


EXAMPLES
$ contrail types parseOptionSetsLocalFiles