@contrail/cli

Contrail CLI

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

• Usage
• Commands

Usage

$ npm install -g @contrail/cli
$ contrail-cli COMMAND
running command...
$ contrail-cli (--version)
@contrail/cli/2.0.2 darwin-arm64 node-v18.13.0
$ contrail-cli --help [COMMAND]
USAGE
  $ contrail-cli COMMAND
...

Commands

• contrail-cli app create
• contrail-cli app delete
• contrail-cli app getApiKey
• contrail-cli app install
• contrail-cli app publish
• contrail-cli app uninstall
• contrail-cli app upgrade
• contrail-cli colors deleteAll
• contrail-cli colors load
• contrail-cli config list
• contrail-cli config remove
• contrail-cli config set
• contrail-cli help [COMMANDS]
• contrail-cli loader-process load CONFIGFILENAME
• contrail-cli loader-process upload-and-load INCOMINGFILE CONFIGFILENAME
• contrail-cli plugins
• contrail-cli plugins:install PLUGIN...
• contrail-cli plugins:inspect PLUGIN...
• contrail-cli plugins:install PLUGIN...
• contrail-cli plugins:link PLUGIN
• contrail-cli plugins:uninstall PLUGIN...
• contrail-cli plugins:uninstall PLUGIN...
• contrail-cli plugins:uninstall PLUGIN...
• contrail-cli plugins update
• contrail-cli projects export PROJECTNAME
• contrail-cli projects list
• contrail-cli projects load TEMPLATEFILELOCATION
• contrail-cli types exportOptionSetHierarchies
• contrail-cli types getAll
• contrail-cli types loadAll
• contrail-cli types mergeOptionSets FILE
• contrail-cli types mergeTypeProperties FILE TYPEPATHS
• contrail-cli types parseOptionSetsHierarchyLocalFile FILE
• contrail-cli types parseOptionSetsLocalFiles FILE
• contrail-cli types parseOptionSetsToFolderStructure FILE
• contrail-cli types parseTypesFromFiles TYPEPATHS
• contrail-cli types parseTypesFromLocalFiles TYPEPATHS
• contrail-cli types parseTypesFromTemplateAndDataFromLocalFiles TEMPLATEFILE FILEPATHS
• contrail-cli types parseTypesFromTemplateFromLocalFiles TEMPLATEFILE FILEPATH
• contrail-cli types uploadOptionSetHierarchies
• contrail-cli types uploadOptionSets
• contrail-cli types uploadOptionSetsHierarchyLocalFile FILE NAME
• contrail-cli types uploadRuleSets
• contrail-cli types uploadTypePropertyPolicies
• contrail-cli types uploadUsageInfo
• contrail-cli users export
• contrail-cli users upload USERSFILE
• contrail-cli workflow-template-definitions install
• contrail-cli workflow-template-definitions list
• contrail-cli workflow-templates delete
• contrail-cli workflow-templates list
• contrail-cli workflow-templates load FILELOCATION

contrail-cli app create

Create an app from a template

USAGE
  $ contrail-cli app create

DESCRIPTION
  Create an app from a template

EXAMPLES
  $ contrail app create

contrail-cli app delete

Delete the app from the app marketplace

USAGE
  $ contrail-cli app delete

DESCRIPTION
  Delete the app from the app marketplace

EXAMPLES
  $ contrail app delete

contrail-cli app getApiKey

Get an api key for an app

USAGE
  $ contrail-cli app getApiKey [--appIdentifier <value>]

FLAGS
  --appIdentifier=<value>  The app identifier

DESCRIPTION
  Get an api key for an app

EXAMPLES
  $ contrail app getApiKey

contrail-cli app install

Install an app from the marketplace

USAGE
  $ contrail-cli app install [-i <value>] [-w]

FLAGS
  -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-cli app publish

Publish the app

USAGE
  $ contrail-cli 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-cli app uninstall

Uninstall an app that is currently installed

USAGE
  $ contrail-cli 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-cli app upgrade

Upgrade an installed app

USAGE
  $ contrail-cli 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-cli colors deleteAll

Say hello

USAGE
  $ contrail-cli colors deleteAll

DESCRIPTION
  Say hello

EXAMPLES
  $ contrail colors deleteAll

contrail-cli colors load

Say hello

USAGE
  $ contrail-cli colors load

DESCRIPTION
  Say hello

EXAMPLES
  $ contrail colors load

contrail-cli config list

List the configurations

USAGE
  $ contrail-cli config list

DESCRIPTION
  List the configurations

EXAMPLES
  $ contrail config list

contrail-cli config remove

Remove a variable from the configuration

USAGE
  $ contrail-cli 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-cli config set

Set a variable in the configuration

USAGE
  $ contrail-cli 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-cli help [COMMANDS]

Display help for contrail-cli.

USAGE
  $ contrail-cli 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-cli.

See code: @oclif/plugin-help

contrail-cli 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-cli 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-cli 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-cli 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-cli plugins

List installed plugins.

USAGE
  $ contrail-cli plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ contrail-cli plugins

See code: @oclif/plugin-plugins

contrail-cli plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ contrail-cli 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-cli plugins add

EXAMPLES
  $ contrail-cli plugins:install myplugin 

  $ contrail-cli plugins:install https://github.com/someuser/someplugin

  $ contrail-cli plugins:install someuser/someplugin

contrail-cli plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ contrail-cli 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-cli plugins:inspect myplugin

contrail-cli plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ contrail-cli 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-cli plugins add

EXAMPLES
  $ contrail-cli plugins:install myplugin 

  $ contrail-cli plugins:install https://github.com/someuser/someplugin

  $ contrail-cli plugins:install someuser/someplugin

contrail-cli plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ contrail-cli 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-cli plugins:link myplugin

