@contrail/cli

Contrail CLI

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

• Contrail CLI
• Usage
• Autocomplete
• Commands

Usage

$ npm install -g @contrail/cli
$ contrail COMMAND
running command...
$ contrail (--version)
@contrail/cli/3.2.0 darwin-arm64 node-v20.18.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 config create
• contrail config describe [NAME]
• contrail config list
• contrail config set
• contrail config use [NAME]
• contrail file upload FILELOCATION CONTENTTYPE
• contrail groups export
• contrail groups import GROUPSFILE
• 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 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=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

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=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

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 <value> [-l error|warn|info|debug] [-e true|false] [-d]

FLAGS
  -d, --debug                      Enable debug mode
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -i, --identifier=<value>         (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=<option>          The Log Level
                                   <options: error|warn|info|debug>

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

EXAMPLES
  $ contrail extension deploy --identifier <extensionIdentifier>

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=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

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 <value>]

FLAGS
  -a, --appIdentifier=<value>      The app identifier
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

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=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

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 <value>] [-w]

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -i, --appIdentifier=<value>      The identifier of the app to install
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>
  -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=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>
  -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 <value>]

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -i, --appIdentifier=<value>      "The identifier of the app to uninstall. The identifier can be found on the app's
                                   page in the marketplace."
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

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 <value>] [-l]

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -i, --appIdentifier=<value>      The appIdentifier of the app to install
  -l, --latest                     Upgrade to the latest version of the app
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

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=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

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=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

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=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

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 <value> [-l error|warn|info|debug] [-e true|false]

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>
  --name=<value>                   (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=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

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=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

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 <value>] [--environment
    dev|development|prod|production] [--apiUserToken <value>] [--config <value>]

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>
  --apiUserToken=<value>           The API User Token
  --config=<value>                 The config name
  --environment=<option>           The Environment
                                   <options: dev|development|prod|production>
  --orgSlug=<value>                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=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

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=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Uploads a file to the VibeIQ platform

EXAMPLES
  $ contrail file upload <FILE_LOCATION>

contrail groups export

Export all groups in the org.

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

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -f, --outFile=<value>            [default: groups.yml] The location for the file to be saved
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>
  --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=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

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

EXAMPLES
  $ contrail groups import <GROUPS_FILE>

  $ contrail groups import --groupsFile <GROUPS_FILE>

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 <value>] [-f]

FLAGS
  -d, --outDir=<value>             [default: .] The directory to which to export the instance data. Defaults to the
                                   current directory
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -f, --overwrite                  Replaces any existing export files in outDir
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

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 <value>]

FLAGS
  -d, --dir=<value>                [default: .] The directory from which to export the instance data. Defaults to the
                                   current directory
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

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=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Loads colors object from a CSV file and config YAML

EXAMPLES
  $ contrail load colors <CSV file> <config yaml>

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=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

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

EXAMPLES
  $ contrail load custom-entity <CSV file> <config yaml>

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=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

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

EXAMPLES
  $ contrail load line-sheet <CSV file> <config yaml>

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=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

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  <File Path> <Config Path>

contrail projects export PROJECTNAME

Export a project.

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

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Export a project.

EXAMPLES
  $ contrail project export <PROJECT_NAME>

contrail projects list

Get a list of all projects.

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

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

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=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Configure a project from a yml file.

EXAMPLES
  $ contrail project load <TEMPLATE_FILE_LOCATION>

contrail types exportOptionSetHierarchies

export OptionSetHierarchies into CSVs.

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

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

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 <value>] [-f]

FLAGS
  -d, --outDir=<value>             [default: .] The directory to which to export the type data. Defaults to the current
                                   directory
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -f, --overwrite                  Replaces any existing export files in outDir
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

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 <value>] [-f]

FLAGS
  -d, --outDir=<value>             [default: .] The directory to which to export the option sets data. Defaults to the
                                   current directory
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -f, --overwrite                  Replaces any existing export files in outDir
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>
  --format=<option>                <options: YAML|CSV>

