@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.
Files changed (270) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +1034 -5
  3. package/bin/dev +17 -0
  4. package/bin/dev.cmd +3 -0
  5. package/bin/run +5 -0
  6. package/bin/run.cmd +3 -0
  7. package/{lib → dist}/api/apps.d.ts +13 -13
  8. package/dist/api/apps.js +96 -0
  9. package/{lib → dist}/api/event-workflow-action-definition.d.ts +1 -1
  10. package/dist/api/event-workflow-action-definition.js +11 -0
  11. package/{lib → dist}/api/event-workflow-template-definition.d.ts +6 -6
  12. package/dist/api/event-workflow-template-definition.js +26 -0
  13. package/{lib → dist}/api/event-workflow-templates.d.ts +7 -7
  14. package/dist/api/event-workflow-templates.js +32 -0
  15. package/dist/api/types.d.ts +7 -0
  16. package/dist/api/types.js +52 -0
  17. package/{lib → dist}/auth/auth.d.ts +9 -9
  18. package/dist/auth/auth.js +6 -0
  19. package/{lib → dist}/auth/login.d.ts +2 -2
  20. package/{lib → dist}/auth/login.js +146 -141
  21. package/dist/commands/app/create.d.ts +6 -0
  22. package/dist/commands/app/create.js +15 -0
  23. package/dist/commands/app/delete.d.ts +7 -0
  24. package/dist/commands/app/delete.js +38 -0
  25. package/dist/commands/app/install.d.ts +11 -0
  26. package/dist/commands/app/install.js +117 -0
  27. package/dist/commands/app/publish.d.ts +7 -0
  28. package/dist/commands/app/publish.js +45 -0
  29. package/dist/commands/app/uninstall.d.ts +10 -0
  30. package/dist/commands/app/uninstall.js +58 -0
  31. package/dist/commands/app/upgrade.d.ts +11 -0
  32. package/dist/commands/app/upgrade.js +79 -0
  33. package/dist/commands/colors/deleteAll.d.ts +6 -0
  34. package/dist/commands/colors/deleteAll.js +30 -0
  35. package/dist/commands/colors/load.d.ts +6 -0
  36. package/dist/commands/colors/load.js +29 -0
  37. package/dist/commands/config/list.d.ts +6 -0
  38. package/dist/commands/config/list.js +15 -0
  39. package/dist/commands/config/remove.d.ts +14 -0
  40. package/dist/commands/config/remove.js +26 -0
  41. package/dist/commands/config/set.d.ts +13 -0
  42. package/dist/commands/config/set.js +29 -0
  43. package/dist/commands/loader-process/load.d.ts +9 -0
  44. package/dist/commands/loader-process/load.js +33 -0
  45. package/dist/commands/loader-process/upload-and-load.d.ts +10 -0
  46. package/dist/commands/loader-process/upload-and-load.js +35 -0
  47. package/dist/commands/projects/export.d.ts +10 -0
  48. package/dist/commands/projects/export.js +34 -0
  49. package/dist/commands/projects/list.d.ts +6 -0
  50. package/dist/commands/projects/list.js +34 -0
  51. package/dist/commands/projects/load.d.ts +9 -0
  52. package/{lib/projects/project-uploader.js → dist/commands/projects/load.js} +106 -105
  53. package/dist/commands/types/exportOptionSetHierarchies.d.ts +7 -0
  54. package/{lib/types/option-set-hierarchy-exporter.js → dist/commands/types/exportOptionSetHierarchies.js} +130 -113
  55. package/{lib/types/types-extractor.d.ts → dist/commands/types/getAll.d.ts} +29 -27
  56. package/{lib/types/types-extractor.js → dist/commands/types/getAll.js} +267 -318
  57. package/dist/commands/types/loadAll.d.ts +7 -0
  58. package/dist/commands/types/loadAll.js +41 -0
  59. package/dist/commands/types/mergeOptionSets.d.ts +9 -0
  60. package/{lib/types/option-set-merger.js → dist/commands/types/mergeOptionSets.js} +114 -105
  61. package/dist/commands/types/mergeTypeProperties.d.ts +11 -0
  62. package/dist/commands/types/mergeTypeProperties.js +89 -0
  63. package/dist/commands/types/parseOptionSetsHierarchyLocalFile.d.ts +10 -0
  64. package/dist/commands/types/parseOptionSetsHierarchyLocalFile.js +112 -0
  65. package/dist/commands/types/parseOptionSetsLocalFiles.d.ts +14 -0
  66. package/dist/commands/types/parseOptionSetsLocalFiles.js +153 -0
  67. package/dist/commands/types/parseOptionSetsToFolderStructure.d.ts +10 -0
  68. package/dist/commands/types/parseOptionSetsToFolderStructure.js +104 -0
  69. package/dist/commands/types/parseTypesFromFiles.d.ts +10 -0
  70. package/dist/commands/types/parseTypesFromFiles.js +34 -0
  71. package/dist/commands/types/parseTypesFromLocalFiles.d.ts +10 -0
  72. package/dist/commands/types/parseTypesFromLocalFiles.js +34 -0
  73. package/dist/commands/types/parseTypesFromTemplateAndDataFromLocalFiles.d.ts +11 -0
  74. package/dist/commands/types/parseTypesFromTemplateAndDataFromLocalFiles.js +36 -0
  75. package/dist/commands/types/parseTypesFromTemplateFromLocalFiles.d.ts +10 -0
  76. package/dist/commands/types/parseTypesFromTemplateFromLocalFiles.js +35 -0
  77. package/dist/commands/types/uploadOptionSetHierarchies.d.ts +7 -0
  78. package/{lib/types/option-set-hierarchy-uploader.js → dist/commands/types/uploadOptionSetHierarchies.js} +130 -113
  79. package/dist/commands/types/uploadOptionSets.d.ts +7 -0
  80. package/{lib/types/option-set-uploader.js → dist/commands/types/uploadOptionSets.js} +115 -98
  81. package/dist/commands/types/uploadOptionSetsHierarchyLocalFile.d.ts +11 -0
  82. package/{lib/types/option-set-hierarchy-parser.js → dist/commands/types/uploadOptionSetsHierarchyLocalFile.js} +128 -140
  83. package/dist/commands/types/uploadRuleSets.d.ts +7 -0
  84. package/{lib/types/rule-set-uploader.js → dist/commands/types/uploadRuleSets.js} +189 -172
  85. package/dist/commands/types/uploadTypePropertyPolicies.d.ts +7 -0
  86. package/{lib/types/type-property-policy-uploader.js → dist/commands/types/uploadTypePropertyPolicies.js} +195 -178
  87. package/dist/commands/types/uploadUsageInfo.d.ts +7 -0
  88. package/{lib/types/usage-info-uploader.js → dist/commands/types/uploadUsageInfo.js} +149 -132
  89. package/dist/commands/users/export.d.ts +9 -0
  90. package/dist/commands/users/export.js +60 -0
  91. package/dist/commands/users/upload.d.ts +9 -0
  92. package/dist/commands/users/upload.js +65 -0
  93. package/dist/commands/workflow-template-definitions/install.d.ts +6 -0
  94. package/dist/commands/workflow-template-definitions/install.js +17 -0
  95. package/dist/commands/workflow-template-definitions/list.d.ts +6 -0
  96. package/dist/commands/workflow-template-definitions/list.js +17 -0
  97. package/dist/commands/workflow-templates/delete.d.ts +6 -0
  98. package/dist/commands/workflow-templates/delete.js +17 -0
  99. package/dist/commands/workflow-templates/list.d.ts +6 -0
  100. package/dist/commands/workflow-templates/list.js +17 -0
  101. package/dist/commands/workflow-templates/load.d.ts +9 -0
  102. package/dist/commands/workflow-templates/load.js +21 -0
  103. package/{lib → dist}/common.d.ts +1 -1
  104. package/dist/common.js +9 -0
  105. package/{lib/apps/deploy-app → dist/helpers/app}/actions-deployer.d.ts +11 -11
  106. package/{lib/apps/deploy-app → dist/helpers/app}/actions-deployer.js +122 -114
  107. package/{lib/apps/deploy-app → dist/helpers/app}/app-deployer.d.ts +8 -8
  108. package/{lib/apps/deploy-app → dist/helpers/app}/app-deployer.js +98 -93
  109. package/{lib/apps/deploy-app → dist/helpers/app}/app-template-parsers.d.ts +7 -7
  110. package/{lib/apps/deploy-app → dist/helpers/app}/app-template-parsers.js +43 -38
  111. package/dist/helpers/app/load-app-config.d.ts +1 -0
  112. package/dist/helpers/app/load-app-config.js +18 -0
  113. package/dist/helpers/app/setup-template.d.ts +1 -0
  114. package/dist/helpers/app/setup-template.js +38 -0
  115. package/dist/helpers/colors/helpers.d.ts +4 -0
  116. package/dist/helpers/colors/helpers.js +74 -0
  117. package/{lib → dist/helpers}/config/config.d.ts +6 -6
  118. package/dist/helpers/config/config.js +76 -0
  119. package/dist/helpers/loader-process/helpers.d.ts +2 -0
  120. package/{lib/loader-process/loader-process.js → dist/helpers/loader-process/helpers.js} +98 -120
  121. package/dist/helpers/projects/helpers.d.ts +2 -0
  122. package/{lib/projects/project-exporter.js → dist/helpers/projects/helpers.js} +165 -187
  123. package/{lib → dist/helpers}/types/csv-parser.d.ts +1 -1
  124. package/{lib → dist/helpers}/types/csv-parser.js +56 -51
  125. package/dist/helpers/types/type-extractor.d.ts +1 -0
  126. package/dist/helpers/types/type-extractor.js +32 -0
  127. package/dist/helpers/types/type-parser.d.ts +4 -0
  128. package/dist/helpers/types/type-parser.js +118 -0
  129. package/{lib/types/types-uploader.d.ts → dist/helpers/types/type-uploader.d.ts} +1 -1
  130. package/{lib/types/types-uploader.js → dist/helpers/types/type-uploader.js} +244 -239
  131. package/{lib → dist/helpers}/workflow-template-definitions/workflow-template-definition-deployer.d.ts +12 -12
  132. package/{lib → dist/helpers}/workflow-template-definitions/workflow-template-definition-deployer.js +156 -151
  133. package/{lib/workflow-templates/local-workflow-template-deployer.d.ts → dist/helpers/workflow-templates/helper.d.ts} +17 -11
  134. package/dist/helpers/workflow-templates/helper.js +166 -0
  135. package/dist/index.d.ts +1 -0
  136. package/dist/index.js +5 -0
  137. package/{lib → dist}/interfaces.d.ts +323 -191
  138. package/dist/interfaces.js +63 -0
  139. package/{templates → dist/templates}/typescript/Dockerfile +15 -15
  140. package/{templates → dist/templates}/typescript/README.md +10 -10
  141. package/{templates → dist/templates}/typescript/app.yml +49 -49
  142. package/{templates → dist/templates}/typescript/docker_deploy.bat +1 -1
  143. package/{templates → dist/templates}/typescript/package.json +54 -54
  144. package/{templates → dist/templates}/typescript/src/actions/logItem.ts +25 -25
  145. package/{templates → dist/templates}/typescript/src/framework/action-dispatcher.ts +89 -89
  146. package/{templates → dist/templates}/typescript/src/framework/app-config.ts +26 -26
  147. package/{templates → dist/templates}/typescript/src/framework/handler.ts +11 -11
  148. package/{templates → dist/templates}/typescript/src/framework/index.ts +2 -2
  149. package/{templates → dist/templates}/typescript/src/framework/interfaces.ts +32 -32
  150. package/{templates → dist/templates}/typescript/src/framework/logger.ts +21 -21
  151. package/{templates → dist/templates}/typescript/src/framework/mock-server.ts +31 -31
  152. package/{templates → dist/templates}/typescript/tsconfig.json +28 -28
  153. package/oclif.manifest.json +821 -0
  154. package/package.json +116 -72
  155. package/.eslintrc.js +0 -53
  156. package/.vscode/settings.json +0 -6
  157. package/bin/init +0 -4
  158. package/lib/api/apps.js +0 -85
  159. package/lib/api/event-workflow-action-definition.js +0 -7
  160. package/lib/api/event-workflow-template-definition.js +0 -20
  161. package/lib/api/event-workflow-templates.js +0 -25
  162. package/lib/apps/create-app/create.d.ts +0 -1
  163. package/lib/apps/create-app/create.js +0 -60
  164. package/lib/apps/create-app/setup-template.d.ts +0 -1
  165. package/lib/apps/create-app/setup-template.js +0 -34
  166. package/lib/apps/deploy-app/deploy.d.ts +0 -2
  167. package/lib/apps/deploy-app/deploy.js +0 -58
  168. package/lib/apps/install-app/app-installer.d.ts +0 -2
  169. package/lib/apps/install-app/app-installer.js +0 -120
  170. package/lib/apps/upgrade-app/app-upgrader.d.ts +0 -3
  171. package/lib/apps/upgrade-app/app-upgrader.js +0 -126
  172. package/lib/auth/auth.js +0 -2
  173. package/lib/cli.d.ts +0 -5
  174. package/lib/cli.js +0 -524
  175. package/lib/colors/color-loader.d.ts +0 -2
  176. package/lib/colors/color-loader.js +0 -96
  177. package/lib/common.js +0 -5
  178. package/lib/config/config.js +0 -70
  179. package/lib/config/configCommands.d.ts +0 -3
  180. package/lib/config/configCommands.js +0 -34
  181. package/lib/interfaces.js +0 -25
  182. package/lib/loader-process/loader-process.d.ts +0 -2
  183. package/lib/projects/interfaces.d.ts +0 -77
  184. package/lib/projects/interfaces.js +0 -23
  185. package/lib/projects/project-exporter.d.ts +0 -2
  186. package/lib/projects/project-uploader.d.ts +0 -1
  187. package/lib/types/allUploader.d.ts +0 -1
  188. package/lib/types/allUploader.js +0 -24
  189. package/lib/types/interfaces.d.ts +0 -55
  190. package/lib/types/interfaces.js +0 -1
  191. package/lib/types/option-set-hierarchy-exporter.d.ts +0 -1
  192. package/lib/types/option-set-hierarchy-parser.d.ts +0 -2
  193. package/lib/types/option-set-hierarchy-uploader.d.ts +0 -1
  194. package/lib/types/option-set-merger.d.ts +0 -1
  195. package/lib/types/option-set-parser.d.ts +0 -3
  196. package/lib/types/option-set-parser.js +0 -140
  197. package/lib/types/option-set-uploader.d.ts +0 -1
  198. package/lib/types/parse-types.d.ts +0 -4
  199. package/lib/types/parse-types.js +0 -189
  200. package/lib/types/rule-set-uploader.d.ts +0 -1
  201. package/lib/types/type-property-policy-uploader.d.ts +0 -1
  202. package/lib/types/types-properties-merger.d.ts +0 -1
  203. package/lib/types/types-properties-merger.js +0 -75
  204. package/lib/types/usage-info-uploader.d.ts +0 -1
  205. package/lib/users/user-exporter.d.ts +0 -1
  206. package/lib/users/user-exporter.js +0 -41
  207. package/lib/users/user-uploader.d.ts +0 -1
  208. package/lib/users/user-uploader.js +0 -45
  209. package/lib/workflow-template-definitions/workflow-template-definition-commands.d.ts +0 -2
  210. package/lib/workflow-template-definitions/workflow-template-definition-commands.js +0 -10
  211. package/lib/workflow-templates/local-workflow-template-deployer.js +0 -102
  212. package/lib/workflow-templates/workflow-template-commands.d.ts +0 -4
  213. package/lib/workflow-templates/workflow-template-commands.js +0 -51
  214. package/lib/workflow-templates/workflow-template-deployer.d.ts +0 -4
  215. package/lib/workflow-templates/workflow-template-deployer.js +0 -26
  216. package/publish.bat +0 -5
  217. package/publish.sh +0 -5
  218. package/src/api/apps.ts +0 -97
  219. package/src/api/event-workflow-action-definition.ts +0 -8
  220. package/src/api/event-workflow-template-definition.ts +0 -23
  221. package/src/api/event-workflow-templates.ts +0 -29
  222. package/src/apps/create-app/create.ts +0 -74
  223. package/src/apps/create-app/setup-template.ts +0 -38
  224. package/src/apps/deploy-app/actions-deployer.ts +0 -140
  225. package/src/apps/deploy-app/app-deployer.ts +0 -105
  226. package/src/apps/deploy-app/app-template-parsers.ts +0 -44
  227. package/src/apps/deploy-app/deploy.ts +0 -66
  228. package/src/apps/install-app/app-installer.ts +0 -126
  229. package/src/apps/upgrade-app/app-upgrader.ts +0 -132
  230. package/src/auth/auth.ts +0 -10
  231. package/src/auth/login.ts +0 -155
  232. package/src/cli.ts +0 -540
  233. package/src/colors/color-loader.ts +0 -112
  234. package/src/colors/colors.csv +0 -866
  235. package/src/common.ts +0 -5
  236. package/src/config/config.ts +0 -74
  237. package/src/config/configCommands.ts +0 -38
  238. package/src/interfaces.ts +0 -200
  239. package/src/loader-process/loader-process.ts +0 -152
  240. package/src/projects/interfaces.ts +0 -73
  241. package/src/projects/project-exporter.ts +0 -225
  242. package/src/projects/project-uploader.ts +0 -131
  243. package/src/types/allUploader.ts +0 -28
  244. package/src/types/csv-parser.ts +0 -59
  245. package/src/types/interfaces.ts +0 -58
  246. package/src/types/option-set-hierarchy-exporter.ts +0 -125
  247. package/src/types/option-set-hierarchy-parser.ts +0 -169
  248. package/src/types/option-set-hierarchy-uploader.ts +0 -122
  249. package/src/types/option-set-merger.ts +0 -124
  250. package/src/types/option-set-parser.ts +0 -166
  251. package/src/types/option-set-uploader.ts +0 -108
  252. package/src/types/parse-types.ts +0 -227
  253. package/src/types/rule-set-uploader.ts +0 -187
  254. package/src/types/type-property-policy-uploader.ts +0 -192
  255. package/src/types/types-extractor.ts +0 -369
  256. package/src/types/types-properties-merger.ts +0 -90
  257. package/src/types/types-uploader.ts +0 -271
  258. package/src/types/usage-info-uploader.ts +0 -139
  259. package/src/users/user-exporter.ts +0 -52
  260. package/src/users/user-uploader.ts +0 -58
  261. package/src/workflow-template-definitions/workflow-template-definition-commands.ts +0 -13
  262. package/src/workflow-template-definitions/workflow-template-definition-deployer.ts +0 -184
  263. package/src/workflow-templates/local-workflow-template-deployer.ts +0 -126
  264. package/src/workflow-templates/workflow-template-commands.ts +0 -59
  265. package/src/workflow-templates/workflow-template-deployer.ts +0 -30
  266. package/templates/javascript/actions/example/action.js +0 -38
  267. package/templates/javascript/app.yml +0 -53
  268. package/templates/javascript/package.json +0 -23
  269. package/templates/typescript/package-lock.json +0 -14
  270. package/tsconfig.json +0 -32
