Contrail CLI
The Contrail CLI is the best way to manage your instance data through a programmatic interface.
Usage
$ npm install -g @contrail/cli
$ contrail COMMAND
running command...
$ contrail (--version)
@contrail/cli/2.0.10 darwin-arm64 node-v18.13.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
Create an app from a template
USAGE
$ contrail app create
DESCRIPTION
Create an app from a template
EXAMPLES
$ contrail app create
contrail app delete
Delete the app from the app marketplace
USAGE
$ contrail app delete
DESCRIPTION
Delete the app from the app marketplace
EXAMPLES
$ contrail app delete
contrail app getApiKey
Get an api key for an app
USAGE
$ contrail app getApiKey [--appIdentifier <value>]
FLAGS
--appIdentifier=<value> The app identifier
DESCRIPTION
Get an api key for an app
EXAMPLES
$ contrail app getApiKey
contrail app install
Install an app from the marketplace
USAGE
$ contrail app install [-i <value>] [-w] [-h]
FLAGS
-h, --showHidden Show the option to install public but hidden apps
-i, --appIdentifier=<value> The identifier of the app to install
-w, --installWorkflowTemplates Install the app's accompanying workflows
DESCRIPTION
Install an app from the marketplace
EXAMPLES
$ contrail app install --appIdentifier @VibeIQ/Flex-PLM-Connector
contrail app publish
Publish the app
USAGE
$ contrail app publish [-u]
FLAGS
-u, --upgrade In addition to deploying, upgrade the installed version of the app in this org to the latest one.
DESCRIPTION
Publish the app
EXAMPLES
$ contrail app publish
contrail app uninstall
Uninstall an app that is currently installed
USAGE
$ contrail app uninstall [-n <value>]
FLAGS
-n, --appIdentifier=<value> The identifier of the app to install. The identifier can be found on the app's page in
the marketplace.
DESCRIPTION
Uninstall an app that is currently installed
EXAMPLES
$ contrail app uninstall --name @vibeiq/flexplm-connector
contrail app upgrade
Upgrade an installed app
USAGE
$ contrail app upgrade [-i <value>] [-l]
FLAGS
-i, --appIdentifier=<value> The appIdentifier of the app to install
-l, --latest Upgrade to the latest version of the app
DESCRIPTION
Upgrade an installed app
EXAMPLES
$ contrail app upgrade --appIdentifier @VibeIQ/Flex-PLM-Connector --latest
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 colors deleteAll
Say hello
USAGE
$ contrail colors deleteAll
DESCRIPTION
Say hello
EXAMPLES
$ contrail colors deleteAll
contrail colors load
Say hello
USAGE
$ contrail colors load
DESCRIPTION
Say hello
EXAMPLES
$ contrail colors load
contrail config list
List the configurations
USAGE
$ contrail config list
DESCRIPTION
List the configurations
EXAMPLES
$ contrail config list
contrail config remove
Remove a variable from the configuration
USAGE
$ contrail config remove [--orgSlug] [--apiGateway] [--orgId] [--apiUserToken]
FLAGS
--apiGateway The API Gateway
--apiUserToken The API User Token
--orgId The org Id
--orgSlug The org slug
DESCRIPTION
Remove a variable from the configuration
EXAMPLES
$ contrail config remove --orgId
contrail config set
Set a variable in the configuration
USAGE
$ contrail config set [--orgSlug <value>] [--apiGateway <value>] [--orgId <value>] [--apiUserToken <value>]
FLAGS
--apiGateway=<value> The API Gateway
--apiUserToken=<value> The API User Token
--orgId=<value> The org Id
--orgSlug=<value> The org slug
DESCRIPTION
Set a variable in the configuration
EXAMPLES
$ contrail config set --orgId 1234
contrail groups export
Export all groups in the org.
USAGE
$ contrail groups export [-f <value>] [--overwrite]
FLAGS
-f, --outFile=<value> [default: groups.yml] The location for the file to be saved
--overwrite Replaces existing files if they exist
DESCRIPTION
Export all groups in the org.
EXAMPLES
$ contrail groups export
contrail groups upload GROUPSFILE
Import all groups in the groups.yml file
USAGE
$ contrail groups upload GROUPSFILE
ARGUMENTS
GROUPSFILE The .yml file containing the groups
DESCRIPTION
Import all groups in the groups.yml file
EXAMPLES
$ contrail groups import <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 [-d <value>] [-f]
FLAGS
-d, --outDir=<value> [default: .] The directory to which to export the instance data. Defaults to the current
directory
-f, --overwrite Replaces any existing export files in outDir
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 [-d <value>]
FLAGS
-d, --dir=<value> [default: .] The directory from which to export the instance data. Defaults to the current
directory
DESCRIPTION
Import the data to an instance, including types and users
EXAMPLES
$ contrail instance import
contrail loader-process load CONFIGFILENAME
Upload a csv file and kick off a load job for the uploaded file. The config path must be a reference to a .json or a .yml file.
USAGE
$ contrail loader-process load CONFIGFILENAME
ARGUMENTS
CONFIGFILENAME The configuration file location
DESCRIPTION
Upload a csv file and kick off a load job for the uploaded file. The config path must be a reference to a .json or a
.yml file.
EXAMPLES
$ contrail load-processor load
contrail loader-process 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 loader-process upload-and-load INCOMINGFILE CONFIGFILENAME
ARGUMENTS
INCOMINGFILE The incoming file location
CONFIGFILENAME The configuration file location
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 plugins
List installed plugins.
USAGE
$ contrail plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ contrail plugins
See code: @oclif/plugin-plugins
contrail plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ contrail plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Installs a plugin into the CLI.
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ contrail plugins add
EXAMPLES
$ contrail plugins:install myplugin
$ contrail plugins:install https://github.com/someuser/someplugin
$ contrail plugins:install someuser/someplugin
contrail plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ contrail plugins:inspect PLUGIN...
ARGUMENTS
PLUGIN [default: .] Plugin to inspect.
FLAGS
-h, --help Show CLI help.
-v, --verbose
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ contrail plugins:inspect myplugin
contrail plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ contrail plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Installs a plugin into the CLI.
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ contrail plugins add
EXAMPLES
$ contrail plugins:install myplugin
$ contrail plugins:install https://github.com/someuser/someplugin
$ contrail plugins:install someuser/someplugin
contrail plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ contrail plugins:link PLUGIN
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Links a plugin into the CLI for development.
Installation of a linked plugin will override a user-installed or core plugin.
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
command will override the user-installed or core plugin implementation. This is useful for development work.
EXAMPLES
$ contrail plugins:link myplugin
contrail plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ contrail plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ contrail plugins unlink
$ contrail plugins remove
contrail plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ contrail plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ contrail plugins unlink
$ contrail plugins remove
contrail plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ contrail plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ contrail plugins unlink
$ contrail plugins remove
contrail plugins update
Update installed plugins.
USAGE
$ contrail plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
contrail projects export PROJECTNAME
Export a project.
USAGE
$ contrail projects export PROJECTNAME
DESCRIPTION
Export a project.
EXAMPLES
$ contrail project export <PROJECT_NAME>
contrail projects list
Get a list of all projects.
USAGE
$ contrail projects list
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
ARGUMENTS
TEMPLATEFILELOCATION The location to the template file
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
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 [-d <value>] [--overwrite]
FLAGS
-d, --outDir=<value> [default: .] The directory to which to export the type data. Defaults to the current directory
--overwrite Replaces any existing export files in outDir
DESCRIPTION
Get all Types and associated data for your Org
EXAMPLES
$ contrail types getAll
contrail types loadAll
loads all the type data that has been exported by getAll
USAGE
$ contrail types loadAll [-d <value>]
FLAGS
-d, --dir=<value> [default: .] The directory from which to load the types data. Defaults to the current directory.
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
ARGUMENTS
FILE File to merge with the cloud option sets
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
ARGUMENTS
FILE File to parse
TYPEPATHS A list of the type paths to merge
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
ARGUMENTS
FILE File to parse
DESCRIPTION
Parse CSV file into OptionSetHierarchy
EXAMPLES
$ contrail types parseOptionSetsHierarchyLocalFile <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 name and label, use "NameAndLabel". If the file has one column for each option set with the rows being the label value use "LabelsInColumn"
USAGE
$ contrail types parseOptionSetsLocalFiles FILE --csvStyle NameAndLabel|LabelsInColumn
ARGUMENTS
FILE File to parse
FLAGS
--csvStyle=<option> (required)
<options: NameAndLabel|LabelsInColumn>
DESCRIPTION
Parse CSV files into OptionSets. Style denotes the format the csv is in. If the csv file has a column for name and
label, use "NameAndLabel". If the file has one column for each option set with the rows being the label value use
"LabelsInColumn"
EXAMPLES
$ contrail types parseOptionSetsLocalFiles <File Paths> <style>
contrail types parseOptionSetsToFolderStructure FILE
Parse CSV files into OptionSets. Style denotes the format the csv is in. If the csv file has a column for name and label, use "NameAndLabel". If the file has one column for each option set with the rows being the label value use "LabelsInColumn"
USAGE
$ contrail types parseOptionSetsToFolderStructure FILE
ARGUMENTS
FILE File to parse
DESCRIPTION
Parse CSV files into OptionSets. Style denotes the format the csv is in. If the csv file has a column for name and
label, use "NameAndLabel". If the file has one column for each option set with the rows being the label value use
"LabelsInColumn"
EXAMPLES
$ contrail types parseOptionSetsLocalFiles <File Paths> <style>
contrail types parseTypesFromFiles TYPEPATHS
Parse CSV files into Types and OptionSets from VibeIQ Files.
USAGE
$ contrail types parseTypesFromFiles TYPEPATHS
ARGUMENTS
TYPEPATHS A list of the VibeIQ file IDs to parse
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
ARGUMENTS
TYPEPATHS A list of the files to parse
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
ARGUMENTS
TEMPLATEFILE The template file to use
FILEPATHS A list of data file to use
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
ARGUMENTS
TEMPLATEFILE The template file to use
FILEPATH The data file to use
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 [-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
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 [-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
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
ARGUMENTS
FILE File to parse
NAME The name to be give to the option set hierarchy
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 [-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
DESCRIPTION
Upload an extracted rule set
EXAMPLES
$ contrail types uploadRuleSets
contrail types uploadTypePropertyPolicies
Upload type property policies
USAGE
$ contrail types uploadTypePropertyPolicies [-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
DESCRIPTION
Upload type property policies
EXAMPLES
$ contrail types uploadTypePropertyPolicies
contrail types uploadUsageInfo
Upload extracted usage info
USAGE
$ contrail types uploadUsageInfo [-d <value>]
FLAGS
-d, --dir=<value> [default: .] The directory from which to export the usage info data. Defaults to the current
directory. The option set data will be loaded from $dir/usage-info.yml
DESCRIPTION
Upload extracted usage info
EXAMPLES
$ contrail types uploadUsageInfo
contrail users export
Export all users in the org.
USAGE
$ contrail users export [-f <value>] [--overwrite]
FLAGS
-f, --outFile=<value> [default: users.yml] The location for the file to be saved
--overwrite Replaces existing files if they exist
DESCRIPTION
Export all users in the org.
EXAMPLES
$ contrail users export
contrail users upload USERSFILE
Import all users in the users.yml file
USAGE
$ contrail users upload USERSFILE
ARGUMENTS
USERSFILE The .yml file containing the users
DESCRIPTION
Import all users in the users.yml file
EXAMPLES
$ contrail users import <USERS_FILE>
contrail workflow-template-definitions install
Install the template definitions of an app to your org
USAGE
$ contrail workflow-template-definitions install
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
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
DESCRIPTION
Delete workflow templates from your org
EXAMPLES
$ contrail workflow-template delete
contrail workflow-templates list
Lists the workflow templates in the org
USAGE
$ contrail workflow-templates list
DESCRIPTION
Lists the workflow templates in the org
EXAMPLES
$ contrail workflow-template list
contrail workflow-templates load FILELOCATION
Loads your workflow from a local file
USAGE
$ contrail workflow-templates load FILELOCATION
ARGUMENTS
FILELOCATION The workflow template file to load
DESCRIPTION
Loads your workflow from a local file
EXAMPLES
$ contrail workflow-template load <FILE_LOCATION>