DESCRIPTION
  Get all option sets and associated data for your Org

EXAMPLES
  $ contrail types getOptionSets --format <YAML or CSV>

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 <value>]

FLAGS
  -d, --dir=<value>                [default: .] The directory from which to load the types data. Defaults to the current
                                   directory.
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

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.

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

ARGUMENTS
  FILE  File to merge with the cloud option sets

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Merge the OptionSets from an existing org and the OptionSets passed in. OptionSets File must be .yml.

EXAMPLES
  $ contrail types mergeOptionSets <File Path>

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=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

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 <File Path> <TypePaths>

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=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Parse CSV file into OptionSetHierarchy

EXAMPLES
  $ contrail types parseOptionSetsHierarchyLocalFile <File Paths>

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=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Parse CSV file into OptionSetHierarchy

EXAMPLES
  $ contrail types parseOptionSetsHierarchyValuesToKeysLocalFile <File Paths>

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=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>
  --csvStyle=<option>              (required)
                                   <options: NameAndLabelAndKey|LabelsInColumn>

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 <File Paths> <style>

contrail types parseOptionSetsToFolderStructure FILE

Parses a YAML file containing multiple option sets (like the output of parseOptionSetLocalFiles) and separates them into multiple files in a directory. The resulting files can be uploaded using uploadOptionSets

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

ARGUMENTS
  FILE  File to parse

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Parses a YAML file containing multiple option sets (like the output of `parseOptionSetLocalFiles`) and separates them
  into multiple files in a directory. The resulting files can be uploaded using `uploadOptionSets`

EXAMPLES
  $ contrail types parseOptionSetsLocalFiles <File Paths>

contrail types parseTypesFromFiles TYPEPATHS

Parse CSV files into Types and OptionSets from VibeIQ Files.

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

ARGUMENTS
  TYPEPATHS  A list of the VibeIQ file IDs to parse

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Parse CSV files into Types and OptionSets from VibeIQ Files.
  File must be .yml.

EXAMPLES
  $ contrail types parseTypesFromFiles <fileIds>

contrail types parseTypesFromLocalFiles TYPEPATHS

Parse CSV files into Types and OptionSets from local files.

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

ARGUMENTS
  TYPEPATHS  A list of the files to parse

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Parse CSV files into Types and OptionSets from local files.

EXAMPLES
  $ contrail types parseTypesFromLocalFiles <File Paths>

contrail types parseTypesFromTemplateAndDataFromLocalFiles TEMPLATEFILE FILEPATHS

Parse CSV files into Types and OptionSets from local type template files.

USAGE
  $ contrail types parseTypesFromTemplateAndDataFromLocalFiles TEMPLATEFILE FILEPATHS [-l error|warn|info|debug] [-e
  true|false]

ARGUMENTS
  TEMPLATEFILE  The template file to use
  FILEPATHS     A list of data file to use

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Parse CSV files into Types and OptionSets from local type template files.

EXAMPLES
  $ contrail types parseTypesFromTemplateAndDataFromLocalFiles <Template Path> <File Paths>

contrail types parseTypesFromTemplateFromLocalFiles TEMPLATEFILE FILEPATH

Parse CSV files into Types and OptionSets from local type template files.

USAGE
  $ contrail types parseTypesFromTemplateFromLocalFiles TEMPLATEFILE FILEPATH [-l error|warn|info|debug] [-e true|false]

ARGUMENTS
  TEMPLATEFILE  The template file to use
  FILEPATH      The data file to use

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Parse CSV files into Types and OptionSets from local type template files.

EXAMPLES
  $ contrail types parseTypesFromTemplateFromLocalFiles <Template File> <Data File>

contrail types uploadOptionSetHierarchies

Upload Option Set Hierarchies for your Org. Option set hierarchies are loaded from .yml files in the option-set-hierarchies directory.

USAGE
  $ contrail types uploadOptionSetHierarchies [-l error|warn|info|debug] [-e true|false] [-d <value>]