contrail-cli plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ contrail-cli 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-cli plugins unlink
  $ contrail-cli plugins remove

contrail-cli plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ contrail-cli 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-cli plugins unlink
  $ contrail-cli plugins remove

contrail-cli plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ contrail-cli 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-cli plugins unlink
  $ contrail-cli plugins remove

contrail-cli plugins update

Update installed plugins.

USAGE
  $ contrail-cli plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

contrail-cli projects export PROJECTNAME

Export a project.

USAGE
  $ contrail-cli projects export PROJECTNAME

DESCRIPTION
  Export a project.

EXAMPLES
  $ contrail project export <PROJECT_NAME>

contrail-cli projects list

Get a list of all projects.

USAGE
  $ contrail-cli projects list

DESCRIPTION
  Get a list of all projects.

EXAMPLES
  $ contrail project list

contrail-cli projects load TEMPLATEFILELOCATION

Configure a project from a yml file.

USAGE
  $ contrail-cli 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-cli types exportOptionSetHierarchies

export OptionSetHierarchies into CSVs.

USAGE
  $ contrail-cli types exportOptionSetHierarchies

DESCRIPTION
  export OptionSetHierarchies into CSVs.

EXAMPLES
  $ contrail types exportOptionSetsHierarchies

contrail-cli types getAll

Get all Types and associated data for your Org

USAGE
  $ contrail-cli types getAll

DESCRIPTION
  Get all Types and associated data for your Org

EXAMPLES
  $ contrail types getAll

contrail-cli types loadAll

Get all Types and associated data for your Org

USAGE
  $ contrail-cli types loadAll

DESCRIPTION
  Get all Types and associated data for your Org

EXAMPLES
  $ contrail types getAll

contrail-cli types mergeOptionSets FILE

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

USAGE
  $ contrail-cli 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-cli 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-cli 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-cli types parseOptionSetsHierarchyLocalFile FILE

Parse CSV file into OptionSetHierarchy

USAGE
  $ contrail-cli types parseOptionSetsHierarchyLocalFile FILE

ARGUMENTS
  FILE  File to parse

DESCRIPTION
  Parse CSV file into OptionSetHierarchy

EXAMPLES
  $ contrail types parseOptionSetsHierarchyLocalFile <File Paths>

contrail-cli 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-cli 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-cli 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-cli 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-cli types parseTypesFromFiles TYPEPATHS

Parse CSV files into Types and OptionSets from VibeIQ Files.

USAGE
  $ contrail-cli 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-cli types parseTypesFromLocalFiles TYPEPATHS

Parse CSV files into Types and OptionSets from local files.

USAGE
  $ contrail-cli 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-cli types parseTypesFromTemplateAndDataFromLocalFiles TEMPLATEFILE FILEPATHS

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

USAGE
  $ contrail-cli 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-cli types parseTypesFromTemplateFromLocalFiles TEMPLATEFILE FILEPATH

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

USAGE
  $ contrail-cli 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-cli types uploadOptionSetHierarchies

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

USAGE
  $ contrail-cli types uploadOptionSetHierarchies

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

EXAMPLES
  $ contrail types uploadOptionSetHierarchies

contrail-cli types uploadOptionSets

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

USAGE
  $ contrail-cli types uploadOptionSets

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

EXAMPLES
  $ contrail types uploadOptionSets

contrail-cli types uploadOptionSetsHierarchyLocalFile FILE NAME

upload CSV file into OptionSetHierarchy

USAGE
  $ contrail-cli 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-cli types uploadRuleSets

Upload an extracted rule set

USAGE
  $ contrail-cli types uploadRuleSets

DESCRIPTION
  Upload an extracted rule set

EXAMPLES
  $ contrail types uploadRuleSets

contrail-cli types uploadTypePropertyPolicies

Upload type property policies

USAGE
  $ contrail-cli types uploadTypePropertyPolicies

DESCRIPTION
  Upload type property policies

EXAMPLES
  $ contrail types uploadTypePropertyPolicies

contrail-cli types uploadUsageInfo

Upload extracted usage info

USAGE
  $ contrail-cli types uploadUsageInfo

DESCRIPTION
  Upload extracted usage info

EXAMPLES
  $ contrail types uploadUsageInfo

contrail-cli users export

Export all users in the org.

USAGE
  $ contrail-cli users export [-f <value>]

FLAGS
  -f, --fileOut=<value>  The location for the file to be saved

DESCRIPTION
  Export all users in the org.

EXAMPLES
  $ contrail users export

contrail-cli users upload USERSFILE

Import all users in the users.yml file

USAGE
  $ contrail-cli 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-cli workflow-template-definitions install

Install the template definitions of an app to your org

USAGE
  $ contrail-cli workflow-template-definitions install

DESCRIPTION
  Install the template definitions of an app to your org

EXAMPLES
  $ contrail workflow-template-definitions install

contrail-cli workflow-template-definitions list

Lists the workflow templates in the org

USAGE
  $ contrail-cli workflow-template-definitions list

DESCRIPTION
  Lists the workflow templates in the org

EXAMPLES
  $ contrail workflow-template-definitions list

contrail-cli workflow-templates delete

Delete workflow templates from your org

USAGE
  $ contrail-cli workflow-templates delete

DESCRIPTION
  Delete workflow templates from your org

EXAMPLES
  $ contrail workflow-template delete

contrail-cli workflow-templates list

Lists the workflow templates in the org

USAGE
  $ contrail-cli workflow-templates list

DESCRIPTION
  Lists the workflow templates in the org

EXAMPLES
  $ contrail workflow-template list

contrail-cli workflow-templates load FILELOCATION

Loads your workflow from a local file

USAGE
  $ contrail-cli 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>