@contrail/cli 1.0.71 → 2.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +1034 -5
- package/bin/dev +17 -0
- package/bin/dev.cmd +3 -0
- package/bin/run +5 -0
- package/bin/run.cmd +3 -0
- package/{lib → dist}/api/apps.d.ts +13 -13
- package/dist/api/apps.js +96 -0
- package/{lib → dist}/api/event-workflow-action-definition.d.ts +1 -1
- package/dist/api/event-workflow-action-definition.js +11 -0
- package/{lib → dist}/api/event-workflow-template-definition.d.ts +6 -6
- package/dist/api/event-workflow-template-definition.js +26 -0
- package/{lib → dist}/api/event-workflow-templates.d.ts +7 -7
- package/dist/api/event-workflow-templates.js +32 -0
- package/dist/api/types.d.ts +7 -0
- package/dist/api/types.js +52 -0
- package/{lib → dist}/auth/auth.d.ts +9 -9
- package/dist/auth/auth.js +6 -0
- package/{lib → dist}/auth/login.d.ts +2 -2
- package/{lib → dist}/auth/login.js +146 -141
- package/dist/commands/app/create.d.ts +6 -0
- package/dist/commands/app/create.js +15 -0
- package/dist/commands/app/delete.d.ts +7 -0
- package/dist/commands/app/delete.js +38 -0
- package/dist/commands/app/install.d.ts +11 -0
- package/dist/commands/app/install.js +117 -0
- package/dist/commands/app/publish.d.ts +7 -0
- package/dist/commands/app/publish.js +45 -0
- package/dist/commands/app/uninstall.d.ts +10 -0
- package/dist/commands/app/uninstall.js +58 -0
- package/dist/commands/app/upgrade.d.ts +11 -0
- package/dist/commands/app/upgrade.js +79 -0
- package/dist/commands/colors/deleteAll.d.ts +6 -0
- package/dist/commands/colors/deleteAll.js +30 -0
- package/dist/commands/colors/load.d.ts +6 -0
- package/dist/commands/colors/load.js +29 -0
- package/dist/commands/config/list.d.ts +6 -0
- package/dist/commands/config/list.js +15 -0
- package/dist/commands/config/remove.d.ts +14 -0
- package/dist/commands/config/remove.js +26 -0
- package/dist/commands/config/set.d.ts +13 -0
- package/dist/commands/config/set.js +29 -0
- package/dist/commands/loader-process/load.d.ts +9 -0
- package/dist/commands/loader-process/load.js +33 -0
- package/dist/commands/loader-process/upload-and-load.d.ts +10 -0
- package/dist/commands/loader-process/upload-and-load.js +35 -0
- package/dist/commands/projects/export.d.ts +10 -0
- package/dist/commands/projects/export.js +34 -0
- package/dist/commands/projects/list.d.ts +6 -0
- package/dist/commands/projects/list.js +34 -0
- package/dist/commands/projects/load.d.ts +9 -0
- package/{lib/projects/project-uploader.js → dist/commands/projects/load.js} +106 -105
- package/dist/commands/types/exportOptionSetHierarchies.d.ts +7 -0
- package/{lib/types/option-set-hierarchy-exporter.js → dist/commands/types/exportOptionSetHierarchies.js} +130 -113
- package/{lib/types/types-extractor.d.ts → dist/commands/types/getAll.d.ts} +29 -27
- package/{lib/types/types-extractor.js → dist/commands/types/getAll.js} +267 -318
- package/dist/commands/types/loadAll.d.ts +7 -0
- package/dist/commands/types/loadAll.js +41 -0
- package/dist/commands/types/mergeOptionSets.d.ts +9 -0
- package/{lib/types/option-set-merger.js → dist/commands/types/mergeOptionSets.js} +114 -105
- package/dist/commands/types/mergeTypeProperties.d.ts +11 -0
- package/dist/commands/types/mergeTypeProperties.js +89 -0
- package/dist/commands/types/parseOptionSetsHierarchyLocalFile.d.ts +10 -0
- package/dist/commands/types/parseOptionSetsHierarchyLocalFile.js +112 -0
- package/dist/commands/types/parseOptionSetsLocalFiles.d.ts +14 -0
- package/dist/commands/types/parseOptionSetsLocalFiles.js +153 -0
- package/dist/commands/types/parseOptionSetsToFolderStructure.d.ts +10 -0
- package/dist/commands/types/parseOptionSetsToFolderStructure.js +104 -0
- package/dist/commands/types/parseTypesFromFiles.d.ts +10 -0
- package/dist/commands/types/parseTypesFromFiles.js +34 -0
- package/dist/commands/types/parseTypesFromLocalFiles.d.ts +10 -0
- package/dist/commands/types/parseTypesFromLocalFiles.js +34 -0
- package/dist/commands/types/parseTypesFromTemplateAndDataFromLocalFiles.d.ts +11 -0
- package/dist/commands/types/parseTypesFromTemplateAndDataFromLocalFiles.js +36 -0
- package/dist/commands/types/parseTypesFromTemplateFromLocalFiles.d.ts +10 -0
- package/dist/commands/types/parseTypesFromTemplateFromLocalFiles.js +35 -0
- package/dist/commands/types/uploadOptionSetHierarchies.d.ts +7 -0
- package/{lib/types/option-set-hierarchy-uploader.js → dist/commands/types/uploadOptionSetHierarchies.js} +130 -113
- package/dist/commands/types/uploadOptionSets.d.ts +7 -0
- package/{lib/types/option-set-uploader.js → dist/commands/types/uploadOptionSets.js} +115 -98
- package/dist/commands/types/uploadOptionSetsHierarchyLocalFile.d.ts +11 -0
- package/{lib/types/option-set-hierarchy-parser.js → dist/commands/types/uploadOptionSetsHierarchyLocalFile.js} +128 -140
- package/dist/commands/types/uploadRuleSets.d.ts +7 -0
- package/{lib/types/rule-set-uploader.js → dist/commands/types/uploadRuleSets.js} +189 -172
- package/dist/commands/types/uploadTypePropertyPolicies.d.ts +7 -0
- package/{lib/types/type-property-policy-uploader.js → dist/commands/types/uploadTypePropertyPolicies.js} +195 -178
- package/dist/commands/types/uploadUsageInfo.d.ts +7 -0
- package/{lib/types/usage-info-uploader.js → dist/commands/types/uploadUsageInfo.js} +149 -132
- package/dist/commands/users/export.d.ts +9 -0
- package/dist/commands/users/export.js +60 -0
- package/dist/commands/users/upload.d.ts +9 -0
- package/dist/commands/users/upload.js +65 -0
- package/dist/commands/workflow-template-definitions/install.d.ts +6 -0
- package/dist/commands/workflow-template-definitions/install.js +17 -0
- package/dist/commands/workflow-template-definitions/list.d.ts +6 -0
- package/dist/commands/workflow-template-definitions/list.js +17 -0
- package/dist/commands/workflow-templates/delete.d.ts +6 -0
- package/dist/commands/workflow-templates/delete.js +17 -0
- package/dist/commands/workflow-templates/list.d.ts +6 -0
- package/dist/commands/workflow-templates/list.js +17 -0
- package/dist/commands/workflow-templates/load.d.ts +9 -0
- package/dist/commands/workflow-templates/load.js +21 -0
- package/{lib → dist}/common.d.ts +1 -1
- package/dist/common.js +9 -0
- package/{lib/apps/deploy-app → dist/helpers/app}/actions-deployer.d.ts +11 -11
- package/{lib/apps/deploy-app → dist/helpers/app}/actions-deployer.js +122 -114
- package/{lib/apps/deploy-app → dist/helpers/app}/app-deployer.d.ts +8 -8
- package/{lib/apps/deploy-app → dist/helpers/app}/app-deployer.js +98 -93
- package/{lib/apps/deploy-app → dist/helpers/app}/app-template-parsers.d.ts +7 -7
- package/{lib/apps/deploy-app → dist/helpers/app}/app-template-parsers.js +43 -38
- package/dist/helpers/app/load-app-config.d.ts +1 -0
- package/dist/helpers/app/load-app-config.js +18 -0
- package/dist/helpers/app/setup-template.d.ts +1 -0
- package/dist/helpers/app/setup-template.js +38 -0
- package/dist/helpers/colors/helpers.d.ts +4 -0
- package/dist/helpers/colors/helpers.js +74 -0
- package/{lib → dist/helpers}/config/config.d.ts +6 -6
- package/dist/helpers/config/config.js +76 -0
- package/dist/helpers/loader-process/helpers.d.ts +2 -0
- package/{lib/loader-process/loader-process.js → dist/helpers/loader-process/helpers.js} +98 -120
- package/dist/helpers/projects/helpers.d.ts +2 -0
- package/{lib/projects/project-exporter.js → dist/helpers/projects/helpers.js} +165 -187
- package/{lib → dist/helpers}/types/csv-parser.d.ts +1 -1
- package/{lib → dist/helpers}/types/csv-parser.js +56 -51
- package/dist/helpers/types/type-extractor.d.ts +1 -0
- package/dist/helpers/types/type-extractor.js +32 -0
- package/dist/helpers/types/type-parser.d.ts +4 -0
- package/dist/helpers/types/type-parser.js +118 -0
- package/{lib/types/types-uploader.d.ts → dist/helpers/types/type-uploader.d.ts} +1 -1
- package/{lib/types/types-uploader.js → dist/helpers/types/type-uploader.js} +244 -239
- package/{lib → dist/helpers}/workflow-template-definitions/workflow-template-definition-deployer.d.ts +12 -12
- package/{lib → dist/helpers}/workflow-template-definitions/workflow-template-definition-deployer.js +156 -151
- package/{lib/workflow-templates/local-workflow-template-deployer.d.ts → dist/helpers/workflow-templates/helper.d.ts} +17 -11
- package/dist/helpers/workflow-templates/helper.js +166 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +5 -0
- package/{lib → dist}/interfaces.d.ts +323 -191
- package/dist/interfaces.js +63 -0
- package/{templates → dist/templates}/typescript/Dockerfile +15 -15
- package/{templates → dist/templates}/typescript/README.md +10 -10
- package/{templates → dist/templates}/typescript/app.yml +49 -49
- package/{templates → dist/templates}/typescript/docker_deploy.bat +1 -1
- package/{templates → dist/templates}/typescript/package.json +54 -54
- package/{templates → dist/templates}/typescript/src/actions/logItem.ts +25 -25
- package/{templates → dist/templates}/typescript/src/framework/action-dispatcher.ts +89 -89
- package/{templates → dist/templates}/typescript/src/framework/app-config.ts +26 -26
- package/{templates → dist/templates}/typescript/src/framework/handler.ts +11 -11
- package/{templates → dist/templates}/typescript/src/framework/index.ts +2 -2
- package/{templates → dist/templates}/typescript/src/framework/interfaces.ts +32 -32
- package/{templates → dist/templates}/typescript/src/framework/logger.ts +21 -21
- package/{templates → dist/templates}/typescript/src/framework/mock-server.ts +31 -31
- package/{templates → dist/templates}/typescript/tsconfig.json +28 -28
- package/oclif.manifest.json +821 -0
- package/package.json +116 -72
- package/.eslintrc.js +0 -53
- package/.vscode/settings.json +0 -6
- package/bin/init +0 -4
- package/lib/api/apps.js +0 -85
- package/lib/api/event-workflow-action-definition.js +0 -7
- package/lib/api/event-workflow-template-definition.js +0 -20
- package/lib/api/event-workflow-templates.js +0 -25
- package/lib/apps/create-app/create.d.ts +0 -1
- package/lib/apps/create-app/create.js +0 -60
- package/lib/apps/create-app/setup-template.d.ts +0 -1
- package/lib/apps/create-app/setup-template.js +0 -34
- package/lib/apps/deploy-app/deploy.d.ts +0 -2
- package/lib/apps/deploy-app/deploy.js +0 -58
- package/lib/apps/install-app/app-installer.d.ts +0 -2
- package/lib/apps/install-app/app-installer.js +0 -120
- package/lib/apps/upgrade-app/app-upgrader.d.ts +0 -3
- package/lib/apps/upgrade-app/app-upgrader.js +0 -126
- package/lib/auth/auth.js +0 -2
- package/lib/cli.d.ts +0 -5
- package/lib/cli.js +0 -524
- package/lib/colors/color-loader.d.ts +0 -2
- package/lib/colors/color-loader.js +0 -96
- package/lib/common.js +0 -5
- package/lib/config/config.js +0 -70
- package/lib/config/configCommands.d.ts +0 -3
- package/lib/config/configCommands.js +0 -34
- package/lib/interfaces.js +0 -25
- package/lib/loader-process/loader-process.d.ts +0 -2
- package/lib/projects/interfaces.d.ts +0 -77
- package/lib/projects/interfaces.js +0 -23
- package/lib/projects/project-exporter.d.ts +0 -2
- package/lib/projects/project-uploader.d.ts +0 -1
- package/lib/types/allUploader.d.ts +0 -1
- package/lib/types/allUploader.js +0 -24
- package/lib/types/interfaces.d.ts +0 -55
- package/lib/types/interfaces.js +0 -1
- package/lib/types/option-set-hierarchy-exporter.d.ts +0 -1
- package/lib/types/option-set-hierarchy-parser.d.ts +0 -2
- package/lib/types/option-set-hierarchy-uploader.d.ts +0 -1
- package/lib/types/option-set-merger.d.ts +0 -1
- package/lib/types/option-set-parser.d.ts +0 -3
- package/lib/types/option-set-parser.js +0 -140
- package/lib/types/option-set-uploader.d.ts +0 -1
- package/lib/types/parse-types.d.ts +0 -4
- package/lib/types/parse-types.js +0 -189
- package/lib/types/rule-set-uploader.d.ts +0 -1
- package/lib/types/type-property-policy-uploader.d.ts +0 -1
- package/lib/types/types-properties-merger.d.ts +0 -1
- package/lib/types/types-properties-merger.js +0 -75
- package/lib/types/usage-info-uploader.d.ts +0 -1
- package/lib/users/user-exporter.d.ts +0 -1
- package/lib/users/user-exporter.js +0 -41
- package/lib/users/user-uploader.d.ts +0 -1
- package/lib/users/user-uploader.js +0 -45
- package/lib/workflow-template-definitions/workflow-template-definition-commands.d.ts +0 -2
- package/lib/workflow-template-definitions/workflow-template-definition-commands.js +0 -10
- package/lib/workflow-templates/local-workflow-template-deployer.js +0 -102
- package/lib/workflow-templates/workflow-template-commands.d.ts +0 -4
- package/lib/workflow-templates/workflow-template-commands.js +0 -51
- package/lib/workflow-templates/workflow-template-deployer.d.ts +0 -4
- package/lib/workflow-templates/workflow-template-deployer.js +0 -26
- package/publish.bat +0 -5
- package/publish.sh +0 -5
- package/src/api/apps.ts +0 -97
- package/src/api/event-workflow-action-definition.ts +0 -8
- package/src/api/event-workflow-template-definition.ts +0 -23
- package/src/api/event-workflow-templates.ts +0 -29
- package/src/apps/create-app/create.ts +0 -74
- package/src/apps/create-app/setup-template.ts +0 -38
- package/src/apps/deploy-app/actions-deployer.ts +0 -140
- package/src/apps/deploy-app/app-deployer.ts +0 -105
- package/src/apps/deploy-app/app-template-parsers.ts +0 -44
- package/src/apps/deploy-app/deploy.ts +0 -66
- package/src/apps/install-app/app-installer.ts +0 -126
- package/src/apps/upgrade-app/app-upgrader.ts +0 -132
- package/src/auth/auth.ts +0 -10
- package/src/auth/login.ts +0 -155
- package/src/cli.ts +0 -540
- package/src/colors/color-loader.ts +0 -112
- package/src/colors/colors.csv +0 -866
- package/src/common.ts +0 -5
- package/src/config/config.ts +0 -74
- package/src/config/configCommands.ts +0 -38
- package/src/interfaces.ts +0 -200
- package/src/loader-process/loader-process.ts +0 -152
- package/src/projects/interfaces.ts +0 -73
- package/src/projects/project-exporter.ts +0 -225
- package/src/projects/project-uploader.ts +0 -131
- package/src/types/allUploader.ts +0 -28
- package/src/types/csv-parser.ts +0 -59
- package/src/types/interfaces.ts +0 -58
- package/src/types/option-set-hierarchy-exporter.ts +0 -125
- package/src/types/option-set-hierarchy-parser.ts +0 -169
- package/src/types/option-set-hierarchy-uploader.ts +0 -122
- package/src/types/option-set-merger.ts +0 -124
- package/src/types/option-set-parser.ts +0 -166
- package/src/types/option-set-uploader.ts +0 -108
- package/src/types/parse-types.ts +0 -227
- package/src/types/rule-set-uploader.ts +0 -187
- package/src/types/type-property-policy-uploader.ts +0 -192
- package/src/types/types-extractor.ts +0 -369
- package/src/types/types-properties-merger.ts +0 -90
- package/src/types/types-uploader.ts +0 -271
- package/src/types/usage-info-uploader.ts +0 -139
- package/src/users/user-exporter.ts +0 -52
- package/src/users/user-uploader.ts +0 -58
- package/src/workflow-template-definitions/workflow-template-definition-commands.ts +0 -13
- package/src/workflow-template-definitions/workflow-template-definition-deployer.ts +0 -184
- package/src/workflow-templates/local-workflow-template-deployer.ts +0 -126
- package/src/workflow-templates/workflow-template-commands.ts +0 -59
- package/src/workflow-templates/workflow-template-deployer.ts +0 -30
- package/templates/javascript/actions/example/action.js +0 -38
- package/templates/javascript/app.yml +0 -53
- package/templates/javascript/package.json +0 -23
- package/templates/typescript/package-lock.json +0 -14
- package/tsconfig.json +0 -32
package/README.md
CHANGED
|
@@ -1,5 +1,1034 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
1
|
+
Contrail CLI
|
|
2
|
+
=================
|
|
3
|
+
|
|
4
|
+
The Contrail CLI is the best way to manage your instance data through a programmatic interface.
|
|
5
|
+
|
|
6
|
+
<!-- toc -->
|
|
7
|
+
* [Usage](#usage)
|
|
8
|
+
* [Commands](#commands)
|
|
9
|
+
<!-- tocstop -->
|
|
10
|
+
# Usage
|
|
11
|
+
<!-- usage -->
|
|
12
|
+
```sh-session
|
|
13
|
+
$ npm install -g @contrail/cli
|
|
14
|
+
$ contrail-cli COMMAND
|
|
15
|
+
running command...
|
|
16
|
+
$ contrail-cli (--version)
|
|
17
|
+
@contrail/cli/2.0.1 darwin-arm64 node-v18.13.0
|
|
18
|
+
$ contrail-cli --help [COMMAND]
|
|
19
|
+
USAGE
|
|
20
|
+
$ contrail-cli COMMAND
|
|
21
|
+
...
|
|
22
|
+
```
|
|
23
|
+
<!-- usagestop -->
|
|
24
|
+
# Commands
|
|
25
|
+
<!-- commands -->
|
|
26
|
+
* [`contrail-cli app create`](#contrail-cli-app-create)
|
|
27
|
+
* [`contrail-cli app delete`](#contrail-cli-app-delete)
|
|
28
|
+
* [`contrail-cli app install`](#contrail-cli-app-install)
|
|
29
|
+
* [`contrail-cli app publish`](#contrail-cli-app-publish)
|
|
30
|
+
* [`contrail-cli app uninstall`](#contrail-cli-app-uninstall)
|
|
31
|
+
* [`contrail-cli app upgrade`](#contrail-cli-app-upgrade)
|
|
32
|
+
* [`contrail-cli colors deleteAll`](#contrail-cli-colors-deleteall)
|
|
33
|
+
* [`contrail-cli colors load`](#contrail-cli-colors-load)
|
|
34
|
+
* [`contrail-cli config list`](#contrail-cli-config-list)
|
|
35
|
+
* [`contrail-cli config remove`](#contrail-cli-config-remove)
|
|
36
|
+
* [`contrail-cli config set`](#contrail-cli-config-set)
|
|
37
|
+
* [`contrail-cli help [COMMANDS]`](#contrail-cli-help-commands)
|
|
38
|
+
* [`contrail-cli loader-process load CONFIGFILENAME`](#contrail-cli-loader-process-load-configfilename)
|
|
39
|
+
* [`contrail-cli loader-process upload-and-load INCOMINGFILE CONFIGFILENAME`](#contrail-cli-loader-process-upload-and-load-incomingfile-configfilename)
|
|
40
|
+
* [`contrail-cli plugins`](#contrail-cli-plugins)
|
|
41
|
+
* [`contrail-cli plugins:install PLUGIN...`](#contrail-cli-pluginsinstall-plugin)
|
|
42
|
+
* [`contrail-cli plugins:inspect PLUGIN...`](#contrail-cli-pluginsinspect-plugin)
|
|
43
|
+
* [`contrail-cli plugins:install PLUGIN...`](#contrail-cli-pluginsinstall-plugin-1)
|
|
44
|
+
* [`contrail-cli plugins:link PLUGIN`](#contrail-cli-pluginslink-plugin)
|
|
45
|
+
* [`contrail-cli plugins:uninstall PLUGIN...`](#contrail-cli-pluginsuninstall-plugin)
|
|
46
|
+
* [`contrail-cli plugins:uninstall PLUGIN...`](#contrail-cli-pluginsuninstall-plugin-1)
|
|
47
|
+
* [`contrail-cli plugins:uninstall PLUGIN...`](#contrail-cli-pluginsuninstall-plugin-2)
|
|
48
|
+
* [`contrail-cli plugins update`](#contrail-cli-plugins-update)
|
|
49
|
+
* [`contrail-cli projects export PROJECTNAME`](#contrail-cli-projects-export-projectname)
|
|
50
|
+
* [`contrail-cli projects list`](#contrail-cli-projects-list)
|
|
51
|
+
* [`contrail-cli projects load TEMPLATEFILELOCATION`](#contrail-cli-projects-load-templatefilelocation)
|
|
52
|
+
* [`contrail-cli types exportOptionSetHierarchies`](#contrail-cli-types-exportoptionsethierarchies)
|
|
53
|
+
* [`contrail-cli types getAll`](#contrail-cli-types-getall)
|
|
54
|
+
* [`contrail-cli types loadAll`](#contrail-cli-types-loadall)
|
|
55
|
+
* [`contrail-cli types mergeOptionSets FILE`](#contrail-cli-types-mergeoptionsets-file)
|
|
56
|
+
* [`contrail-cli types mergeTypeProperties FILE TYPEPATHS`](#contrail-cli-types-mergetypeproperties-file-typepaths)
|
|
57
|
+
* [`contrail-cli types parseOptionSetsHierarchyLocalFile FILE`](#contrail-cli-types-parseoptionsetshierarchylocalfile-file)
|
|
58
|
+
* [`contrail-cli types parseOptionSetsLocalFiles FILE`](#contrail-cli-types-parseoptionsetslocalfiles-file)
|
|
59
|
+
* [`contrail-cli types parseOptionSetsToFolderStructure FILE`](#contrail-cli-types-parseoptionsetstofolderstructure-file)
|
|
60
|
+
* [`contrail-cli types parseTypesFromFiles TYPEPATHS`](#contrail-cli-types-parsetypesfromfiles-typepaths)
|
|
61
|
+
* [`contrail-cli types parseTypesFromLocalFiles TYPEPATHS`](#contrail-cli-types-parsetypesfromlocalfiles-typepaths)
|
|
62
|
+
* [`contrail-cli types parseTypesFromTemplateAndDataFromLocalFiles TEMPLATEFILE FILEPATHS`](#contrail-cli-types-parsetypesfromtemplateanddatafromlocalfiles-templatefile-filepaths)
|
|
63
|
+
* [`contrail-cli types parseTypesFromTemplateFromLocalFiles TEMPLATEFILE FILEPATH`](#contrail-cli-types-parsetypesfromtemplatefromlocalfiles-templatefile-filepath)
|
|
64
|
+
* [`contrail-cli types uploadOptionSetHierarchies`](#contrail-cli-types-uploadoptionsethierarchies)
|
|
65
|
+
* [`contrail-cli types uploadOptionSets`](#contrail-cli-types-uploadoptionsets)
|
|
66
|
+
* [`contrail-cli types uploadOptionSetsHierarchyLocalFile FILE NAME`](#contrail-cli-types-uploadoptionsetshierarchylocalfile-file-name)
|
|
67
|
+
* [`contrail-cli types uploadRuleSets`](#contrail-cli-types-uploadrulesets)
|
|
68
|
+
* [`contrail-cli types uploadTypePropertyPolicies`](#contrail-cli-types-uploadtypepropertypolicies)
|
|
69
|
+
* [`contrail-cli types uploadUsageInfo`](#contrail-cli-types-uploadusageinfo)
|
|
70
|
+
* [`contrail-cli users export`](#contrail-cli-users-export)
|
|
71
|
+
* [`contrail-cli users upload USERSFILE`](#contrail-cli-users-upload-usersfile)
|
|
72
|
+
* [`contrail-cli workflow-template-definitions install`](#contrail-cli-workflow-template-definitions-install)
|
|
73
|
+
* [`contrail-cli workflow-template-definitions list`](#contrail-cli-workflow-template-definitions-list)
|
|
74
|
+
* [`contrail-cli workflow-templates delete`](#contrail-cli-workflow-templates-delete)
|
|
75
|
+
* [`contrail-cli workflow-templates list`](#contrail-cli-workflow-templates-list)
|
|
76
|
+
* [`contrail-cli workflow-templates load FILELOCATION`](#contrail-cli-workflow-templates-load-filelocation)
|
|
77
|
+
|
|
78
|
+
## `contrail-cli app create`
|
|
79
|
+
|
|
80
|
+
Create an app from a template
|
|
81
|
+
|
|
82
|
+
```
|
|
83
|
+
USAGE
|
|
84
|
+
$ contrail-cli app create
|
|
85
|
+
|
|
86
|
+
DESCRIPTION
|
|
87
|
+
Create an app from a template
|
|
88
|
+
|
|
89
|
+
EXAMPLES
|
|
90
|
+
$ contrail app create
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
## `contrail-cli app delete`
|
|
94
|
+
|
|
95
|
+
Delete the app from the app marketplace
|
|
96
|
+
|
|
97
|
+
```
|
|
98
|
+
USAGE
|
|
99
|
+
$ contrail-cli app delete
|
|
100
|
+
|
|
101
|
+
DESCRIPTION
|
|
102
|
+
Delete the app from the app marketplace
|
|
103
|
+
|
|
104
|
+
EXAMPLES
|
|
105
|
+
$ contrail app delete
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
## `contrail-cli app install`
|
|
109
|
+
|
|
110
|
+
Install an app from the marketplace
|
|
111
|
+
|
|
112
|
+
```
|
|
113
|
+
USAGE
|
|
114
|
+
$ contrail-cli app install [-i <value>] [-w]
|
|
115
|
+
|
|
116
|
+
FLAGS
|
|
117
|
+
-i, --appIdentifier=<value> The identifier of the app to install
|
|
118
|
+
-w, --installWorkflowTemplates Install the app's accompanying workflows
|
|
119
|
+
|
|
120
|
+
DESCRIPTION
|
|
121
|
+
Install an app from the marketplace
|
|
122
|
+
|
|
123
|
+
EXAMPLES
|
|
124
|
+
$ contrail app install --appIdentifier @VibeIQ/Flex-PLM-Connector
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
## `contrail-cli app publish`
|
|
128
|
+
|
|
129
|
+
Publish the app
|
|
130
|
+
|
|
131
|
+
```
|
|
132
|
+
USAGE
|
|
133
|
+
$ contrail-cli app publish
|
|
134
|
+
|
|
135
|
+
DESCRIPTION
|
|
136
|
+
Publish the app
|
|
137
|
+
|
|
138
|
+
EXAMPLES
|
|
139
|
+
$ contrail app publish
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
## `contrail-cli app uninstall`
|
|
143
|
+
|
|
144
|
+
Uninstall an app that is currently installed
|
|
145
|
+
|
|
146
|
+
```
|
|
147
|
+
USAGE
|
|
148
|
+
$ contrail-cli app uninstall [-n <value>]
|
|
149
|
+
|
|
150
|
+
FLAGS
|
|
151
|
+
-n, --appIdentifier=<value> The identifier of the app to install. The identifier can be found on the app's page in
|
|
152
|
+
the marketplace.
|
|
153
|
+
|
|
154
|
+
DESCRIPTION
|
|
155
|
+
Uninstall an app that is currently installed
|
|
156
|
+
|
|
157
|
+
EXAMPLES
|
|
158
|
+
$ contrail app uninstall --name @vibeiq/flexplm-connector
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
## `contrail-cli app upgrade`
|
|
162
|
+
|
|
163
|
+
Upgrade an installed app
|
|
164
|
+
|
|
165
|
+
```
|
|
166
|
+
USAGE
|
|
167
|
+
$ contrail-cli app upgrade [-i <value>] [-l]
|
|
168
|
+
|
|
169
|
+
FLAGS
|
|
170
|
+
-i, --appIdentifier=<value> The appIdentifier of the app to install
|
|
171
|
+
-l, --latest Upgrade to the latest version of the app
|
|
172
|
+
|
|
173
|
+
DESCRIPTION
|
|
174
|
+
Upgrade an installed app
|
|
175
|
+
|
|
176
|
+
EXAMPLES
|
|
177
|
+
$ contrail app upgrade --appIdentifier @VibeIQ/Flex-PLM-Connector --latest
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
## `contrail-cli colors deleteAll`
|
|
181
|
+
|
|
182
|
+
Say hello
|
|
183
|
+
|
|
184
|
+
```
|
|
185
|
+
USAGE
|
|
186
|
+
$ contrail-cli colors deleteAll
|
|
187
|
+
|
|
188
|
+
DESCRIPTION
|
|
189
|
+
Say hello
|
|
190
|
+
|
|
191
|
+
EXAMPLES
|
|
192
|
+
$ contrail colors deleteAll
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
## `contrail-cli colors load`
|
|
196
|
+
|
|
197
|
+
Say hello
|
|
198
|
+
|
|
199
|
+
```
|
|
200
|
+
USAGE
|
|
201
|
+
$ contrail-cli colors load
|
|
202
|
+
|
|
203
|
+
DESCRIPTION
|
|
204
|
+
Say hello
|
|
205
|
+
|
|
206
|
+
EXAMPLES
|
|
207
|
+
$ contrail colors load
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
## `contrail-cli config list`
|
|
211
|
+
|
|
212
|
+
List the configurations
|
|
213
|
+
|
|
214
|
+
```
|
|
215
|
+
USAGE
|
|
216
|
+
$ contrail-cli config list
|
|
217
|
+
|
|
218
|
+
DESCRIPTION
|
|
219
|
+
List the configurations
|
|
220
|
+
|
|
221
|
+
EXAMPLES
|
|
222
|
+
$ contrail config list
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
## `contrail-cli config remove`
|
|
226
|
+
|
|
227
|
+
Remove a variable from the configuration
|
|
228
|
+
|
|
229
|
+
```
|
|
230
|
+
USAGE
|
|
231
|
+
$ contrail-cli config remove [--orgSlug] [--apiGateway] [--orgId] [--apiUserToken]
|
|
232
|
+
|
|
233
|
+
FLAGS
|
|
234
|
+
--apiGateway The API Gateway
|
|
235
|
+
--apiUserToken The API User Token
|
|
236
|
+
--orgId The org Id
|
|
237
|
+
--orgSlug The org slug
|
|
238
|
+
|
|
239
|
+
DESCRIPTION
|
|
240
|
+
Remove a variable from the configuration
|
|
241
|
+
|
|
242
|
+
EXAMPLES
|
|
243
|
+
$ contrail config remove --orgId
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
## `contrail-cli config set`
|
|
247
|
+
|
|
248
|
+
Set a variable in the configuration
|
|
249
|
+
|
|
250
|
+
```
|
|
251
|
+
USAGE
|
|
252
|
+
$ contrail-cli config set [--orgSlug <value>] [--apiGateway <value>] [--orgId <value>] [--apiUserToken <value>]
|
|
253
|
+
|
|
254
|
+
FLAGS
|
|
255
|
+
--apiGateway=<value> The API Gateway
|
|
256
|
+
--apiUserToken=<value> The API User Token
|
|
257
|
+
--orgId=<value> The org Id
|
|
258
|
+
--orgSlug=<value> The org slug
|
|
259
|
+
|
|
260
|
+
DESCRIPTION
|
|
261
|
+
Set a variable in the configuration
|
|
262
|
+
|
|
263
|
+
EXAMPLES
|
|
264
|
+
$ contrail config set --orgId 1234
|
|
265
|
+
```
|
|
266
|
+
|
|
267
|
+
## `contrail-cli help [COMMANDS]`
|
|
268
|
+
|
|
269
|
+
Display help for contrail-cli.
|
|
270
|
+
|
|
271
|
+
```
|
|
272
|
+
USAGE
|
|
273
|
+
$ contrail-cli help [COMMANDS] [-n]
|
|
274
|
+
|
|
275
|
+
ARGUMENTS
|
|
276
|
+
COMMANDS Command to show help for.
|
|
277
|
+
|
|
278
|
+
FLAGS
|
|
279
|
+
-n, --nested-commands Include all nested commands in the output.
|
|
280
|
+
|
|
281
|
+
DESCRIPTION
|
|
282
|
+
Display help for contrail-cli.
|
|
283
|
+
```
|
|
284
|
+
|
|
285
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.6/src/commands/help.ts)_
|
|
286
|
+
|
|
287
|
+
## `contrail-cli loader-process load CONFIGFILENAME`
|
|
288
|
+
|
|
289
|
+
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.
|
|
290
|
+
|
|
291
|
+
```
|
|
292
|
+
USAGE
|
|
293
|
+
$ contrail-cli loader-process load CONFIGFILENAME
|
|
294
|
+
|
|
295
|
+
ARGUMENTS
|
|
296
|
+
CONFIGFILENAME The configuration file location
|
|
297
|
+
|
|
298
|
+
DESCRIPTION
|
|
299
|
+
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
|
|
300
|
+
.yml file.
|
|
301
|
+
|
|
302
|
+
EXAMPLES
|
|
303
|
+
$ contrail load-processor load
|
|
304
|
+
```
|
|
305
|
+
|
|
306
|
+
## `contrail-cli loader-process upload-and-load INCOMINGFILE CONFIGFILENAME`
|
|
307
|
+
|
|
308
|
+
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
|
|
309
|
+
|
|
310
|
+
```
|
|
311
|
+
USAGE
|
|
312
|
+
$ contrail-cli loader-process upload-and-load INCOMINGFILE CONFIGFILENAME
|
|
313
|
+
|
|
314
|
+
ARGUMENTS
|
|
315
|
+
INCOMINGFILE The incoming file location
|
|
316
|
+
CONFIGFILENAME The configuration file location
|
|
317
|
+
|
|
318
|
+
DESCRIPTION
|
|
319
|
+
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
|
|
320
|
+
the config path must be a reference to a .json or a .yml file
|
|
321
|
+
|
|
322
|
+
EXAMPLES
|
|
323
|
+
$ contrail load-processor upload-and-load <File Path> <Config Path>
|
|
324
|
+
```
|
|
325
|
+
|
|
326
|
+
## `contrail-cli plugins`
|
|
327
|
+
|
|
328
|
+
List installed plugins.
|
|
329
|
+
|
|
330
|
+
```
|
|
331
|
+
USAGE
|
|
332
|
+
$ contrail-cli plugins [--core]
|
|
333
|
+
|
|
334
|
+
FLAGS
|
|
335
|
+
--core Show core plugins.
|
|
336
|
+
|
|
337
|
+
DESCRIPTION
|
|
338
|
+
List installed plugins.
|
|
339
|
+
|
|
340
|
+
EXAMPLES
|
|
341
|
+
$ contrail-cli plugins
|
|
342
|
+
```
|
|
343
|
+
|
|
344
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.3.2/src/commands/plugins/index.ts)_
|
|
345
|
+
|
|
346
|
+
## `contrail-cli plugins:install PLUGIN...`
|
|
347
|
+
|
|
348
|
+
Installs a plugin into the CLI.
|
|
349
|
+
|
|
350
|
+
```
|
|
351
|
+
USAGE
|
|
352
|
+
$ contrail-cli plugins:install PLUGIN...
|
|
353
|
+
|
|
354
|
+
ARGUMENTS
|
|
355
|
+
PLUGIN Plugin to install.
|
|
356
|
+
|
|
357
|
+
FLAGS
|
|
358
|
+
-f, --force Run yarn install with force flag.
|
|
359
|
+
-h, --help Show CLI help.
|
|
360
|
+
-v, --verbose
|
|
361
|
+
|
|
362
|
+
DESCRIPTION
|
|
363
|
+
Installs a plugin into the CLI.
|
|
364
|
+
Can be installed from npm or a git url.
|
|
365
|
+
|
|
366
|
+
Installation of a user-installed plugin will override a core plugin.
|
|
367
|
+
|
|
368
|
+
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
|
|
369
|
+
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
|
|
370
|
+
the CLI without the need to patch and update the whole CLI.
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
ALIASES
|
|
374
|
+
$ contrail-cli plugins add
|
|
375
|
+
|
|
376
|
+
EXAMPLES
|
|
377
|
+
$ contrail-cli plugins:install myplugin
|
|
378
|
+
|
|
379
|
+
$ contrail-cli plugins:install https://github.com/someuser/someplugin
|
|
380
|
+
|
|
381
|
+
$ contrail-cli plugins:install someuser/someplugin
|
|
382
|
+
```
|
|
383
|
+
|
|
384
|
+
## `contrail-cli plugins:inspect PLUGIN...`
|
|
385
|
+
|
|
386
|
+
Displays installation properties of a plugin.
|
|
387
|
+
|
|
388
|
+
```
|
|
389
|
+
USAGE
|
|
390
|
+
$ contrail-cli plugins:inspect PLUGIN...
|
|
391
|
+
|
|
392
|
+
ARGUMENTS
|
|
393
|
+
PLUGIN [default: .] Plugin to inspect.
|
|
394
|
+
|
|
395
|
+
FLAGS
|
|
396
|
+
-h, --help Show CLI help.
|
|
397
|
+
-v, --verbose
|
|
398
|
+
|
|
399
|
+
GLOBAL FLAGS
|
|
400
|
+
--json Format output as json.
|
|
401
|
+
|
|
402
|
+
DESCRIPTION
|
|
403
|
+
Displays installation properties of a plugin.
|
|
404
|
+
|
|
405
|
+
EXAMPLES
|
|
406
|
+
$ contrail-cli plugins:inspect myplugin
|
|
407
|
+
```
|
|
408
|
+
|
|
409
|
+
## `contrail-cli plugins:install PLUGIN...`
|
|
410
|
+
|
|
411
|
+
Installs a plugin into the CLI.
|
|
412
|
+
|
|
413
|
+
```
|
|
414
|
+
USAGE
|
|
415
|
+
$ contrail-cli plugins:install PLUGIN...
|
|
416
|
+
|
|
417
|
+
ARGUMENTS
|
|
418
|
+
PLUGIN Plugin to install.
|
|
419
|
+
|
|
420
|
+
FLAGS
|
|
421
|
+
-f, --force Run yarn install with force flag.
|
|
422
|
+
-h, --help Show CLI help.
|
|
423
|
+
-v, --verbose
|
|
424
|
+
|
|
425
|
+
DESCRIPTION
|
|
426
|
+
Installs a plugin into the CLI.
|
|
427
|
+
Can be installed from npm or a git url.
|
|
428
|
+
|
|
429
|
+
Installation of a user-installed plugin will override a core plugin.
|
|
430
|
+
|
|
431
|
+
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
|
|
432
|
+
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
|
|
433
|
+
the CLI without the need to patch and update the whole CLI.
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
ALIASES
|
|
437
|
+
$ contrail-cli plugins add
|
|
438
|
+
|
|
439
|
+
EXAMPLES
|
|
440
|
+
$ contrail-cli plugins:install myplugin
|
|
441
|
+
|
|
442
|
+
$ contrail-cli plugins:install https://github.com/someuser/someplugin
|
|
443
|
+
|
|
444
|
+
$ contrail-cli plugins:install someuser/someplugin
|
|
445
|
+
```
|
|
446
|
+
|
|
447
|
+
## `contrail-cli plugins:link PLUGIN`
|
|
448
|
+
|
|
449
|
+
Links a plugin into the CLI for development.
|
|
450
|
+
|
|
451
|
+
```
|
|
452
|
+
USAGE
|
|
453
|
+
$ contrail-cli plugins:link PLUGIN
|
|
454
|
+
|
|
455
|
+
ARGUMENTS
|
|
456
|
+
PATH [default: .] path to plugin
|
|
457
|
+
|
|
458
|
+
FLAGS
|
|
459
|
+
-h, --help Show CLI help.
|
|
460
|
+
-v, --verbose
|
|
461
|
+
|
|
462
|
+
DESCRIPTION
|
|
463
|
+
Links a plugin into the CLI for development.
|
|
464
|
+
Installation of a linked plugin will override a user-installed or core plugin.
|
|
465
|
+
|
|
466
|
+
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
|
|
467
|
+
command will override the user-installed or core plugin implementation. This is useful for development work.
|
|
468
|
+
|
|
469
|
+
|
|
470
|
+
EXAMPLES
|
|
471
|
+
$ contrail-cli plugins:link myplugin
|
|
472
|
+
```
|
|
473
|
+
|
|
474
|
+
## `contrail-cli plugins:uninstall PLUGIN...`
|
|
475
|
+
|
|
476
|
+
Removes a plugin from the CLI.
|
|
477
|
+
|
|
478
|
+
```
|
|
479
|
+
USAGE
|
|
480
|
+
$ contrail-cli plugins:uninstall PLUGIN...
|
|
481
|
+
|
|
482
|
+
ARGUMENTS
|
|
483
|
+
PLUGIN plugin to uninstall
|
|
484
|
+
|
|
485
|
+
FLAGS
|
|
486
|
+
-h, --help Show CLI help.
|
|
487
|
+
-v, --verbose
|
|
488
|
+
|
|
489
|
+
DESCRIPTION
|
|
490
|
+
Removes a plugin from the CLI.
|
|
491
|
+
|
|
492
|
+
ALIASES
|
|
493
|
+
$ contrail-cli plugins unlink
|
|
494
|
+
$ contrail-cli plugins remove
|
|
495
|
+
```
|
|
496
|
+
|
|
497
|
+
## `contrail-cli plugins:uninstall PLUGIN...`
|
|
498
|
+
|
|
499
|
+
Removes a plugin from the CLI.
|
|
500
|
+
|
|
501
|
+
```
|
|
502
|
+
USAGE
|
|
503
|
+
$ contrail-cli plugins:uninstall PLUGIN...
|
|
504
|
+
|
|
505
|
+
ARGUMENTS
|
|
506
|
+
PLUGIN plugin to uninstall
|
|
507
|
+
|
|
508
|
+
FLAGS
|
|
509
|
+
-h, --help Show CLI help.
|
|
510
|
+
-v, --verbose
|
|
511
|
+
|
|
512
|
+
DESCRIPTION
|
|
513
|
+
Removes a plugin from the CLI.
|
|
514
|
+
|
|
515
|
+
ALIASES
|
|
516
|
+
$ contrail-cli plugins unlink
|
|
517
|
+
$ contrail-cli plugins remove
|
|
518
|
+
```
|
|
519
|
+
|
|
520
|
+
## `contrail-cli plugins:uninstall PLUGIN...`
|
|
521
|
+
|
|
522
|
+
Removes a plugin from the CLI.
|
|
523
|
+
|
|
524
|
+
```
|
|
525
|
+
USAGE
|
|
526
|
+
$ contrail-cli plugins:uninstall PLUGIN...
|
|
527
|
+
|
|
528
|
+
ARGUMENTS
|
|
529
|
+
PLUGIN plugin to uninstall
|
|
530
|
+
|
|
531
|
+
FLAGS
|
|
532
|
+
-h, --help Show CLI help.
|
|
533
|
+
-v, --verbose
|
|
534
|
+
|
|
535
|
+
DESCRIPTION
|
|
536
|
+
Removes a plugin from the CLI.
|
|
537
|
+
|
|
538
|
+
ALIASES
|
|
539
|
+
$ contrail-cli plugins unlink
|
|
540
|
+
$ contrail-cli plugins remove
|
|
541
|
+
```
|
|
542
|
+
|
|
543
|
+
## `contrail-cli plugins update`
|
|
544
|
+
|
|
545
|
+
Update installed plugins.
|
|
546
|
+
|
|
547
|
+
```
|
|
548
|
+
USAGE
|
|
549
|
+
$ contrail-cli plugins update [-h] [-v]
|
|
550
|
+
|
|
551
|
+
FLAGS
|
|
552
|
+
-h, --help Show CLI help.
|
|
553
|
+
-v, --verbose
|
|
554
|
+
|
|
555
|
+
DESCRIPTION
|
|
556
|
+
Update installed plugins.
|
|
557
|
+
```
|
|
558
|
+
|
|
559
|
+
## `contrail-cli projects export PROJECTNAME`
|
|
560
|
+
|
|
561
|
+
Export a project.
|
|
562
|
+
|
|
563
|
+
```
|
|
564
|
+
USAGE
|
|
565
|
+
$ contrail-cli projects export PROJECTNAME
|
|
566
|
+
|
|
567
|
+
DESCRIPTION
|
|
568
|
+
Export a project.
|
|
569
|
+
|
|
570
|
+
EXAMPLES
|
|
571
|
+
$ contrail project export <PROJECT_NAME>
|
|
572
|
+
```
|
|
573
|
+
|
|
574
|
+
## `contrail-cli projects list`
|
|
575
|
+
|
|
576
|
+
Get a list of all projects.
|
|
577
|
+
|
|
578
|
+
```
|
|
579
|
+
USAGE
|
|
580
|
+
$ contrail-cli projects list
|
|
581
|
+
|
|
582
|
+
DESCRIPTION
|
|
583
|
+
Get a list of all projects.
|
|
584
|
+
|
|
585
|
+
EXAMPLES
|
|
586
|
+
$ contrail project list
|
|
587
|
+
```
|
|
588
|
+
|
|
589
|
+
## `contrail-cli projects load TEMPLATEFILELOCATION`
|
|
590
|
+
|
|
591
|
+
Configure a project from a yml file.
|
|
592
|
+
|
|
593
|
+
```
|
|
594
|
+
USAGE
|
|
595
|
+
$ contrail-cli projects load TEMPLATEFILELOCATION
|
|
596
|
+
|
|
597
|
+
ARGUMENTS
|
|
598
|
+
TEMPLATEFILELOCATION The location to the template file
|
|
599
|
+
|
|
600
|
+
DESCRIPTION
|
|
601
|
+
Configure a project from a yml file.
|
|
602
|
+
|
|
603
|
+
EXAMPLES
|
|
604
|
+
$ contrail project load <TEMPLATE_FILE_LOCATION>
|
|
605
|
+
```
|
|
606
|
+
|
|
607
|
+
## `contrail-cli types exportOptionSetHierarchies`
|
|
608
|
+
|
|
609
|
+
export OptionSetHierarchies into CSVs.
|
|
610
|
+
|
|
611
|
+
```
|
|
612
|
+
USAGE
|
|
613
|
+
$ contrail-cli types exportOptionSetHierarchies
|
|
614
|
+
|
|
615
|
+
DESCRIPTION
|
|
616
|
+
export OptionSetHierarchies into CSVs.
|
|
617
|
+
|
|
618
|
+
EXAMPLES
|
|
619
|
+
$ contrail types exportOptionSetsHierarchies
|
|
620
|
+
```
|
|
621
|
+
|
|
622
|
+
## `contrail-cli types getAll`
|
|
623
|
+
|
|
624
|
+
Get all Types and associated data for your Org
|
|
625
|
+
|
|
626
|
+
```
|
|
627
|
+
USAGE
|
|
628
|
+
$ contrail-cli types getAll
|
|
629
|
+
|
|
630
|
+
DESCRIPTION
|
|
631
|
+
Get all Types and associated data for your Org
|
|
632
|
+
|
|
633
|
+
EXAMPLES
|
|
634
|
+
$ contrail types getAll
|
|
635
|
+
```
|
|
636
|
+
|
|
637
|
+
## `contrail-cli types loadAll`
|
|
638
|
+
|
|
639
|
+
Get all Types and associated data for your Org
|
|
640
|
+
|
|
641
|
+
```
|
|
642
|
+
USAGE
|
|
643
|
+
$ contrail-cli types loadAll
|
|
644
|
+
|
|
645
|
+
DESCRIPTION
|
|
646
|
+
Get all Types and associated data for your Org
|
|
647
|
+
|
|
648
|
+
EXAMPLES
|
|
649
|
+
$ contrail types getAll
|
|
650
|
+
```
|
|
651
|
+
|
|
652
|
+
## `contrail-cli types mergeOptionSets FILE`
|
|
653
|
+
|
|
654
|
+
Merge the OptionSets from an existing org and the OptionSets passed in. OptionSets File must be .yml.
|
|
655
|
+
|
|
656
|
+
```
|
|
657
|
+
USAGE
|
|
658
|
+
$ contrail-cli types mergeOptionSets FILE
|
|
659
|
+
|
|
660
|
+
ARGUMENTS
|
|
661
|
+
FILE File to merge with the cloud option sets
|
|
662
|
+
|
|
663
|
+
DESCRIPTION
|
|
664
|
+
Merge the OptionSets from an existing org and the OptionSets passed in. OptionSets File must be .yml.
|
|
665
|
+
|
|
666
|
+
EXAMPLES
|
|
667
|
+
$ contrail types mergeOptionSets <File Path>
|
|
668
|
+
```
|
|
669
|
+
|
|
670
|
+
## `contrail-cli types mergeTypeProperties FILE TYPEPATHS`
|
|
671
|
+
|
|
672
|
+
Merge the TypeProperties from an existing org and the TypeProperties passed in. Add to Types via TypePath File must be .yml
|
|
673
|
+
|
|
674
|
+
```
|
|
675
|
+
USAGE
|
|
676
|
+
$ contrail-cli types mergeTypeProperties FILE TYPEPATHS
|
|
677
|
+
|
|
678
|
+
ARGUMENTS
|
|
679
|
+
FILE File to parse
|
|
680
|
+
TYPEPATHS A list of the type paths to merge
|
|
681
|
+
|
|
682
|
+
DESCRIPTION
|
|
683
|
+
Merge the TypeProperties from an existing org and the TypeProperties passed in. Add to Types via TypePath File must be
|
|
684
|
+
.yml
|
|
685
|
+
|
|
686
|
+
EXAMPLES
|
|
687
|
+
$ contrail types mergeTypeProperties <File Path> <TypePaths>
|
|
688
|
+
```
|
|
689
|
+
|
|
690
|
+
## `contrail-cli types parseOptionSetsHierarchyLocalFile FILE`
|
|
691
|
+
|
|
692
|
+
Parse CSV file into OptionSetHierarchy
|
|
693
|
+
|
|
694
|
+
```
|
|
695
|
+
USAGE
|
|
696
|
+
$ contrail-cli types parseOptionSetsHierarchyLocalFile FILE
|
|
697
|
+
|
|
698
|
+
ARGUMENTS
|
|
699
|
+
FILE File to parse
|
|
700
|
+
|
|
701
|
+
DESCRIPTION
|
|
702
|
+
Parse CSV file into OptionSetHierarchy
|
|
703
|
+
|
|
704
|
+
EXAMPLES
|
|
705
|
+
$ contrail types parseOptionSetsHierarchyLocalFile <File Paths>
|
|
706
|
+
```
|
|
707
|
+
|
|
708
|
+
## `contrail-cli types parseOptionSetsLocalFiles FILE`
|
|
709
|
+
|
|
710
|
+
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"
|
|
711
|
+
|
|
712
|
+
```
|
|
713
|
+
USAGE
|
|
714
|
+
$ contrail-cli types parseOptionSetsLocalFiles FILE --csvStyle NameAndLabel|LabelsInColumn
|
|
715
|
+
|
|
716
|
+
ARGUMENTS
|
|
717
|
+
FILE File to parse
|
|
718
|
+
|
|
719
|
+
FLAGS
|
|
720
|
+
--csvStyle=<option> (required)
|
|
721
|
+
<options: NameAndLabel|LabelsInColumn>
|
|
722
|
+
|
|
723
|
+
DESCRIPTION
|
|
724
|
+
Parse CSV files into OptionSets. Style denotes the format the csv is in. If the csv file has a column for name and
|
|
725
|
+
label, use "NameAndLabel". If the file has one column for each option set with the rows being the label value use
|
|
726
|
+
"LabelsInColumn"
|
|
727
|
+
|
|
728
|
+
EXAMPLES
|
|
729
|
+
$ contrail types parseOptionSetsLocalFiles <File Paths> <style>
|
|
730
|
+
```
|
|
731
|
+
|
|
732
|
+
## `contrail-cli types parseOptionSetsToFolderStructure FILE`
|
|
733
|
+
|
|
734
|
+
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"
|
|
735
|
+
|
|
736
|
+
```
|
|
737
|
+
USAGE
|
|
738
|
+
$ contrail-cli types parseOptionSetsToFolderStructure FILE
|
|
739
|
+
|
|
740
|
+
ARGUMENTS
|
|
741
|
+
FILE File to parse
|
|
742
|
+
|
|
743
|
+
DESCRIPTION
|
|
744
|
+
Parse CSV files into OptionSets. Style denotes the format the csv is in. If the csv file has a column for name and
|
|
745
|
+
label, use "NameAndLabel". If the file has one column for each option set with the rows being the label value use
|
|
746
|
+
"LabelsInColumn"
|
|
747
|
+
|
|
748
|
+
EXAMPLES
|
|
749
|
+
$ contrail types parseOptionSetsLocalFiles <File Paths> <style>
|
|
750
|
+
```
|
|
751
|
+
|
|
752
|
+
## `contrail-cli types parseTypesFromFiles TYPEPATHS`
|
|
753
|
+
|
|
754
|
+
Parse CSV files into Types and OptionSets from VibeIQ Files.
|
|
755
|
+
|
|
756
|
+
```
|
|
757
|
+
USAGE
|
|
758
|
+
$ contrail-cli types parseTypesFromFiles TYPEPATHS
|
|
759
|
+
|
|
760
|
+
ARGUMENTS
|
|
761
|
+
TYPEPATHS A list of the VibeIQ file IDs to parse
|
|
762
|
+
|
|
763
|
+
DESCRIPTION
|
|
764
|
+
Parse CSV files into Types and OptionSets from VibeIQ Files.
|
|
765
|
+
File must be .yml.
|
|
766
|
+
|
|
767
|
+
EXAMPLES
|
|
768
|
+
$ contrail types parseTypesFromFiles <fileIds>
|
|
769
|
+
```
|
|
770
|
+
|
|
771
|
+
## `contrail-cli types parseTypesFromLocalFiles TYPEPATHS`
|
|
772
|
+
|
|
773
|
+
Parse CSV files into Types and OptionSets from local files.
|
|
774
|
+
|
|
775
|
+
```
|
|
776
|
+
USAGE
|
|
777
|
+
$ contrail-cli types parseTypesFromLocalFiles TYPEPATHS
|
|
778
|
+
|
|
779
|
+
ARGUMENTS
|
|
780
|
+
TYPEPATHS A list of the files to parse
|
|
781
|
+
|
|
782
|
+
DESCRIPTION
|
|
783
|
+
Parse CSV files into Types and OptionSets from local files.
|
|
784
|
+
|
|
785
|
+
EXAMPLES
|
|
786
|
+
$ contrail types parseTypesFromLocalFiles <File Paths>
|
|
787
|
+
```
|
|
788
|
+
|
|
789
|
+
## `contrail-cli types parseTypesFromTemplateAndDataFromLocalFiles TEMPLATEFILE FILEPATHS`
|
|
790
|
+
|
|
791
|
+
Parse CSV files into Types and OptionSets from local type template files.
|
|
792
|
+
|
|
793
|
+
```
|
|
794
|
+
USAGE
|
|
795
|
+
$ contrail-cli types parseTypesFromTemplateAndDataFromLocalFiles TEMPLATEFILE FILEPATHS
|
|
796
|
+
|
|
797
|
+
ARGUMENTS
|
|
798
|
+
TEMPLATEFILE The template file to use
|
|
799
|
+
FILEPATHS A list of data file to use
|
|
800
|
+
|
|
801
|
+
DESCRIPTION
|
|
802
|
+
Parse CSV files into Types and OptionSets from local type template files.
|
|
803
|
+
|
|
804
|
+
EXAMPLES
|
|
805
|
+
$ contrail types parseTypesFromTemplateAndDataFromLocalFiles <Template Path> <File Paths>
|
|
806
|
+
```
|
|
807
|
+
|
|
808
|
+
## `contrail-cli types parseTypesFromTemplateFromLocalFiles TEMPLATEFILE FILEPATH`
|
|
809
|
+
|
|
810
|
+
Parse CSV files into Types and OptionSets from local type template files.
|
|
811
|
+
|
|
812
|
+
```
|
|
813
|
+
USAGE
|
|
814
|
+
$ contrail-cli types parseTypesFromTemplateFromLocalFiles TEMPLATEFILE FILEPATH
|
|
815
|
+
|
|
816
|
+
ARGUMENTS
|
|
817
|
+
TEMPLATEFILE The template file to use
|
|
818
|
+
FILEPATH The data file to use
|
|
819
|
+
|
|
820
|
+
DESCRIPTION
|
|
821
|
+
Parse CSV files into Types and OptionSets from local type template files.
|
|
822
|
+
|
|
823
|
+
EXAMPLES
|
|
824
|
+
$ contrail types parseTypesFromTemplateFromLocalFiles <Template File> <Data File>
|
|
825
|
+
```
|
|
826
|
+
|
|
827
|
+
## `contrail-cli types uploadOptionSetHierarchies`
|
|
828
|
+
|
|
829
|
+
Upload OptionSets for your Org. OptionSets are loaded from .yml files in the option-sets directory.
|
|
830
|
+
|
|
831
|
+
```
|
|
832
|
+
USAGE
|
|
833
|
+
$ contrail-cli types uploadOptionSetHierarchies
|
|
834
|
+
|
|
835
|
+
DESCRIPTION
|
|
836
|
+
Upload OptionSets for your Org. OptionSets are loaded from .yml files in the option-sets directory.
|
|
837
|
+
|
|
838
|
+
EXAMPLES
|
|
839
|
+
$ contrail types uploadOptionSetHierarchies
|
|
840
|
+
```
|
|
841
|
+
|
|
842
|
+
## `contrail-cli types uploadOptionSets`
|
|
843
|
+
|
|
844
|
+
Upload OptionSets for your Org. OptionSets are loaded from .yml files in the option-sets directory.
|
|
845
|
+
|
|
846
|
+
```
|
|
847
|
+
USAGE
|
|
848
|
+
$ contrail-cli types uploadOptionSets
|
|
849
|
+
|
|
850
|
+
DESCRIPTION
|
|
851
|
+
Upload OptionSets for your Org. OptionSets are loaded from .yml files in the option-sets directory.
|
|
852
|
+
|
|
853
|
+
EXAMPLES
|
|
854
|
+
$ contrail types uploadOptionSets
|
|
855
|
+
```
|
|
856
|
+
|
|
857
|
+
## `contrail-cli types uploadOptionSetsHierarchyLocalFile FILE NAME`
|
|
858
|
+
|
|
859
|
+
upload CSV file into OptionSetHierarchy
|
|
860
|
+
|
|
861
|
+
```
|
|
862
|
+
USAGE
|
|
863
|
+
$ contrail-cli types uploadOptionSetsHierarchyLocalFile FILE NAME
|
|
864
|
+
|
|
865
|
+
ARGUMENTS
|
|
866
|
+
FILE File to parse
|
|
867
|
+
NAME The name to be give to the option set hierarchy
|
|
868
|
+
|
|
869
|
+
DESCRIPTION
|
|
870
|
+
upload CSV file into OptionSetHierarchy
|
|
871
|
+
|
|
872
|
+
EXAMPLES
|
|
873
|
+
$ contrail types uploadOptionSetsHierarchyLocalFile <File Path> <name>
|
|
874
|
+
```
|
|
875
|
+
|
|
876
|
+
## `contrail-cli types uploadRuleSets`
|
|
877
|
+
|
|
878
|
+
Upload an extracted rule set
|
|
879
|
+
|
|
880
|
+
```
|
|
881
|
+
USAGE
|
|
882
|
+
$ contrail-cli types uploadRuleSets
|
|
883
|
+
|
|
884
|
+
DESCRIPTION
|
|
885
|
+
Upload an extracted rule set
|
|
886
|
+
|
|
887
|
+
EXAMPLES
|
|
888
|
+
$ contrail types uploadRuleSets
|
|
889
|
+
```
|
|
890
|
+
|
|
891
|
+
## `contrail-cli types uploadTypePropertyPolicies`
|
|
892
|
+
|
|
893
|
+
Upload type property policies
|
|
894
|
+
|
|
895
|
+
```
|
|
896
|
+
USAGE
|
|
897
|
+
$ contrail-cli types uploadTypePropertyPolicies
|
|
898
|
+
|
|
899
|
+
DESCRIPTION
|
|
900
|
+
Upload type property policies
|
|
901
|
+
|
|
902
|
+
EXAMPLES
|
|
903
|
+
$ contrail types uploadTypePropertyPolicies
|
|
904
|
+
```
|
|
905
|
+
|
|
906
|
+
## `contrail-cli types uploadUsageInfo`
|
|
907
|
+
|
|
908
|
+
Upload extracted usage info
|
|
909
|
+
|
|
910
|
+
```
|
|
911
|
+
USAGE
|
|
912
|
+
$ contrail-cli types uploadUsageInfo
|
|
913
|
+
|
|
914
|
+
DESCRIPTION
|
|
915
|
+
Upload extracted usage info
|
|
916
|
+
|
|
917
|
+
EXAMPLES
|
|
918
|
+
$ contrail types uploadUsageInfo
|
|
919
|
+
```
|
|
920
|
+
|
|
921
|
+
## `contrail-cli users export`
|
|
922
|
+
|
|
923
|
+
Export all users in the org.
|
|
924
|
+
|
|
925
|
+
```
|
|
926
|
+
USAGE
|
|
927
|
+
$ contrail-cli users export [-f <value>]
|
|
928
|
+
|
|
929
|
+
FLAGS
|
|
930
|
+
-f, --fileOut=<value> The location for the file to be saved
|
|
931
|
+
|
|
932
|
+
DESCRIPTION
|
|
933
|
+
Export all users in the org.
|
|
934
|
+
|
|
935
|
+
EXAMPLES
|
|
936
|
+
$ contrail users export
|
|
937
|
+
```
|
|
938
|
+
|
|
939
|
+
## `contrail-cli users upload USERSFILE`
|
|
940
|
+
|
|
941
|
+
Import all users in the users.yml file
|
|
942
|
+
|
|
943
|
+
```
|
|
944
|
+
USAGE
|
|
945
|
+
$ contrail-cli users upload USERSFILE
|
|
946
|
+
|
|
947
|
+
ARGUMENTS
|
|
948
|
+
USERSFILE The .yml file containing the users
|
|
949
|
+
|
|
950
|
+
DESCRIPTION
|
|
951
|
+
Import all users in the users.yml file
|
|
952
|
+
|
|
953
|
+
EXAMPLES
|
|
954
|
+
$ contrail users import <USERS_FILE>
|
|
955
|
+
```
|
|
956
|
+
|
|
957
|
+
## `contrail-cli workflow-template-definitions install`
|
|
958
|
+
|
|
959
|
+
Install the template definitions of an app to your org
|
|
960
|
+
|
|
961
|
+
```
|
|
962
|
+
USAGE
|
|
963
|
+
$ contrail-cli workflow-template-definitions install
|
|
964
|
+
|
|
965
|
+
DESCRIPTION
|
|
966
|
+
Install the template definitions of an app to your org
|
|
967
|
+
|
|
968
|
+
EXAMPLES
|
|
969
|
+
$ contrail workflow-template-definitions install
|
|
970
|
+
```
|
|
971
|
+
|
|
972
|
+
## `contrail-cli workflow-template-definitions list`
|
|
973
|
+
|
|
974
|
+
Lists the workflow templates in the org
|
|
975
|
+
|
|
976
|
+
```
|
|
977
|
+
USAGE
|
|
978
|
+
$ contrail-cli workflow-template-definitions list
|
|
979
|
+
|
|
980
|
+
DESCRIPTION
|
|
981
|
+
Lists the workflow templates in the org
|
|
982
|
+
|
|
983
|
+
EXAMPLES
|
|
984
|
+
$ contrail workflow-template-definitions list
|
|
985
|
+
```
|
|
986
|
+
|
|
987
|
+
## `contrail-cli workflow-templates delete`
|
|
988
|
+
|
|
989
|
+
Delete workflow templates from your org
|
|
990
|
+
|
|
991
|
+
```
|
|
992
|
+
USAGE
|
|
993
|
+
$ contrail-cli workflow-templates delete
|
|
994
|
+
|
|
995
|
+
DESCRIPTION
|
|
996
|
+
Delete workflow templates from your org
|
|
997
|
+
|
|
998
|
+
EXAMPLES
|
|
999
|
+
$ contrail workflow-template delete
|
|
1000
|
+
```
|
|
1001
|
+
|
|
1002
|
+
## `contrail-cli workflow-templates list`
|
|
1003
|
+
|
|
1004
|
+
Lists the workflow templates in the org
|
|
1005
|
+
|
|
1006
|
+
```
|
|
1007
|
+
USAGE
|
|
1008
|
+
$ contrail-cli workflow-templates list
|
|
1009
|
+
|
|
1010
|
+
DESCRIPTION
|
|
1011
|
+
Lists the workflow templates in the org
|
|
1012
|
+
|
|
1013
|
+
EXAMPLES
|
|
1014
|
+
$ contrail workflow-template list
|
|
1015
|
+
```
|
|
1016
|
+
|
|
1017
|
+
## `contrail-cli workflow-templates load FILELOCATION`
|
|
1018
|
+
|
|
1019
|
+
Loads your workflow from a local file
|
|
1020
|
+
|
|
1021
|
+
```
|
|
1022
|
+
USAGE
|
|
1023
|
+
$ contrail-cli workflow-templates load FILELOCATION
|
|
1024
|
+
|
|
1025
|
+
ARGUMENTS
|
|
1026
|
+
FILELOCATION The workflow template file to load
|
|
1027
|
+
|
|
1028
|
+
DESCRIPTION
|
|
1029
|
+
Loads your workflow from a local file
|
|
1030
|
+
|
|
1031
|
+
EXAMPLES
|
|
1032
|
+
$ contrail workflow-template load <FILE_LOCATION>
|
|
1033
|
+
```
|
|
1034
|
+
<!-- commandsstop -->
|