FLAGS
  -d, --dir=<value>                [default: .] The directory from which to export the option set hierarchies data.
                                   Defaults to the current directory. The option set data will be loaded from
                                   $dir/option-set-hierarchies
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Upload Option Set Hierarchies for your Org. Option set hierarchies are loaded from .yml files in the
  option-set-hierarchies directory.

EXAMPLES
  $ contrail types uploadOptionSetHierarchies

contrail types uploadOptionSets

Upload OptionSets for your Org. OptionSets are loaded from .yml files in the option-sets directory.

USAGE
  $ contrail types uploadOptionSets [-l error|warn|info|debug] [-e true|false] [-d <value>]

FLAGS
  -d, --dir=<value>                [default: .] The directory from which to export the option set data. Defaults to the
                                   current directory. The option set data will be loaded from $dir/option-sets
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Upload OptionSets for your Org. OptionSets are loaded from .yml files in the option-sets directory.

EXAMPLES
  $ contrail types uploadOptionSets

contrail types uploadOptionSetsHierarchyLocalFile FILE NAME

upload CSV file into OptionSetHierarchy

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

ARGUMENTS
  FILE  File to parse
  NAME  The name to be give to the option set hierarchy

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  upload CSV file into OptionSetHierarchy

EXAMPLES
  $ contrail types uploadOptionSetsHierarchyLocalFile <File Path> <name>

contrail types uploadRuleSets

Upload an extracted rule set

USAGE
  $ contrail types uploadRuleSets [-l error|warn|info|debug] [-e true|false] [-d <value>]