@@ -0,0 +1,821 @@
1
+ {
2
+ "version": "2.0.1",
3
+ "commands": {
4
+ "app:create": {
5
+ "id": "app:create",
6
+ "description": "Create an app from a template",
7
+ "strict": true,
8
+ "pluginName": "@contrail/cli",
9
+ "pluginAlias": "@contrail/cli",
10
+ "pluginType": "core",
11
+ "aliases": [],
12
+ "examples": [
13
+ "$ contrail app create\n"
14
+ ],
15
+ "flags": {},
16
+ "args": {}
17
+ },
18
+ "app:delete": {
19
+ "id": "app:delete",
20
+ "description": "Delete the app from the app marketplace",
21
+ "strict": true,
22
+ "pluginName": "@contrail/cli",
23
+ "pluginAlias": "@contrail/cli",
24
+ "pluginType": "core",
25
+ "aliases": [],
26
+ "examples": [
27
+ "$ contrail app delete\n"
28
+ ],
29
+ "flags": {},
30
+ "args": {}
31
+ },
32
+ "app:install": {
33
+ "id": "app:install",
34
+ "description": "Install an app from the marketplace",
35
+ "strict": true,
36
+ "pluginName": "@contrail/cli",
37
+ "pluginAlias": "@contrail/cli",
38
+ "pluginType": "core",
39
+ "aliases": [],
40
+ "examples": [
41
+ "$ contrail app install --appIdentifier @VibeIQ/Flex-PLM-Connector\n"
42
+ ],
43
+ "flags": {
44
+ "appIdentifier": {
45
+ "name": "appIdentifier",
46
+ "type": "option",
47
+ "char": "i",
48
+ "description": "The identifier of the app to install",
49
+ "required": false,
50
+ "multiple": false
51
+ },
52
+ "installWorkflowTemplates": {
53
+ "name": "installWorkflowTemplates",
54
+ "type": "boolean",
55
+ "char": "w",
56
+ "description": "Install the app's accompanying workflows",
57
+ "required": false,
58
+ "allowNo": false
59
+ }
60
+ },
61
+ "args": {}
62
+ },
63
+ "app:publish": {
64
+ "id": "app:publish",
65
+ "description": "Publish the app",
66
+ "strict": true,
67
+ "pluginName": "@contrail/cli",
68
+ "pluginAlias": "@contrail/cli",
69
+ "pluginType": "core",
70
+ "aliases": [],
71
+ "examples": [
72
+ "$ contrail app publish\n"
73
+ ],
74
+ "flags": {},
75
+ "args": {}
76
+ },
77
+ "app:uninstall": {
78
+ "id": "app:uninstall",
79
+ "description": "Uninstall an app that is currently installed",
80
+ "strict": true,
81
+ "pluginName": "@contrail/cli",
82
+ "pluginAlias": "@contrail/cli",
83
+ "pluginType": "core",
84
+ "aliases": [],
85
+ "examples": [
86
+ "$ contrail app uninstall --name @vibeiq/flexplm-connector\n"
87
+ ],
88
+ "flags": {
89
+ "appIdentifier": {
90
+ "name": "appIdentifier",
91
+ "type": "option",
92
+ "char": "n",
93
+ "description": "The identifier of the app to install. The identifier can be found on the app's page in the marketplace.",
94
+ "required": false,
95
+ "multiple": false
96
+ }
97
+ },
98
+ "args": {}
99
+ },
100
+ "app:upgrade": {
101
+ "id": "app:upgrade",
102
+ "description": "Upgrade an installed app",
103
+ "strict": true,
104
+ "pluginName": "@contrail/cli",
105
+ "pluginAlias": "@contrail/cli",
106
+ "pluginType": "core",
107
+ "aliases": [],
108
+ "examples": [
109
+ "$ contrail app upgrade --appIdentifier @VibeIQ/Flex-PLM-Connector --latest\n"
110
+ ],
111
+ "flags": {
112
+ "appIdentifier": {
113
+ "name": "appIdentifier",
114
+ "type": "option",
115
+ "char": "i",
116
+ "description": "The appIdentifier of the app to install",
117
+ "required": false,
118
+ "multiple": false
119
+ },
120
+ "latest": {
121
+ "name": "latest",
122
+ "type": "boolean",
123
+ "char": "l",
124
+ "description": "Upgrade to the latest version of the app",
125
+ "required": false,
126
+ "allowNo": false
127
+ }
128
+ },
129
+ "args": {}
130
+ },
131
+ "colors:deleteAll": {
132
+ "id": "colors:deleteAll",
133
+ "description": "Say hello",
134
+ "strict": true,
135
+ "pluginName": "@contrail/cli",
136
+ "pluginAlias": "@contrail/cli",
137
+ "pluginType": "core",
138
+ "aliases": [],
139
+ "examples": [
140
+ "$ contrail colors deleteAll\n"
141
+ ],
142
+ "flags": {},
143
+ "args": {}
144
+ },
145
+ "colors:load": {
146
+ "id": "colors:load",
147
+ "description": "Say hello",
148
+ "strict": true,
149
+ "pluginName": "@contrail/cli",
150
+ "pluginAlias": "@contrail/cli",
151
+ "pluginType": "core",
152
+ "aliases": [],
153
+ "examples": [
154
+ "$ contrail colors load\n"
155
+ ],
156
+ "flags": {},
157
+ "args": {}
158
+ },
159
+ "config:list": {
160
+ "id": "config:list",
161
+ "description": "List the configurations",
162
+ "strict": true,
163
+ "pluginName": "@contrail/cli",
164
+ "pluginAlias": "@contrail/cli",
165
+ "pluginType": "core",
166
+ "aliases": [],
167
+ "examples": [
168
+ "$ contrail config list\n"
169
+ ],
170
+ "flags": {},
171
+ "args": {}
172
+ },
173
+ "config:remove": {
174
+ "id": "config:remove",
175
+ "description": "Remove a variable from the configuration",
176
+ "strict": false,
177
+ "pluginName": "@contrail/cli",
178
+ "pluginAlias": "@contrail/cli",
179
+ "pluginType": "core",
180
+ "aliases": [],
181
+ "examples": [
182
+ "$ contrail config remove --orgId\n"
183
+ ],
184
+ "flags": {
185
+ "orgSlug": {
186
+ "name": "orgSlug",
187
+ "type": "boolean",
188
+ "description": "The org slug",
189
+ "required": false,
190
+ "allowNo": false
191
+ },
192
+ "apiGateway": {
193
+ "name": "apiGateway",
194
+ "type": "boolean",
195
+ "description": "The API Gateway",
196
+ "required": false,
197
+ "allowNo": false
198
+ },
199
+ "orgId": {
200
+ "name": "orgId",
201
+ "type": "boolean",
202
+ "description": "The org Id",
203
+ "required": false,
204
+ "allowNo": false
205
+ },
206
+ "apiUserToken": {
207
+ "name": "apiUserToken",
208
+ "type": "boolean",
209
+ "description": "The API User Token",
210
+ "required": false,
211
+ "allowNo": false
212
+ }
213
+ },
214
+ "args": {}
215
+ },
216
+ "config:set": {
217
+ "id": "config:set",
218
+ "description": "Set a variable in the configuration",
219
+ "strict": true,
220
+ "pluginName": "@contrail/cli",
221
+ "pluginAlias": "@contrail/cli",
222
+ "pluginType": "core",
223
+ "aliases": [],
224
+ "examples": [
225
+ "$ contrail config set --orgId 1234\n"
226
+ ],
227
+ "flags": {
228
+ "orgSlug": {
229
+ "name": "orgSlug",
230
+ "type": "option",
231
+ "description": "The org slug",
232
+ "required": false,
233
+ "multiple": false
234
+ },
235
+ "apiGateway": {
236
+ "name": "apiGateway",
237
+ "type": "option",
238
+ "description": "The API Gateway",
239
+ "required": false,
240
+ "multiple": false
241
+ },
242
+ "orgId": {
243
+ "name": "orgId",
244
+ "type": "option",
245
+ "description": "The org Id",
246
+ "required": false,
247
+ "multiple": false
248
+ },
249
+ "apiUserToken": {
250
+ "name": "apiUserToken",
251
+ "type": "option",
252
+ "description": "The API User Token",
253
+ "required": false,
254
+ "multiple": false
255
+ }
256
+ },
257
+ "args": {}
258
+ },
259
+ "loader-process:load": {
260
+ "id": "loader-process:load",
261
+ "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.",
262
+ "strict": true,
263
+ "pluginName": "@contrail/cli",
264
+ "pluginAlias": "@contrail/cli",
265
+ "pluginType": "core",
266
+ "aliases": [],
267
+ "examples": [
268
+ "$ contrail load-processor load\n"
269
+ ],
270
+ "flags": {},
271
+ "args": {
272
+ "configFileName": {
273
+ "name": "configFileName",
274
+ "description": "The configuration file location",
275
+ "required": true
276
+ }
277
+ }
278
+ },
279
+ "loader-process:upload-and-load": {
280
+ "id": "loader-process:upload-and-load",
281
+ "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",
282
+ "strict": true,
283
+ "pluginName": "@contrail/cli",
284
+ "pluginAlias": "@contrail/cli",
285
+ "pluginType": "core",
286
+ "aliases": [],
287
+ "examples": [
288
+ "$ contrail load-processor upload-and-load <File Path> <Config Path>\n"
289
+ ],
290
+ "flags": {},
291
+ "args": {
292
+ "incomingFile": {
293
+ "name": "incomingFile",
294
+ "description": "The incoming file location",
295
+ "required": true
296
+ },
297
+ "configFileName": {
298
+ "name": "configFileName",
299
+ "description": "The configuration file location",
300
+ "required": true
301
+ }
302
+ }
303
+ },
304
+ "projects:export": {
305
+ "id": "projects:export",
306
+ "description": "Export a project.",
307
+ "strict": true,
308
+ "pluginName": "@contrail/cli",
309
+ "pluginAlias": "@contrail/cli",
310
+ "pluginType": "core",
311
+ "aliases": [],
312
+ "examples": [
313
+ "$ contrail project export <PROJECT_NAME>\n"
314
+ ],
315
+ "flags": {},
316
+ "args": {
317
+ "projectName": {
318
+ "name": "projectName",
319
+ "description": "",
320
+ "required": true
321
+ }
322
+ }
323
+ },
324
+ "projects:list": {
325
+ "id": "projects:list",
326
+ "description": "Get a list of all projects.",
327
+ "strict": true,
328
+ "pluginName": "@contrail/cli",
329
+ "pluginAlias": "@contrail/cli",
330
+ "pluginType": "core",
331
+ "aliases": [],
332
+ "examples": [
333
+ "$ contrail project list\n"
334
+ ],
335
+ "flags": {},
336
+ "args": {}
337
+ },
338
+ "projects:load": {
339
+ "id": "projects:load",
340
+ "description": "Configure a project from a yml file.",
341
+ "strict": true,
342
+ "pluginName": "@contrail/cli",
343
+ "pluginAlias": "@contrail/cli",
344
+ "pluginType": "core",
345
+ "aliases": [],
346
+ "examples": [
347
+ "$ contrail project load <TEMPLATE_FILE_LOCATION>\n"
348
+ ],
349
+ "flags": {},
350
+ "args": {
351
+ "templateFileLocation": {
352
+ "name": "templateFileLocation",
353
+ "description": "The location to the template file",
354
+ "required": true
355
+ }
356
+ }
357
+ },
358
+ "types:exportOptionSetHierarchies": {
359
+ "id": "types:exportOptionSetHierarchies",
360
+ "description": "export OptionSetHierarchies into CSVs.",
361
+ "strict": true,
362
+ "pluginName": "@contrail/cli",
363
+ "pluginAlias": "@contrail/cli",
364
+ "pluginType": "core",
365
+ "aliases": [],
366
+ "examples": [
367
+ "$ contrail types exportOptionSetsHierarchies\n"
368
+ ],
369
+ "flags": {},
370
+ "args": {}
371
+ },
372
+ "types:getAll": {
373
+ "id": "types:getAll",
374
+ "description": "Get all Types and associated data for your Org",
375
+ "strict": true,
376
+ "pluginName": "@contrail/cli",
377
+ "pluginAlias": "@contrail/cli",
378
+ "pluginType": "core",
379
+ "aliases": [],
380
+ "examples": [
381
+ "$ contrail types getAll\n"
382
+ ],
383
+ "flags": {},
384
+ "args": {}
385
+ },
386
+ "types:loadAll": {
387
+ "id": "types:loadAll",
388
+ "description": "Get all Types and associated data for your Org",
389
+ "strict": true,
390
+ "pluginName": "@contrail/cli",
391
+ "pluginAlias": "@contrail/cli",
392
+ "pluginType": "core",
393
+ "aliases": [],
394
+ "examples": [
395
+ "$ contrail types getAll\n"
396
+ ],
397
+ "flags": {},
398
+ "args": {}
399
+ },
400
+ "types:mergeOptionSets": {
401
+ "id": "types:mergeOptionSets",
402
+ "description": "Merge the OptionSets from an existing org and the OptionSets passed in. OptionSets File must be .yml.",
403
+ "strict": true,
404
+ "pluginName": "@contrail/cli",
405
+ "pluginAlias": "@contrail/cli",
406
+ "pluginType": "core",
407
+ "aliases": [],
408
+ "examples": [
409
+ "$ contrail types mergeOptionSets <File Path>\n"
410
+ ],
411
+ "flags": {},
412
+ "args": {
413
+ "file": {
414
+ "name": "file",
415
+ "description": "File to merge with the cloud option sets",
416
+ "required": true
417
+ }
418
+ }
419
+ },
420
+ "types:mergeTypeProperties": {
421
+ "id": "types:mergeTypeProperties",
422
+ "description": "Merge the TypeProperties from an existing org and the TypeProperties passed in. Add to Types via TypePath File must be .yml",
423
+ "strict": false,
424
+ "pluginName": "@contrail/cli",
425
+ "pluginAlias": "@contrail/cli",
426
+ "pluginType": "core",
427
+ "aliases": [],
428
+ "examples": [
429
+ "$ contrail types mergeTypeProperties <File Path> <TypePaths>\n "
430
+ ],
431
+ "flags": {},
432
+ "args": {
433
+ "file": {
434
+ "name": "file",
435
+ "description": "File to parse",
436
+ "required": true
437
+ },
438
+ "typePaths": {
439
+ "name": "typePaths",
440
+ "description": "A list of the type paths to merge",
441
+ "required": true
442
+ }
443
+ }
444
+ },
445
+ "types:parseOptionSetsHierarchyLocalFile": {
446
+ "id": "types:parseOptionSetsHierarchyLocalFile",
447
+ "description": "Parse CSV file into OptionSetHierarchy",
448
+ "strict": true,
449
+ "pluginName": "@contrail/cli",
450
+ "pluginAlias": "@contrail/cli",
451
+ "pluginType": "core",
452
+ "aliases": [],
453
+ "examples": [
454
+ "$ contrail types parseOptionSetsHierarchyLocalFile <File Paths>\n"
455
+ ],
456
+ "flags": {},
457
+ "args": {
458
+ "file": {
459
+ "name": "file",
460
+ "description": "File to parse",
461
+ "required": true
462
+ }
463
+ }
464
+ },
465
+ "types:parseOptionSetsLocalFiles": {
466
+ "id": "types:parseOptionSetsLocalFiles",
467
+ "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\"",
468
+ "strict": true,
469
+ "pluginName": "@contrail/cli",
470
+ "pluginAlias": "@contrail/cli",
471
+ "pluginType": "core",
472
+ "aliases": [],
473
+ "examples": [
474
+ "$ contrail types parseOptionSetsLocalFiles <File Paths> <style>\n"
475
+ ],
476
+ "flags": {
477
+ "csvStyle": {
478
+ "name": "csvStyle",
479
+ "type": "option",
480
+ "required": true,
481
+ "multiple": false,
482
+ "options": [
483
+ "NameAndLabel",
484
+ "LabelsInColumn"
485
+ ]
486
+ }
487
+ },
488
+ "args": {
489
+ "file": {
490
+ "name": "file",
491
+ "description": "File to parse",
492
+ "required": true
493
+ }
494
+ }
495
+ },
496
+ "types:parseOptionSetsToFolderStructure": {
497
+ "id": "types:parseOptionSetsToFolderStructure",
498
+ "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\"",
499
+ "strict": true,
500
+ "pluginName": "@contrail/cli",
501
+ "pluginAlias": "@contrail/cli",
502
+ "pluginType": "core",
503
+ "aliases": [],
504
+ "examples": [
505
+ "$ contrail types parseOptionSetsLocalFiles <File Paths> <style>\n"
506
+ ],
507
+ "flags": {},
508
+ "args": {
509
+ "file": {
510
+ "name": "file",
511
+ "description": "File to parse",
512
+ "required": true
513
+ }
514
+ }
515
+ },
516
+ "types:parseTypesFromFiles": {
517
+ "id": "types:parseTypesFromFiles",
518
+ "description": "Parse CSV files into Types and OptionSets from VibeIQ Files.\n File must be .yml.",
519
+ "strict": false,
520
+ "pluginName": "@contrail/cli",
521
+ "pluginAlias": "@contrail/cli",
522
+ "pluginType": "core",
523
+ "aliases": [],
524
+ "examples": [
525
+ "$ contrail types parseTypesFromFiles <fileIds>\n "
526
+ ],
527
+ "flags": {},
528
+ "args": {
529
+ "typePaths": {
530
+ "name": "typePaths",
531
+ "description": "A list of the VibeIQ file IDs to parse",
532
+ "required": true
533
+ }
534
+ }
535
+ },
536
+ "types:parseTypesFromLocalFiles": {
537
+ "id": "types:parseTypesFromLocalFiles",
538
+ "description": "Parse CSV files into Types and OptionSets from local files.",
539
+ "strict": false,
540
+ "pluginName": "@contrail/cli",
541
+ "pluginAlias": "@contrail/cli",
542
+ "pluginType": "core",
543
+ "aliases": [],
544
+ "examples": [
545
+ "$ contrail types parseTypesFromLocalFiles <File Paths>\n "
546
+ ],
547
+ "flags": {},
548
+ "args": {
549
+ "typePaths": {
550
+ "name": "typePaths",
551
+ "description": "A list of the files to parse",
552
+ "required": true
553
+ }
554
+ }
555
+ },
556
+ "types:parseTypesFromTemplateAndDataFromLocalFiles": {
557
+ "id": "types:parseTypesFromTemplateAndDataFromLocalFiles",
558
+ "description": "Parse CSV files into Types and OptionSets from local type template files.",
559
+ "strict": false,
560
+ "pluginName": "@contrail/cli",
561
+ "pluginAlias": "@contrail/cli",
562
+ "pluginType": "core",
563
+ "aliases": [],
564
+ "examples": [
565
+ "$ contrail types parseTypesFromTemplateAndDataFromLocalFiles <Template Path> <File Paths>\n "
566
+ ],
567
+ "flags": {},
568
+ "args": {
569
+ "templateFile": {
570
+ "name": "templateFile",
571
+ "description": "The template file to use",
572
+ "required": true
573
+ },
574
+ "filePaths": {
575
+ "name": "filePaths",
576
+ "description": "A list of data file to use",
577
+ "required": true
578
+ }
579
+ }
580
+ },
581
+ "types:parseTypesFromTemplateFromLocalFiles": {
582
+ "id": "types:parseTypesFromTemplateFromLocalFiles",
583
+ "description": "Parse CSV files into Types and OptionSets from local type template files.",
584
+ "strict": true,
585
+ "pluginName": "@contrail/cli",
586
+ "pluginAlias": "@contrail/cli",
587
+ "pluginType": "core",
588
+ "aliases": [],
589
+ "examples": [
590
+ "$ contrail types parseTypesFromTemplateFromLocalFiles <Template File> <Data File>\n "
591
+ ],
592
+ "flags": {},
593
+ "args": {
594
+ "templateFile": {
595
+ "name": "templateFile",
596
+ "description": "The template file to use",
597
+ "required": true
598
+ },
599
+ "filePath": {
600
+ "name": "filePath",
601
+ "description": "The data file to use",
602
+ "required": true
603
+ }
604
+ }
605
+ },
606
+ "types:uploadOptionSetHierarchies": {
607
+ "id": "types:uploadOptionSetHierarchies",
608
+ "description": "Upload OptionSets for your Org. OptionSets are loaded from .yml files in the option-sets directory.",
609
+ "strict": true,
610
+ "pluginName": "@contrail/cli",
611
+ "pluginAlias": "@contrail/cli",
612
+ "pluginType": "core",
613
+ "aliases": [],
614
+ "examples": [
615
+ "$ contrail types uploadOptionSetHierarchies\n"
616
+ ],
617
+ "flags": {},
618
+ "args": {}
619
+ },
620
+ "types:uploadOptionSets": {
621
+ "id": "types:uploadOptionSets",
622
+ "description": "Upload OptionSets for your Org. OptionSets are loaded from .yml files in the option-sets directory.",
623
+ "strict": true,
624
+ "pluginName": "@contrail/cli",
625
+ "pluginAlias": "@contrail/cli",
626
+ "pluginType": "core",
627
+ "aliases": [],
628
+ "examples": [
629
+ "$ contrail types uploadOptionSets\n"
630
+ ],
631
+ "flags": {},
632
+ "args": {}
633
+ },
634
+ "types:uploadOptionSetsHierarchyLocalFile": {
635
+ "id": "types:uploadOptionSetsHierarchyLocalFile",
636
+ "description": "upload CSV file into OptionSetHierarchy",
637
+ "strict": true,
638
+ "pluginName": "@contrail/cli",
639
+ "pluginAlias": "@contrail/cli",
640
+ "pluginType": "core",
641
+ "aliases": [],
642
+ "examples": [
643
+ "$ contrail types uploadOptionSetsHierarchyLocalFile <File Path> <name>\n"
644
+ ],
645
+ "flags": {},
646
+ "args": {
647
+ "file": {
648
+ "name": "file",
649
+ "description": "File to parse",
650
+ "required": true
651
+ },
652
+ "name": {
653
+ "name": "name",
654
+ "description": "The name to be give to the option set hierarchy",
655
+ "required": true
656
+ }
657
+ }
658
+ },
659
+ "types:uploadRuleSets": {
660
+ "id": "types:uploadRuleSets",
661
+ "description": "Upload an extracted rule set",
662
+ "strict": true,
663
+ "pluginName": "@contrail/cli",
664
+ "pluginAlias": "@contrail/cli",
665
+ "pluginType": "core",
666
+ "aliases": [],
667
+ "examples": [
668
+ "$ contrail types uploadRuleSets\n"
669
+ ],
670
+ "flags": {},
671
+ "args": {}
672
+ },
673
+ "types:uploadTypePropertyPolicies": {
674
+ "id": "types:uploadTypePropertyPolicies",
675
+ "description": "Upload type property policies",
676
+ "strict": true,
677
+ "pluginName": "@contrail/cli",
678
+ "pluginAlias": "@contrail/cli",
679
+ "pluginType": "core",
680
+ "aliases": [],
681
+ "examples": [
682
+ "$ contrail types uploadTypePropertyPolicies\n"
683
+ ],
684
+ "flags": {},
685
+ "args": {}
686
+ },
687
+ "types:uploadUsageInfo": {
688
+ "id": "types:uploadUsageInfo",
689
+ "description": "Upload extracted usage info",
690
+ "strict": true,
691
+ "pluginName": "@contrail/cli",
692
+ "pluginAlias": "@contrail/cli",
693
+ "pluginType": "core",
694
+ "aliases": [],
695
+ "examples": [
696
+ "$ contrail types uploadUsageInfo\n"
697
+ ],
698
+ "flags": {},
699
+ "args": {}
700
+ },
701
+ "users:export": {
702
+ "id": "users:export",
703
+ "description": "Export all users in the org.",
704
+ "strict": true,
705
+ "pluginName": "@contrail/cli",
706
+ "pluginAlias": "@contrail/cli",
707
+ "pluginType": "core",
708
+ "aliases": [],
709
+ "examples": [
710
+ "$ contrail users export\n"
711
+ ],
712
+ "flags": {
713
+ "fileOut": {
714
+ "name": "fileOut",
715
+ "type": "option",
716
+ "char": "f",
717
+ "description": "The location for the file to be saved",
718
+ "required": false,
719
+ "multiple": false
720
+ }
721
+ },
722
+ "args": {}
723
+ },
724
+ "users:upload": {
725
+ "id": "users:upload",
726
+ "description": "Import all users in the users.yml file",
727
+ "strict": true,
728
+ "pluginName": "@contrail/cli",
729
+ "pluginAlias": "@contrail/cli",
730
+ "pluginType": "core",
731
+ "aliases": [],
732
+ "examples": [
733
+ "$ contrail users import <USERS_FILE>\n"
734
+ ],
735
+ "flags": {},
736
+ "args": {
737
+ "usersFile": {
738
+ "name": "usersFile",
739
+ "description": "The .yml file containing the users",
740
+ "required": true
741
+ }
742
+ }
743
+ },
744
+ "workflow-template-definitions:install": {
745
+ "id": "workflow-template-definitions:install",
746
+ "description": "Install the template definitions of an app to your org",
747
+ "strict": true,
748
+ "pluginName": "@contrail/cli",
749
+ "pluginAlias": "@contrail/cli",
750
+ "pluginType": "core",
751
+ "aliases": [],
752
+ "examples": [
753
+ "$ contrail workflow-template-definitions install\n"
754
+ ],
755
+ "flags": {},
756
+ "args": {}
757
+ },
758
+ "workflow-template-definitions:list": {
759
+ "id": "workflow-template-definitions:list",
760
+ "description": "Lists the workflow templates in the org",
761
+ "strict": true,
762
+ "pluginName": "@contrail/cli",
763
+ "pluginAlias": "@contrail/cli",
764
+ "pluginType": "core",
765
+ "aliases": [],
766
+ "examples": [
767
+ "$ contrail workflow-template-definitions list\n"
768
+ ],
769
+ "flags": {},
770
+ "args": {}
771
+ },
772
+ "workflow-templates:delete": {
773
+ "id": "workflow-templates:delete",
774
+ "description": "Delete workflow templates from your org",
775
+ "strict": true,
776
+ "pluginName": "@contrail/cli",
777
+ "pluginAlias": "@contrail/cli",
778
+ "pluginType": "core",
779
+ "aliases": [],
780
+ "examples": [
781
+ "$ contrail workflow-template delete\n"
782
+ ],
783
+ "flags": {},
784
+ "args": {}
785
+ },
786
+ "workflow-templates:list": {
787
+ "id": "workflow-templates:list",
788
+ "description": "Lists the workflow templates in the org",
789
+ "strict": true,
790
+ "pluginName": "@contrail/cli",
791
+ "pluginAlias": "@contrail/cli",
792
+ "pluginType": "core",
793
+ "aliases": [],
794
+ "examples": [
795
+ "$ contrail workflow-template list\n"
796
+ ],
797
+ "flags": {},
798
+ "args": {}
799
+ },
800
+ "workflow-templates:load": {
801
+ "id": "workflow-templates:load",
802
+ "description": "Loads your workflow from a local file",
803
+ "strict": true,
804
+ "pluginName": "@contrail/cli",
805
+ "pluginAlias": "@contrail/cli",
806
+ "pluginType": "core",
807
+ "aliases": [],
808
+ "examples": [
809
+ "$ contrail workflow-template load <FILE_LOCATION>\n"
810
+ ],
811
+ "flags": {},
812
+ "args": {
813
+ "fileLocation": {
814
+ "name": "fileLocation",
815
+ "description": "The workflow template file to load",
816
+ "required": true
817
+ }
818
+ }
819
+ }
820
+ }
821
+ }