FLAGS
  -d, --dir=<value>                [default: .] The directory from which to export the rule set data. Defaults to the
                                   current directory. The rule set data will be loaded from $dir/rule-sets/*.yml
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Upload an extracted rule set

EXAMPLES
  $ contrail types uploadRuleSets

contrail types uploadTypePolicies

Upload type policies

USAGE
  $ contrail types uploadTypePolicies [-l error|warn|info|debug] [-e true|false] [-d <value>]

FLAGS
  -d, --dir=<value>                [default: .] The directory from which to export the type policy data. Defaults to the
                                   current directory. The type policy data will be loaded from $dir/type-policies/*.yml
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Upload type policies

EXAMPLES
  $ contrail types UploadTypePolicies

contrail types uploadTypePropertyPolicies

Upload type property policies

USAGE
  $ contrail types uploadTypePropertyPolicies [-l error|warn|info|debug] [-e true|false] [-d <value>]

FLAGS
  -d, --dir=<value>                [default: .] The directory from which to export the type property policy data.
                                   Defaults to the current directory. The type property policy data will be loaded from
                                   $dir/type-property-policies/*.yml
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Upload type property policies

EXAMPLES
  $ contrail types uploadTypePropertyPolicies

contrail types uploadTypes

Upload Types Org. OptionSets are loaded from .yml files in the types directory.

USAGE
  $ contrail types uploadTypes [-l error|warn|info|debug] [-e true|false] [-d <value>]

FLAGS
  -d, --dir=<value>                [default: .] The directory from which to export the option set data. Defaults to the
                                   current directory. The option set data will be loaded from $dir/types
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Upload Types Org. OptionSets are loaded from .yml files in the types directory.

EXAMPLES
  $ contrail types uploadTypes

contrail types uploadUsageInfo

Upload extracted usage info

USAGE
  $ contrail types uploadUsageInfo [-l error|warn|info|debug] [-e true|false] [-d <value>]

FLAGS
  -d, --dir=<value>                [default: .] The directory from which to export the usage info data. Defaults to the
                                   current directory. The usage info data will be loaded from $dir/usage-info.yml
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Upload extracted usage info

EXAMPLES
  $ contrail types uploadUsageInfo

contrail users export

Export all users in the org.

USAGE
  $ contrail users export [-l error|warn|info|debug] [-e true|false] [-f <value>] [--overwrite]

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -f, --outFile=<value>            [default: users.yml] The location for the file to be saved
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>
  --overwrite                      Replaces existing files if they exist

DESCRIPTION
  Export all users in the org.

EXAMPLES
  $ contrail users export

contrail users import USERSFILE

Import all users in the users.yml file

USAGE
  $ contrail users import USERSFILE [-l error|warn|info|debug] [-e true|false]

ARGUMENTS
  USERSFILE  The .yml file containing the users

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Import all users in the users.yml file

EXAMPLES
  $ contrail users import <USERS_FILE>

contrail webhooks create

Create a new webhook

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

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -j, --json                       output in json format
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Create a new webhook

EXAMPLES
  $ contrail webhooks create

contrail webhooks delete [WEBHOOKID]

Delete an existing webhook. To delete a single webhook, pass its ID. To delete multiple webhooks, do not pass a value for the ID, and select multiple using the interactive selector

USAGE
  $ contrail webhooks delete [WEBHOOKID] [-l error|warn|info|debug] [-e true|false] [-j]

ARGUMENTS
  WEBHOOKID  The id of the webhook to delete

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -j, --json                       output in json format
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Delete an existing webhook. To delete a single webhook, pass its ID. To delete multiple webhooks, do not pass a value
  for the ID, and select multiple using the interactive selector

EXAMPLES
  $ contrail webhooks delete

  $ contrail webhooks delete 12345abcd-1234-abcd-1234-12345abcde

contrail webhooks getWebhookTrigger [WEBHOOKID]

Crafts a webhook trigger that can be used for event workflows. This command does not alter the state of any webhook or event workflow. It is only a utility for generating a webhook trigger.

USAGE
  $ contrail webhooks getWebhookTrigger [WEBHOOKID] [-l error|warn|info|debug] [-e true|false]

ARGUMENTS
  WEBHOOKID  The id of the webhook to delete

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Crafts a webhook trigger that can be used for event workflows. This command does not alter the state of any webhook or
  event workflow. It is only a utility for generating a webhook trigger.

EXAMPLES
  $ contrail webhooks getWebhookTrigger 1234-abcd-1234-abcd-1234abcd

contrail webhooks list

List current webhooks

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

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -j, --json                       output in json format
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  List current webhooks

EXAMPLES
  $ contrail webhooks list

contrail workflow-template-definitions install

Install the template definitions of an app to your org

USAGE
  $ contrail workflow-template-definitions install [-l error|warn|info|debug] [-e true|false]

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Install the template definitions of an app to your org

EXAMPLES
  $ contrail workflow-template-definitions install

contrail workflow-template-definitions list

Lists the workflow templates in the org

USAGE
  $ contrail workflow-template-definitions list [-l error|warn|info|debug] [-e true|false]

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Lists the workflow templates in the org

EXAMPLES
  $ contrail workflow-template-definitions list

contrail workflow-templates delete

Delete workflow templates from your org

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

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Delete workflow templates from your org

EXAMPLES
  $ contrail workflow-templates delete

contrail workflow-templates export

Export all workflows in the org.

USAGE
  $ contrail workflow-templates export [-l error|warn|info|debug] [-e true|false] [-f <value>] [--overwrite]

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -f, --outFile=<value>            [default: workflows.yml] The location for the file to be saved
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>
  --overwrite                      Replaces existing files if they exist

DESCRIPTION
  Export all workflows in the org.

EXAMPLES
  $ contrail workflow-templates export

contrail workflow-templates list

Lists the workflow templates in the org

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

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Lists the workflow templates in the org

EXAMPLES
  $ contrail workflow-templates list

contrail workflow-templates load FILELOCATION

Loads your workflow from a local file

USAGE
  $ contrail workflow-templates load FILELOCATION [-l error|warn|info|debug] [-e true|false]

ARGUMENTS
  FILELOCATION  The workflow template file to load

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Loads your workflow from a local file

EXAMPLES
  $ contrail workflow-templates load <FILE_LOCATION>