@contrail/cli 2.0.3 → 2.0.5
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/README.md +330 -187
- package/dist/api/apps.d.ts +1 -1
- package/dist/api/apps.js +2 -1
- package/dist/commands/app/install.d.ts +1 -0
- package/dist/commands/app/install.js +3 -2
- package/dist/commands/groups/export.d.ts +12 -0
- package/dist/commands/groups/export.js +93 -0
- package/dist/commands/groups/upload.d.ts +10 -0
- package/dist/commands/groups/upload.js +166 -0
- package/dist/commands/instance/export.d.ts +10 -0
- package/dist/commands/instance/export.js +24 -0
- package/dist/commands/instance/import.d.ts +9 -0
- package/dist/commands/instance/import.js +23 -0
- package/dist/commands/types/getAll.d.ts +5 -1
- package/dist/commands/types/getAll.js +31 -11
- package/dist/commands/types/loadAll.d.ts +5 -2
- package/dist/commands/types/loadAll.js +17 -13
- package/dist/commands/types/uploadOptionSetHierarchies.d.ts +4 -1
- package/dist/commands/types/uploadOptionSetHierarchies.js +13 -9
- package/dist/commands/types/uploadOptionSets.d.ts +4 -1
- package/dist/commands/types/uploadOptionSets.js +13 -9
- package/dist/commands/types/uploadRuleSets.d.ts +4 -1
- package/dist/commands/types/uploadRuleSets.js +12 -8
- package/dist/commands/types/uploadTypePropertyPolicies.d.ts +4 -1
- package/dist/commands/types/uploadTypePropertyPolicies.js +12 -8
- package/dist/commands/types/uploadUsageInfo.d.ts +4 -1
- package/dist/commands/types/uploadUsageInfo.js +9 -6
- package/dist/commands/users/export.d.ts +4 -1
- package/dist/commands/users/export.js +16 -7
- package/dist/commands/users/upload.d.ts +1 -0
- package/dist/commands/users/upload.js +5 -4
- package/dist/helpers/app/app-deployer.js +2 -0
- package/dist/helpers/file-helpers.d.ts +1 -0
- package/dist/helpers/file-helpers.js +23 -0
- package/dist/helpers/types/type-uploader.d.ts +1 -1
- package/dist/helpers/types/type-uploader.js +8 -8
- package/dist/interfaces.d.ts +1 -0
- package/dist/templates/typescript/app.yml +1 -0
- package/dist/templates/typescript/src/actions/logItem.ts +3 -8
- package/dist/templates/typescript/src/framework/app-config.ts +1 -4
- package/oclif.manifest.json +212 -15
- package/package.json +8 -3
package/README.md
CHANGED
|
@@ -5,84 +5,93 @@ The Contrail CLI is the best way to manage your instance data through a programm
|
|
|
5
5
|
|
|
6
6
|
<!-- toc -->
|
|
7
7
|
* [Usage](#usage)
|
|
8
|
+
* [Autocomplete](#autocomplete)
|
|
8
9
|
* [Commands](#commands)
|
|
9
10
|
<!-- tocstop -->
|
|
10
11
|
# Usage
|
|
11
12
|
<!-- usage -->
|
|
12
13
|
```sh-session
|
|
13
14
|
$ npm install -g @contrail/cli
|
|
14
|
-
$ contrail
|
|
15
|
+
$ contrail COMMAND
|
|
15
16
|
running command...
|
|
16
|
-
$ contrail
|
|
17
|
-
@contrail/cli/2.0.
|
|
18
|
-
$ contrail
|
|
17
|
+
$ contrail (--version)
|
|
18
|
+
@contrail/cli/2.0.5 darwin-arm64 node-v18.13.0
|
|
19
|
+
$ contrail --help [COMMAND]
|
|
19
20
|
USAGE
|
|
20
|
-
$ contrail
|
|
21
|
+
$ contrail COMMAND
|
|
21
22
|
...
|
|
22
23
|
```
|
|
23
24
|
<!-- usagestop -->
|
|
25
|
+
|
|
26
|
+
# Autocomplete
|
|
27
|
+
To get instructions on how to set up autocomplete for your shell, run `contrail autocomplete`.
|
|
24
28
|
# Commands
|
|
25
29
|
<!-- commands -->
|
|
26
|
-
* [`contrail
|
|
27
|
-
* [`contrail
|
|
28
|
-
* [`contrail
|
|
29
|
-
* [`contrail
|
|
30
|
-
* [`contrail
|
|
31
|
-
* [`contrail
|
|
32
|
-
* [`contrail
|
|
33
|
-
* [`contrail
|
|
34
|
-
* [`contrail
|
|
35
|
-
* [`contrail
|
|
36
|
-
* [`contrail
|
|
37
|
-
* [`contrail
|
|
38
|
-
* [`contrail
|
|
39
|
-
* [`contrail
|
|
40
|
-
* [`contrail
|
|
41
|
-
* [`contrail
|
|
42
|
-
* [`contrail
|
|
43
|
-
* [`contrail
|
|
44
|
-
* [`contrail-
|
|
45
|
-
* [`contrail-
|
|
46
|
-
* [`contrail
|
|
47
|
-
* [`contrail
|
|
48
|
-
* [`contrail
|
|
49
|
-
* [`contrail
|
|
50
|
-
* [`contrail
|
|
51
|
-
* [`contrail
|
|
52
|
-
* [`contrail
|
|
53
|
-
* [`contrail
|
|
54
|
-
* [`contrail
|
|
55
|
-
* [`contrail
|
|
56
|
-
* [`contrail
|
|
57
|
-
* [`contrail
|
|
58
|
-
* [`contrail
|
|
59
|
-
* [`contrail
|
|
60
|
-
* [`contrail
|
|
61
|
-
* [`contrail
|
|
62
|
-
* [`contrail
|
|
63
|
-
* [`contrail
|
|
64
|
-
* [`contrail
|
|
65
|
-
* [`contrail
|
|
66
|
-
* [`contrail
|
|
67
|
-
* [`contrail
|
|
68
|
-
* [`contrail
|
|
69
|
-
* [`contrail
|
|
70
|
-
* [`contrail
|
|
71
|
-
* [`contrail
|
|
72
|
-
* [`contrail
|
|
73
|
-
* [`contrail
|
|
74
|
-
* [`contrail
|
|
75
|
-
* [`contrail
|
|
76
|
-
* [`contrail
|
|
77
|
-
* [`contrail
|
|
78
|
-
|
|
79
|
-
|
|
30
|
+
* [`contrail app create`](#contrail-app-create)
|
|
31
|
+
* [`contrail app delete`](#contrail-app-delete)
|
|
32
|
+
* [`contrail app getApiKey`](#contrail-app-getapikey)
|
|
33
|
+
* [`contrail app install`](#contrail-app-install)
|
|
34
|
+
* [`contrail app publish`](#contrail-app-publish)
|
|
35
|
+
* [`contrail app uninstall`](#contrail-app-uninstall)
|
|
36
|
+
* [`contrail app upgrade`](#contrail-app-upgrade)
|
|
37
|
+
* [`contrail autocomplete [SHELL]`](#contrail-autocomplete-shell)
|
|
38
|
+
* [`contrail colors deleteAll`](#contrail-colors-deleteall)
|
|
39
|
+
* [`contrail colors load`](#contrail-colors-load)
|
|
40
|
+
* [`contrail config list`](#contrail-config-list)
|
|
41
|
+
* [`contrail config remove`](#contrail-config-remove)
|
|
42
|
+
* [`contrail config set`](#contrail-config-set)
|
|
43
|
+
* [`contrail groups export`](#contrail-groups-export)
|
|
44
|
+
* [`contrail groups upload GROUPSFILE`](#contrail-groups-upload-groupsfile)
|
|
45
|
+
* [`contrail help [COMMANDS]`](#contrail-help-commands)
|
|
46
|
+
* [`contrail instance export`](#contrail-instance-export)
|
|
47
|
+
* [`contrail instance import`](#contrail-instance-import)
|
|
48
|
+
* [`contrail loader-process load CONFIGFILENAME`](#contrail-loader-process-load-configfilename)
|
|
49
|
+
* [`contrail loader-process upload-and-load INCOMINGFILE CONFIGFILENAME`](#contrail-loader-process-upload-and-load-incomingfile-configfilename)
|
|
50
|
+
* [`contrail plugins`](#contrail-plugins)
|
|
51
|
+
* [`contrail plugins:install PLUGIN...`](#contrail-pluginsinstall-plugin)
|
|
52
|
+
* [`contrail plugins:inspect PLUGIN...`](#contrail-pluginsinspect-plugin)
|
|
53
|
+
* [`contrail plugins:install PLUGIN...`](#contrail-pluginsinstall-plugin-1)
|
|
54
|
+
* [`contrail plugins:link PLUGIN`](#contrail-pluginslink-plugin)
|
|
55
|
+
* [`contrail plugins:uninstall PLUGIN...`](#contrail-pluginsuninstall-plugin)
|
|
56
|
+
* [`contrail plugins:uninstall PLUGIN...`](#contrail-pluginsuninstall-plugin-1)
|
|
57
|
+
* [`contrail plugins:uninstall PLUGIN...`](#contrail-pluginsuninstall-plugin-2)
|
|
58
|
+
* [`contrail plugins update`](#contrail-plugins-update)
|
|
59
|
+
* [`contrail projects export PROJECTNAME`](#contrail-projects-export-projectname)
|
|
60
|
+
* [`contrail projects list`](#contrail-projects-list)
|
|
61
|
+
* [`contrail projects load TEMPLATEFILELOCATION`](#contrail-projects-load-templatefilelocation)
|
|
62
|
+
* [`contrail types exportOptionSetHierarchies`](#contrail-types-exportoptionsethierarchies)
|
|
63
|
+
* [`contrail types getAll`](#contrail-types-getall)
|
|
64
|
+
* [`contrail types loadAll`](#contrail-types-loadall)
|
|
65
|
+
* [`contrail types mergeOptionSets FILE`](#contrail-types-mergeoptionsets-file)
|
|
66
|
+
* [`contrail types mergeTypeProperties FILE TYPEPATHS`](#contrail-types-mergetypeproperties-file-typepaths)
|
|
67
|
+
* [`contrail types parseOptionSetsHierarchyLocalFile FILE`](#contrail-types-parseoptionsetshierarchylocalfile-file)
|
|
68
|
+
* [`contrail types parseOptionSetsLocalFiles FILE`](#contrail-types-parseoptionsetslocalfiles-file)
|
|
69
|
+
* [`contrail types parseOptionSetsToFolderStructure FILE`](#contrail-types-parseoptionsetstofolderstructure-file)
|
|
70
|
+
* [`contrail types parseTypesFromFiles TYPEPATHS`](#contrail-types-parsetypesfromfiles-typepaths)
|
|
71
|
+
* [`contrail types parseTypesFromLocalFiles TYPEPATHS`](#contrail-types-parsetypesfromlocalfiles-typepaths)
|
|
72
|
+
* [`contrail types parseTypesFromTemplateAndDataFromLocalFiles TEMPLATEFILE FILEPATHS`](#contrail-types-parsetypesfromtemplateanddatafromlocalfiles-templatefile-filepaths)
|
|
73
|
+
* [`contrail types parseTypesFromTemplateFromLocalFiles TEMPLATEFILE FILEPATH`](#contrail-types-parsetypesfromtemplatefromlocalfiles-templatefile-filepath)
|
|
74
|
+
* [`contrail types uploadOptionSetHierarchies`](#contrail-types-uploadoptionsethierarchies)
|
|
75
|
+
* [`contrail types uploadOptionSets`](#contrail-types-uploadoptionsets)
|
|
76
|
+
* [`contrail types uploadOptionSetsHierarchyLocalFile FILE NAME`](#contrail-types-uploadoptionsetshierarchylocalfile-file-name)
|
|
77
|
+
* [`contrail types uploadRuleSets`](#contrail-types-uploadrulesets)
|
|
78
|
+
* [`contrail types uploadTypePropertyPolicies`](#contrail-types-uploadtypepropertypolicies)
|
|
79
|
+
* [`contrail types uploadUsageInfo`](#contrail-types-uploadusageinfo)
|
|
80
|
+
* [`contrail users export`](#contrail-users-export)
|
|
81
|
+
* [`contrail users upload USERSFILE`](#contrail-users-upload-usersfile)
|
|
82
|
+
* [`contrail workflow-template-definitions install`](#contrail-workflow-template-definitions-install)
|
|
83
|
+
* [`contrail workflow-template-definitions list`](#contrail-workflow-template-definitions-list)
|
|
84
|
+
* [`contrail workflow-templates delete`](#contrail-workflow-templates-delete)
|
|
85
|
+
* [`contrail workflow-templates list`](#contrail-workflow-templates-list)
|
|
86
|
+
* [`contrail workflow-templates load FILELOCATION`](#contrail-workflow-templates-load-filelocation)
|
|
87
|
+
|
|
88
|
+
## `contrail app create`
|
|
80
89
|
|
|
81
90
|
Create an app from a template
|
|
82
91
|
|
|
83
92
|
```
|
|
84
93
|
USAGE
|
|
85
|
-
$ contrail
|
|
94
|
+
$ contrail app create
|
|
86
95
|
|
|
87
96
|
DESCRIPTION
|
|
88
97
|
Create an app from a template
|
|
@@ -91,13 +100,13 @@ EXAMPLES
|
|
|
91
100
|
$ contrail app create
|
|
92
101
|
```
|
|
93
102
|
|
|
94
|
-
## `contrail
|
|
103
|
+
## `contrail app delete`
|
|
95
104
|
|
|
96
105
|
Delete the app from the app marketplace
|
|
97
106
|
|
|
98
107
|
```
|
|
99
108
|
USAGE
|
|
100
|
-
$ contrail
|
|
109
|
+
$ contrail app delete
|
|
101
110
|
|
|
102
111
|
DESCRIPTION
|
|
103
112
|
Delete the app from the app marketplace
|
|
@@ -106,13 +115,13 @@ EXAMPLES
|
|
|
106
115
|
$ contrail app delete
|
|
107
116
|
```
|
|
108
117
|
|
|
109
|
-
## `contrail
|
|
118
|
+
## `contrail app getApiKey`
|
|
110
119
|
|
|
111
120
|
Get an api key for an app
|
|
112
121
|
|
|
113
122
|
```
|
|
114
123
|
USAGE
|
|
115
|
-
$ contrail
|
|
124
|
+
$ contrail app getApiKey [--appIdentifier <value>]
|
|
116
125
|
|
|
117
126
|
FLAGS
|
|
118
127
|
--appIdentifier=<value> The app identifier
|
|
@@ -124,15 +133,16 @@ EXAMPLES
|
|
|
124
133
|
$ contrail app getApiKey
|
|
125
134
|
```
|
|
126
135
|
|
|
127
|
-
## `contrail
|
|
136
|
+
## `contrail app install`
|
|
128
137
|
|
|
129
138
|
Install an app from the marketplace
|
|
130
139
|
|
|
131
140
|
```
|
|
132
141
|
USAGE
|
|
133
|
-
$ contrail
|
|
142
|
+
$ contrail app install [-i <value>] [-w] [-h]
|
|
134
143
|
|
|
135
144
|
FLAGS
|
|
145
|
+
-h, --showHidden Show the option to install public but hidden apps
|
|
136
146
|
-i, --appIdentifier=<value> The identifier of the app to install
|
|
137
147
|
-w, --installWorkflowTemplates Install the app's accompanying workflows
|
|
138
148
|
|
|
@@ -143,13 +153,13 @@ EXAMPLES
|
|
|
143
153
|
$ contrail app install --appIdentifier @VibeIQ/Flex-PLM-Connector
|
|
144
154
|
```
|
|
145
155
|
|
|
146
|
-
## `contrail
|
|
156
|
+
## `contrail app publish`
|
|
147
157
|
|
|
148
158
|
Publish the app
|
|
149
159
|
|
|
150
160
|
```
|
|
151
161
|
USAGE
|
|
152
|
-
$ contrail
|
|
162
|
+
$ contrail app publish [-u]
|
|
153
163
|
|
|
154
164
|
FLAGS
|
|
155
165
|
-u, --upgrade In addition to deploying, upgrade the installed version of the app in this org to the latest one.
|
|
@@ -161,13 +171,13 @@ EXAMPLES
|
|
|
161
171
|
$ contrail app publish
|
|
162
172
|
```
|
|
163
173
|
|
|
164
|
-
## `contrail
|
|
174
|
+
## `contrail app uninstall`
|
|
165
175
|
|
|
166
176
|
Uninstall an app that is currently installed
|
|
167
177
|
|
|
168
178
|
```
|
|
169
179
|
USAGE
|
|
170
|
-
$ contrail
|
|
180
|
+
$ contrail app uninstall [-n <value>]
|
|
171
181
|
|
|
172
182
|
FLAGS
|
|
173
183
|
-n, --appIdentifier=<value> The identifier of the app to install. The identifier can be found on the app's page in
|
|
@@ -180,13 +190,13 @@ EXAMPLES
|
|
|
180
190
|
$ contrail app uninstall --name @vibeiq/flexplm-connector
|
|
181
191
|
```
|
|
182
192
|
|
|
183
|
-
## `contrail
|
|
193
|
+
## `contrail app upgrade`
|
|
184
194
|
|
|
185
195
|
Upgrade an installed app
|
|
186
196
|
|
|
187
197
|
```
|
|
188
198
|
USAGE
|
|
189
|
-
$ contrail
|
|
199
|
+
$ contrail app upgrade [-i <value>] [-l]
|
|
190
200
|
|
|
191
201
|
FLAGS
|
|
192
202
|
-i, --appIdentifier=<value> The appIdentifier of the app to install
|
|
@@ -199,13 +209,42 @@ EXAMPLES
|
|
|
199
209
|
$ contrail app upgrade --appIdentifier @VibeIQ/Flex-PLM-Connector --latest
|
|
200
210
|
```
|
|
201
211
|
|
|
202
|
-
## `contrail
|
|
212
|
+
## `contrail autocomplete [SHELL]`
|
|
213
|
+
|
|
214
|
+
display autocomplete installation instructions
|
|
215
|
+
|
|
216
|
+
```
|
|
217
|
+
USAGE
|
|
218
|
+
$ contrail autocomplete [SHELL] [-r]
|
|
219
|
+
|
|
220
|
+
ARGUMENTS
|
|
221
|
+
SHELL shell type
|
|
222
|
+
|
|
223
|
+
FLAGS
|
|
224
|
+
-r, --refresh-cache Refresh cache (ignores displaying instructions)
|
|
225
|
+
|
|
226
|
+
DESCRIPTION
|
|
227
|
+
display autocomplete installation instructions
|
|
228
|
+
|
|
229
|
+
EXAMPLES
|
|
230
|
+
$ contrail autocomplete
|
|
231
|
+
|
|
232
|
+
$ contrail autocomplete bash
|
|
233
|
+
|
|
234
|
+
$ contrail autocomplete zsh
|
|
235
|
+
|
|
236
|
+
$ contrail autocomplete --refresh-cache
|
|
237
|
+
```
|
|
238
|
+
|
|
239
|
+
_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v2.1.4/src/commands/autocomplete/index.ts)_
|
|
240
|
+
|
|
241
|
+
## `contrail colors deleteAll`
|
|
203
242
|
|
|
204
243
|
Say hello
|
|
205
244
|
|
|
206
245
|
```
|
|
207
246
|
USAGE
|
|
208
|
-
$ contrail
|
|
247
|
+
$ contrail colors deleteAll
|
|
209
248
|
|
|
210
249
|
DESCRIPTION
|
|
211
250
|
Say hello
|
|
@@ -214,13 +253,13 @@ EXAMPLES
|
|
|
214
253
|
$ contrail colors deleteAll
|
|
215
254
|
```
|
|
216
255
|
|
|
217
|
-
## `contrail
|
|
256
|
+
## `contrail colors load`
|
|
218
257
|
|
|
219
258
|
Say hello
|
|
220
259
|
|
|
221
260
|
```
|
|
222
261
|
USAGE
|
|
223
|
-
$ contrail
|
|
262
|
+
$ contrail colors load
|
|
224
263
|
|
|
225
264
|
DESCRIPTION
|
|
226
265
|
Say hello
|
|
@@ -229,13 +268,13 @@ EXAMPLES
|
|
|
229
268
|
$ contrail colors load
|
|
230
269
|
```
|
|
231
270
|
|
|
232
|
-
## `contrail
|
|
271
|
+
## `contrail config list`
|
|
233
272
|
|
|
234
273
|
List the configurations
|
|
235
274
|
|
|
236
275
|
```
|
|
237
276
|
USAGE
|
|
238
|
-
$ contrail
|
|
277
|
+
$ contrail config list
|
|
239
278
|
|
|
240
279
|
DESCRIPTION
|
|
241
280
|
List the configurations
|
|
@@ -244,13 +283,13 @@ EXAMPLES
|
|
|
244
283
|
$ contrail config list
|
|
245
284
|
```
|
|
246
285
|
|
|
247
|
-
## `contrail
|
|
286
|
+
## `contrail config remove`
|
|
248
287
|
|
|
249
288
|
Remove a variable from the configuration
|
|
250
289
|
|
|
251
290
|
```
|
|
252
291
|
USAGE
|
|
253
|
-
$ contrail
|
|
292
|
+
$ contrail config remove [--orgSlug] [--apiGateway] [--orgId] [--apiUserToken]
|
|
254
293
|
|
|
255
294
|
FLAGS
|
|
256
295
|
--apiGateway The API Gateway
|
|
@@ -265,13 +304,13 @@ EXAMPLES
|
|
|
265
304
|
$ contrail config remove --orgId
|
|
266
305
|
```
|
|
267
306
|
|
|
268
|
-
## `contrail
|
|
307
|
+
## `contrail config set`
|
|
269
308
|
|
|
270
309
|
Set a variable in the configuration
|
|
271
310
|
|
|
272
311
|
```
|
|
273
312
|
USAGE
|
|
274
|
-
$ contrail
|
|
313
|
+
$ contrail config set [--orgSlug <value>] [--apiGateway <value>] [--orgId <value>] [--apiUserToken <value>]
|
|
275
314
|
|
|
276
315
|
FLAGS
|
|
277
316
|
--apiGateway=<value> The API Gateway
|
|
@@ -286,13 +325,50 @@ EXAMPLES
|
|
|
286
325
|
$ contrail config set --orgId 1234
|
|
287
326
|
```
|
|
288
327
|
|
|
289
|
-
## `contrail
|
|
328
|
+
## `contrail groups export`
|
|
290
329
|
|
|
291
|
-
|
|
330
|
+
Export all groups in the org.
|
|
292
331
|
|
|
293
332
|
```
|
|
294
333
|
USAGE
|
|
295
|
-
$ contrail
|
|
334
|
+
$ contrail groups export [-d <value>] [--overwrite]
|
|
335
|
+
|
|
336
|
+
FLAGS
|
|
337
|
+
-d, --outDir=<value> [default: groups.yml] The location for the file to be saved
|
|
338
|
+
--overwrite Replaces existing files if they exist
|
|
339
|
+
|
|
340
|
+
DESCRIPTION
|
|
341
|
+
Export all groups in the org.
|
|
342
|
+
|
|
343
|
+
EXAMPLES
|
|
344
|
+
$ contrail groups export
|
|
345
|
+
```
|
|
346
|
+
|
|
347
|
+
## `contrail groups upload GROUPSFILE`
|
|
348
|
+
|
|
349
|
+
Import all groups in the groups.yml file
|
|
350
|
+
|
|
351
|
+
```
|
|
352
|
+
USAGE
|
|
353
|
+
$ contrail groups upload GROUPSFILE
|
|
354
|
+
|
|
355
|
+
ARGUMENTS
|
|
356
|
+
GROUPSFILE The .yml file containing the groups
|
|
357
|
+
|
|
358
|
+
DESCRIPTION
|
|
359
|
+
Import all groups in the groups.yml file
|
|
360
|
+
|
|
361
|
+
EXAMPLES
|
|
362
|
+
$ contrail groups import <GROUPS_FILE>
|
|
363
|
+
```
|
|
364
|
+
|
|
365
|
+
## `contrail help [COMMANDS]`
|
|
366
|
+
|
|
367
|
+
Display help for contrail.
|
|
368
|
+
|
|
369
|
+
```
|
|
370
|
+
USAGE
|
|
371
|
+
$ contrail help [COMMANDS] [-n]
|
|
296
372
|
|
|
297
373
|
ARGUMENTS
|
|
298
374
|
COMMANDS Command to show help for.
|
|
@@ -301,18 +377,55 @@ FLAGS
|
|
|
301
377
|
-n, --nested-commands Include all nested commands in the output.
|
|
302
378
|
|
|
303
379
|
DESCRIPTION
|
|
304
|
-
Display help for contrail
|
|
380
|
+
Display help for contrail.
|
|
305
381
|
```
|
|
306
382
|
|
|
307
383
|
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.6/src/commands/help.ts)_
|
|
308
384
|
|
|
309
|
-
## `contrail
|
|
385
|
+
## `contrail instance export`
|
|
386
|
+
|
|
387
|
+
Exports an data of an instance including types and users
|
|
388
|
+
|
|
389
|
+
```
|
|
390
|
+
USAGE
|
|
391
|
+
$ contrail instance export [--outDir <value>] [--overwrite]
|
|
392
|
+
|
|
393
|
+
FLAGS
|
|
394
|
+
--outDir=<value> [default: .] The directory to which to export the instance data. Defaults to the current directory
|
|
395
|
+
--overwrite Replaces any existing export files in outDir
|
|
396
|
+
|
|
397
|
+
DESCRIPTION
|
|
398
|
+
Exports an data of an instance including types and users
|
|
399
|
+
|
|
400
|
+
EXAMPLES
|
|
401
|
+
$ contrail instance export
|
|
402
|
+
```
|
|
403
|
+
|
|
404
|
+
## `contrail instance import`
|
|
405
|
+
|
|
406
|
+
Import the data to an instance, including types and users
|
|
407
|
+
|
|
408
|
+
```
|
|
409
|
+
USAGE
|
|
410
|
+
$ contrail instance import [--dir <value>]
|
|
411
|
+
|
|
412
|
+
FLAGS
|
|
413
|
+
--dir=<value> [default: .] The directory from which to export the instance data. Defaults to the current directory
|
|
414
|
+
|
|
415
|
+
DESCRIPTION
|
|
416
|
+
Import the data to an instance, including types and users
|
|
417
|
+
|
|
418
|
+
EXAMPLES
|
|
419
|
+
$ contrail instance import
|
|
420
|
+
```
|
|
421
|
+
|
|
422
|
+
## `contrail loader-process load CONFIGFILENAME`
|
|
310
423
|
|
|
311
424
|
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.
|
|
312
425
|
|
|
313
426
|
```
|
|
314
427
|
USAGE
|
|
315
|
-
$ contrail
|
|
428
|
+
$ contrail loader-process load CONFIGFILENAME
|
|
316
429
|
|
|
317
430
|
ARGUMENTS
|
|
318
431
|
CONFIGFILENAME The configuration file location
|
|
@@ -325,13 +438,13 @@ EXAMPLES
|
|
|
325
438
|
$ contrail load-processor load
|
|
326
439
|
```
|
|
327
440
|
|
|
328
|
-
## `contrail
|
|
441
|
+
## `contrail loader-process upload-and-load INCOMINGFILE CONFIGFILENAME`
|
|
329
442
|
|
|
330
443
|
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
|
|
331
444
|
|
|
332
445
|
```
|
|
333
446
|
USAGE
|
|
334
|
-
$ contrail
|
|
447
|
+
$ contrail loader-process upload-and-load INCOMINGFILE CONFIGFILENAME
|
|
335
448
|
|
|
336
449
|
ARGUMENTS
|
|
337
450
|
INCOMINGFILE The incoming file location
|
|
@@ -345,13 +458,13 @@ EXAMPLES
|
|
|
345
458
|
$ contrail load-processor upload-and-load <File Path> <Config Path>
|
|
346
459
|
```
|
|
347
460
|
|
|
348
|
-
## `contrail
|
|
461
|
+
## `contrail plugins`
|
|
349
462
|
|
|
350
463
|
List installed plugins.
|
|
351
464
|
|
|
352
465
|
```
|
|
353
466
|
USAGE
|
|
354
|
-
$ contrail
|
|
467
|
+
$ contrail plugins [--core]
|
|
355
468
|
|
|
356
469
|
FLAGS
|
|
357
470
|
--core Show core plugins.
|
|
@@ -360,18 +473,18 @@ DESCRIPTION
|
|
|
360
473
|
List installed plugins.
|
|
361
474
|
|
|
362
475
|
EXAMPLES
|
|
363
|
-
$ contrail
|
|
476
|
+
$ contrail plugins
|
|
364
477
|
```
|
|
365
478
|
|
|
366
479
|
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.3.2/src/commands/plugins/index.ts)_
|
|
367
480
|
|
|
368
|
-
## `contrail
|
|
481
|
+
## `contrail plugins:install PLUGIN...`
|
|
369
482
|
|
|
370
483
|
Installs a plugin into the CLI.
|
|
371
484
|
|
|
372
485
|
```
|
|
373
486
|
USAGE
|
|
374
|
-
$ contrail
|
|
487
|
+
$ contrail plugins:install PLUGIN...
|
|
375
488
|
|
|
376
489
|
ARGUMENTS
|
|
377
490
|
PLUGIN Plugin to install.
|
|
@@ -393,23 +506,23 @@ DESCRIPTION
|
|
|
393
506
|
|
|
394
507
|
|
|
395
508
|
ALIASES
|
|
396
|
-
$ contrail
|
|
509
|
+
$ contrail plugins add
|
|
397
510
|
|
|
398
511
|
EXAMPLES
|
|
399
|
-
$ contrail
|
|
512
|
+
$ contrail plugins:install myplugin
|
|
400
513
|
|
|
401
|
-
$ contrail
|
|
514
|
+
$ contrail plugins:install https://github.com/someuser/someplugin
|
|
402
515
|
|
|
403
|
-
$ contrail
|
|
516
|
+
$ contrail plugins:install someuser/someplugin
|
|
404
517
|
```
|
|
405
518
|
|
|
406
|
-
## `contrail
|
|
519
|
+
## `contrail plugins:inspect PLUGIN...`
|
|
407
520
|
|
|
408
521
|
Displays installation properties of a plugin.
|
|
409
522
|
|
|
410
523
|
```
|
|
411
524
|
USAGE
|
|
412
|
-
$ contrail
|
|
525
|
+
$ contrail plugins:inspect PLUGIN...
|
|
413
526
|
|
|
414
527
|
ARGUMENTS
|
|
415
528
|
PLUGIN [default: .] Plugin to inspect.
|
|
@@ -425,16 +538,16 @@ DESCRIPTION
|
|
|
425
538
|
Displays installation properties of a plugin.
|
|
426
539
|
|
|
427
540
|
EXAMPLES
|
|
428
|
-
$ contrail
|
|
541
|
+
$ contrail plugins:inspect myplugin
|
|
429
542
|
```
|
|
430
543
|
|
|
431
|
-
## `contrail
|
|
544
|
+
## `contrail plugins:install PLUGIN...`
|
|
432
545
|
|
|
433
546
|
Installs a plugin into the CLI.
|
|
434
547
|
|
|
435
548
|
```
|
|
436
549
|
USAGE
|
|
437
|
-
$ contrail
|
|
550
|
+
$ contrail plugins:install PLUGIN...
|
|
438
551
|
|
|
439
552
|
ARGUMENTS
|
|
440
553
|
PLUGIN Plugin to install.
|
|
@@ -456,23 +569,23 @@ DESCRIPTION
|
|
|
456
569
|
|
|
457
570
|
|
|
458
571
|
ALIASES
|
|
459
|
-
$ contrail
|
|
572
|
+
$ contrail plugins add
|
|
460
573
|
|
|
461
574
|
EXAMPLES
|
|
462
|
-
$ contrail
|
|
575
|
+
$ contrail plugins:install myplugin
|
|
463
576
|
|
|
464
|
-
$ contrail
|
|
577
|
+
$ contrail plugins:install https://github.com/someuser/someplugin
|
|
465
578
|
|
|
466
|
-
$ contrail
|
|
579
|
+
$ contrail plugins:install someuser/someplugin
|
|
467
580
|
```
|
|
468
581
|
|
|
469
|
-
## `contrail
|
|
582
|
+
## `contrail plugins:link PLUGIN`
|
|
470
583
|
|
|
471
584
|
Links a plugin into the CLI for development.
|
|
472
585
|
|
|
473
586
|
```
|
|
474
587
|
USAGE
|
|
475
|
-
$ contrail
|
|
588
|
+
$ contrail plugins:link PLUGIN
|
|
476
589
|
|
|
477
590
|
ARGUMENTS
|
|
478
591
|
PATH [default: .] path to plugin
|
|
@@ -490,16 +603,16 @@ DESCRIPTION
|
|
|
490
603
|
|
|
491
604
|
|
|
492
605
|
EXAMPLES
|
|
493
|
-
$ contrail
|
|
606
|
+
$ contrail plugins:link myplugin
|
|
494
607
|
```
|
|
495
608
|
|
|
496
|
-
## `contrail
|
|
609
|
+
## `contrail plugins:uninstall PLUGIN...`
|
|
497
610
|
|
|
498
611
|
Removes a plugin from the CLI.
|
|
499
612
|
|
|
500
613
|
```
|
|
501
614
|
USAGE
|
|
502
|
-
$ contrail
|
|
615
|
+
$ contrail plugins:uninstall PLUGIN...
|
|
503
616
|
|
|
504
617
|
ARGUMENTS
|
|
505
618
|
PLUGIN plugin to uninstall
|
|
@@ -512,17 +625,17 @@ DESCRIPTION
|
|
|
512
625
|
Removes a plugin from the CLI.
|
|
513
626
|
|
|
514
627
|
ALIASES
|
|
515
|
-
$ contrail
|
|
516
|
-
$ contrail
|
|
628
|
+
$ contrail plugins unlink
|
|
629
|
+
$ contrail plugins remove
|
|
517
630
|
```
|
|
518
631
|
|
|
519
|
-
## `contrail
|
|
632
|
+
## `contrail plugins:uninstall PLUGIN...`
|
|
520
633
|
|
|
521
634
|
Removes a plugin from the CLI.
|
|
522
635
|
|
|
523
636
|
```
|
|
524
637
|
USAGE
|
|
525
|
-
$ contrail
|
|
638
|
+
$ contrail plugins:uninstall PLUGIN...
|
|
526
639
|
|
|
527
640
|
ARGUMENTS
|
|
528
641
|
PLUGIN plugin to uninstall
|
|
@@ -535,17 +648,17 @@ DESCRIPTION
|
|
|
535
648
|
Removes a plugin from the CLI.
|
|
536
649
|
|
|
537
650
|
ALIASES
|
|
538
|
-
$ contrail
|
|
539
|
-
$ contrail
|
|
651
|
+
$ contrail plugins unlink
|
|
652
|
+
$ contrail plugins remove
|
|
540
653
|
```
|
|
541
654
|
|
|
542
|
-
## `contrail
|
|
655
|
+
## `contrail plugins:uninstall PLUGIN...`
|
|
543
656
|
|
|
544
657
|
Removes a plugin from the CLI.
|
|
545
658
|
|
|
546
659
|
```
|
|
547
660
|
USAGE
|
|
548
|
-
$ contrail
|
|
661
|
+
$ contrail plugins:uninstall PLUGIN...
|
|
549
662
|
|
|
550
663
|
ARGUMENTS
|
|
551
664
|
PLUGIN plugin to uninstall
|
|
@@ -558,17 +671,17 @@ DESCRIPTION
|
|
|
558
671
|
Removes a plugin from the CLI.
|
|
559
672
|
|
|
560
673
|
ALIASES
|
|
561
|
-
$ contrail
|
|
562
|
-
$ contrail
|
|
674
|
+
$ contrail plugins unlink
|
|
675
|
+
$ contrail plugins remove
|
|
563
676
|
```
|
|
564
677
|
|
|
565
|
-
## `contrail
|
|
678
|
+
## `contrail plugins update`
|
|
566
679
|
|
|
567
680
|
Update installed plugins.
|
|
568
681
|
|
|
569
682
|
```
|
|
570
683
|
USAGE
|
|
571
|
-
$ contrail
|
|
684
|
+
$ contrail plugins update [-h] [-v]
|
|
572
685
|
|
|
573
686
|
FLAGS
|
|
574
687
|
-h, --help Show CLI help.
|
|
@@ -578,13 +691,13 @@ DESCRIPTION
|
|
|
578
691
|
Update installed plugins.
|
|
579
692
|
```
|
|
580
693
|
|
|
581
|
-
## `contrail
|
|
694
|
+
## `contrail projects export PROJECTNAME`
|
|
582
695
|
|
|
583
696
|
Export a project.
|
|
584
697
|
|
|
585
698
|
```
|
|
586
699
|
USAGE
|
|
587
|
-
$ contrail
|
|
700
|
+
$ contrail projects export PROJECTNAME
|
|
588
701
|
|
|
589
702
|
DESCRIPTION
|
|
590
703
|
Export a project.
|
|
@@ -593,13 +706,13 @@ EXAMPLES
|
|
|
593
706
|
$ contrail project export <PROJECT_NAME>
|
|
594
707
|
```
|
|
595
708
|
|
|
596
|
-
## `contrail
|
|
709
|
+
## `contrail projects list`
|
|
597
710
|
|
|
598
711
|
Get a list of all projects.
|
|
599
712
|
|
|
600
713
|
```
|
|
601
714
|
USAGE
|
|
602
|
-
$ contrail
|
|
715
|
+
$ contrail projects list
|
|
603
716
|
|
|
604
717
|
DESCRIPTION
|
|
605
718
|
Get a list of all projects.
|
|
@@ -608,13 +721,13 @@ EXAMPLES
|
|
|
608
721
|
$ contrail project list
|
|
609
722
|
```
|
|
610
723
|
|
|
611
|
-
## `contrail
|
|
724
|
+
## `contrail projects load TEMPLATEFILELOCATION`
|
|
612
725
|
|
|
613
726
|
Configure a project from a yml file.
|
|
614
727
|
|
|
615
728
|
```
|
|
616
729
|
USAGE
|
|
617
|
-
$ contrail
|
|
730
|
+
$ contrail projects load TEMPLATEFILELOCATION
|
|
618
731
|
|
|
619
732
|
ARGUMENTS
|
|
620
733
|
TEMPLATEFILELOCATION The location to the template file
|
|
@@ -626,13 +739,13 @@ EXAMPLES
|
|
|
626
739
|
$ contrail project load <TEMPLATE_FILE_LOCATION>
|
|
627
740
|
```
|
|
628
741
|
|
|
629
|
-
## `contrail
|
|
742
|
+
## `contrail types exportOptionSetHierarchies`
|
|
630
743
|
|
|
631
744
|
export OptionSetHierarchies into CSVs.
|
|
632
745
|
|
|
633
746
|
```
|
|
634
747
|
USAGE
|
|
635
|
-
$ contrail
|
|
748
|
+
$ contrail types exportOptionSetHierarchies
|
|
636
749
|
|
|
637
750
|
DESCRIPTION
|
|
638
751
|
export OptionSetHierarchies into CSVs.
|
|
@@ -641,13 +754,17 @@ EXAMPLES
|
|
|
641
754
|
$ contrail types exportOptionSetsHierarchies
|
|
642
755
|
```
|
|
643
756
|
|
|
644
|
-
## `contrail
|
|
757
|
+
## `contrail types getAll`
|
|
645
758
|
|
|
646
759
|
Get all Types and associated data for your Org
|
|
647
760
|
|
|
648
761
|
```
|
|
649
762
|
USAGE
|
|
650
|
-
$ contrail
|
|
763
|
+
$ contrail types getAll [-d <value>] [--overwrite]
|
|
764
|
+
|
|
765
|
+
FLAGS
|
|
766
|
+
-d, --outDir=<value> [default: .] The directory to which to export the type data. Defaults to the current directory
|
|
767
|
+
--overwrite Replaces any existing export files in outDir
|
|
651
768
|
|
|
652
769
|
DESCRIPTION
|
|
653
770
|
Get all Types and associated data for your Org
|
|
@@ -656,28 +773,31 @@ EXAMPLES
|
|
|
656
773
|
$ contrail types getAll
|
|
657
774
|
```
|
|
658
775
|
|
|
659
|
-
## `contrail
|
|
776
|
+
## `contrail types loadAll`
|
|
660
777
|
|
|
661
|
-
|
|
778
|
+
loads all the type data that has been exported by getAll
|
|
662
779
|
|
|
663
780
|
```
|
|
664
781
|
USAGE
|
|
665
|
-
$ contrail
|
|
782
|
+
$ contrail types loadAll [-d <value>]
|
|
783
|
+
|
|
784
|
+
FLAGS
|
|
785
|
+
-d, --dir=<value> [default: .] The directory from which to load the types data. Defaults to the current directory.
|
|
666
786
|
|
|
667
787
|
DESCRIPTION
|
|
668
|
-
|
|
788
|
+
loads all the type data that has been exported by getAll
|
|
669
789
|
|
|
670
790
|
EXAMPLES
|
|
671
|
-
$ contrail types
|
|
791
|
+
$ contrail types loadAll
|
|
672
792
|
```
|
|
673
793
|
|
|
674
|
-
## `contrail
|
|
794
|
+
## `contrail types mergeOptionSets FILE`
|
|
675
795
|
|
|
676
796
|
Merge the OptionSets from an existing org and the OptionSets passed in. OptionSets File must be .yml.
|
|
677
797
|
|
|
678
798
|
```
|
|
679
799
|
USAGE
|
|
680
|
-
$ contrail
|
|
800
|
+
$ contrail types mergeOptionSets FILE
|
|
681
801
|
|
|
682
802
|
ARGUMENTS
|
|
683
803
|
FILE File to merge with the cloud option sets
|
|
@@ -689,13 +809,13 @@ EXAMPLES
|
|
|
689
809
|
$ contrail types mergeOptionSets <File Path>
|
|
690
810
|
```
|
|
691
811
|
|
|
692
|
-
## `contrail
|
|
812
|
+
## `contrail types mergeTypeProperties FILE TYPEPATHS`
|
|
693
813
|
|
|
694
814
|
Merge the TypeProperties from an existing org and the TypeProperties passed in. Add to Types via TypePath File must be .yml
|
|
695
815
|
|
|
696
816
|
```
|
|
697
817
|
USAGE
|
|
698
|
-
$ contrail
|
|
818
|
+
$ contrail types mergeTypeProperties FILE TYPEPATHS
|
|
699
819
|
|
|
700
820
|
ARGUMENTS
|
|
701
821
|
FILE File to parse
|
|
@@ -709,13 +829,13 @@ EXAMPLES
|
|
|
709
829
|
$ contrail types mergeTypeProperties <File Path> <TypePaths>
|
|
710
830
|
```
|
|
711
831
|
|
|
712
|
-
## `contrail
|
|
832
|
+
## `contrail types parseOptionSetsHierarchyLocalFile FILE`
|
|
713
833
|
|
|
714
834
|
Parse CSV file into OptionSetHierarchy
|
|
715
835
|
|
|
716
836
|
```
|
|
717
837
|
USAGE
|
|
718
|
-
$ contrail
|
|
838
|
+
$ contrail types parseOptionSetsHierarchyLocalFile FILE
|
|
719
839
|
|
|
720
840
|
ARGUMENTS
|
|
721
841
|
FILE File to parse
|
|
@@ -727,13 +847,13 @@ EXAMPLES
|
|
|
727
847
|
$ contrail types parseOptionSetsHierarchyLocalFile <File Paths>
|
|
728
848
|
```
|
|
729
849
|
|
|
730
|
-
## `contrail
|
|
850
|
+
## `contrail types parseOptionSetsLocalFiles FILE`
|
|
731
851
|
|
|
732
852
|
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"
|
|
733
853
|
|
|
734
854
|
```
|
|
735
855
|
USAGE
|
|
736
|
-
$ contrail
|
|
856
|
+
$ contrail types parseOptionSetsLocalFiles FILE --csvStyle NameAndLabel|LabelsInColumn
|
|
737
857
|
|
|
738
858
|
ARGUMENTS
|
|
739
859
|
FILE File to parse
|
|
@@ -751,13 +871,13 @@ EXAMPLES
|
|
|
751
871
|
$ contrail types parseOptionSetsLocalFiles <File Paths> <style>
|
|
752
872
|
```
|
|
753
873
|
|
|
754
|
-
## `contrail
|
|
874
|
+
## `contrail types parseOptionSetsToFolderStructure FILE`
|
|
755
875
|
|
|
756
876
|
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"
|
|
757
877
|
|
|
758
878
|
```
|
|
759
879
|
USAGE
|
|
760
|
-
$ contrail
|
|
880
|
+
$ contrail types parseOptionSetsToFolderStructure FILE
|
|
761
881
|
|
|
762
882
|
ARGUMENTS
|
|
763
883
|
FILE File to parse
|
|
@@ -771,13 +891,13 @@ EXAMPLES
|
|
|
771
891
|
$ contrail types parseOptionSetsLocalFiles <File Paths> <style>
|
|
772
892
|
```
|
|
773
893
|
|
|
774
|
-
## `contrail
|
|
894
|
+
## `contrail types parseTypesFromFiles TYPEPATHS`
|
|
775
895
|
|
|
776
896
|
Parse CSV files into Types and OptionSets from VibeIQ Files.
|
|
777
897
|
|
|
778
898
|
```
|
|
779
899
|
USAGE
|
|
780
|
-
$ contrail
|
|
900
|
+
$ contrail types parseTypesFromFiles TYPEPATHS
|
|
781
901
|
|
|
782
902
|
ARGUMENTS
|
|
783
903
|
TYPEPATHS A list of the VibeIQ file IDs to parse
|
|
@@ -790,13 +910,13 @@ EXAMPLES
|
|
|
790
910
|
$ contrail types parseTypesFromFiles <fileIds>
|
|
791
911
|
```
|
|
792
912
|
|
|
793
|
-
## `contrail
|
|
913
|
+
## `contrail types parseTypesFromLocalFiles TYPEPATHS`
|
|
794
914
|
|
|
795
915
|
Parse CSV files into Types and OptionSets from local files.
|
|
796
916
|
|
|
797
917
|
```
|
|
798
918
|
USAGE
|
|
799
|
-
$ contrail
|
|
919
|
+
$ contrail types parseTypesFromLocalFiles TYPEPATHS
|
|
800
920
|
|
|
801
921
|
ARGUMENTS
|
|
802
922
|
TYPEPATHS A list of the files to parse
|
|
@@ -808,13 +928,13 @@ EXAMPLES
|
|
|
808
928
|
$ contrail types parseTypesFromLocalFiles <File Paths>
|
|
809
929
|
```
|
|
810
930
|
|
|
811
|
-
## `contrail
|
|
931
|
+
## `contrail types parseTypesFromTemplateAndDataFromLocalFiles TEMPLATEFILE FILEPATHS`
|
|
812
932
|
|
|
813
933
|
Parse CSV files into Types and OptionSets from local type template files.
|
|
814
934
|
|
|
815
935
|
```
|
|
816
936
|
USAGE
|
|
817
|
-
$ contrail
|
|
937
|
+
$ contrail types parseTypesFromTemplateAndDataFromLocalFiles TEMPLATEFILE FILEPATHS
|
|
818
938
|
|
|
819
939
|
ARGUMENTS
|
|
820
940
|
TEMPLATEFILE The template file to use
|
|
@@ -827,13 +947,13 @@ EXAMPLES
|
|
|
827
947
|
$ contrail types parseTypesFromTemplateAndDataFromLocalFiles <Template Path> <File Paths>
|
|
828
948
|
```
|
|
829
949
|
|
|
830
|
-
## `contrail
|
|
950
|
+
## `contrail types parseTypesFromTemplateFromLocalFiles TEMPLATEFILE FILEPATH`
|
|
831
951
|
|
|
832
952
|
Parse CSV files into Types and OptionSets from local type template files.
|
|
833
953
|
|
|
834
954
|
```
|
|
835
955
|
USAGE
|
|
836
|
-
$ contrail
|
|
956
|
+
$ contrail types parseTypesFromTemplateFromLocalFiles TEMPLATEFILE FILEPATH
|
|
837
957
|
|
|
838
958
|
ARGUMENTS
|
|
839
959
|
TEMPLATEFILE The template file to use
|
|
@@ -846,28 +966,37 @@ EXAMPLES
|
|
|
846
966
|
$ contrail types parseTypesFromTemplateFromLocalFiles <Template File> <Data File>
|
|
847
967
|
```
|
|
848
968
|
|
|
849
|
-
## `contrail
|
|
969
|
+
## `contrail types uploadOptionSetHierarchies`
|
|
850
970
|
|
|
851
|
-
Upload
|
|
971
|
+
Upload Option Set Hierarchies for your Org. Option set hierarchies are loaded from .yml files in the option-set-hierarchies directory.
|
|
852
972
|
|
|
853
973
|
```
|
|
854
974
|
USAGE
|
|
855
|
-
$ contrail
|
|
975
|
+
$ contrail types uploadOptionSetHierarchies [-d <value>]
|
|
976
|
+
|
|
977
|
+
FLAGS
|
|
978
|
+
-d, --dir=<value> [default: .] The directory from which to export the option set hierarchies data. Defaults to the
|
|
979
|
+
current directory. The option set data will be loaded from $dir/option-set-hierarchies
|
|
856
980
|
|
|
857
981
|
DESCRIPTION
|
|
858
|
-
Upload
|
|
982
|
+
Upload Option Set Hierarchies for your Org. Option set hierarchies are loaded from .yml files in the
|
|
983
|
+
option-set-hierarchies directory.
|
|
859
984
|
|
|
860
985
|
EXAMPLES
|
|
861
986
|
$ contrail types uploadOptionSetHierarchies
|
|
862
987
|
```
|
|
863
988
|
|
|
864
|
-
## `contrail
|
|
989
|
+
## `contrail types uploadOptionSets`
|
|
865
990
|
|
|
866
991
|
Upload OptionSets for your Org. OptionSets are loaded from .yml files in the option-sets directory.
|
|
867
992
|
|
|
868
993
|
```
|
|
869
994
|
USAGE
|
|
870
|
-
$ contrail
|
|
995
|
+
$ contrail types uploadOptionSets [-d <value>]
|
|
996
|
+
|
|
997
|
+
FLAGS
|
|
998
|
+
-d, --dir=<value> [default: .] The directory from which to export the option set data. Defaults to the current
|
|
999
|
+
directory. The option set data will be loaded from $dir/option-sets
|
|
871
1000
|
|
|
872
1001
|
DESCRIPTION
|
|
873
1002
|
Upload OptionSets for your Org. OptionSets are loaded from .yml files in the option-sets directory.
|
|
@@ -876,13 +1005,13 @@ EXAMPLES
|
|
|
876
1005
|
$ contrail types uploadOptionSets
|
|
877
1006
|
```
|
|
878
1007
|
|
|
879
|
-
## `contrail
|
|
1008
|
+
## `contrail types uploadOptionSetsHierarchyLocalFile FILE NAME`
|
|
880
1009
|
|
|
881
1010
|
upload CSV file into OptionSetHierarchy
|
|
882
1011
|
|
|
883
1012
|
```
|
|
884
1013
|
USAGE
|
|
885
|
-
$ contrail
|
|
1014
|
+
$ contrail types uploadOptionSetsHierarchyLocalFile FILE NAME
|
|
886
1015
|
|
|
887
1016
|
ARGUMENTS
|
|
888
1017
|
FILE File to parse
|
|
@@ -895,13 +1024,17 @@ EXAMPLES
|
|
|
895
1024
|
$ contrail types uploadOptionSetsHierarchyLocalFile <File Path> <name>
|
|
896
1025
|
```
|
|
897
1026
|
|
|
898
|
-
## `contrail
|
|
1027
|
+
## `contrail types uploadRuleSets`
|
|
899
1028
|
|
|
900
1029
|
Upload an extracted rule set
|
|
901
1030
|
|
|
902
1031
|
```
|
|
903
1032
|
USAGE
|
|
904
|
-
$ contrail
|
|
1033
|
+
$ contrail types uploadRuleSets [-d <value>]
|
|
1034
|
+
|
|
1035
|
+
FLAGS
|
|
1036
|
+
-d, --dir=<value> [default: .] The directory from which to export the rule set data. Defaults to the current
|
|
1037
|
+
directory. The rule set data will be loaded from $dir/rule-sets/*.yml
|
|
905
1038
|
|
|
906
1039
|
DESCRIPTION
|
|
907
1040
|
Upload an extracted rule set
|
|
@@ -910,13 +1043,18 @@ EXAMPLES
|
|
|
910
1043
|
$ contrail types uploadRuleSets
|
|
911
1044
|
```
|
|
912
1045
|
|
|
913
|
-
## `contrail
|
|
1046
|
+
## `contrail types uploadTypePropertyPolicies`
|
|
914
1047
|
|
|
915
1048
|
Upload type property policies
|
|
916
1049
|
|
|
917
1050
|
```
|
|
918
1051
|
USAGE
|
|
919
|
-
$ contrail
|
|
1052
|
+
$ contrail types uploadTypePropertyPolicies [-d <value>]
|
|
1053
|
+
|
|
1054
|
+
FLAGS
|
|
1055
|
+
-d, --dir=<value> [default: .] The directory from which to export the type property policy data. Defaults to the
|
|
1056
|
+
current directory. The type property policy data will be loaded from
|
|
1057
|
+
$dir/type-property-policies/*.yml
|
|
920
1058
|
|
|
921
1059
|
DESCRIPTION
|
|
922
1060
|
Upload type property policies
|
|
@@ -925,13 +1063,17 @@ EXAMPLES
|
|
|
925
1063
|
$ contrail types uploadTypePropertyPolicies
|
|
926
1064
|
```
|
|
927
1065
|
|
|
928
|
-
## `contrail
|
|
1066
|
+
## `contrail types uploadUsageInfo`
|
|
929
1067
|
|
|
930
1068
|
Upload extracted usage info
|
|
931
1069
|
|
|
932
1070
|
```
|
|
933
1071
|
USAGE
|
|
934
|
-
$ contrail
|
|
1072
|
+
$ contrail types uploadUsageInfo [-d <value>]
|
|
1073
|
+
|
|
1074
|
+
FLAGS
|
|
1075
|
+
-d, --dir=<value> [default: .] The directory from which to export the usage info data. Defaults to the current
|
|
1076
|
+
directory. The option set data will be loaded from $dir/usage-info.yml
|
|
935
1077
|
|
|
936
1078
|
DESCRIPTION
|
|
937
1079
|
Upload extracted usage info
|
|
@@ -940,16 +1082,17 @@ EXAMPLES
|
|
|
940
1082
|
$ contrail types uploadUsageInfo
|
|
941
1083
|
```
|
|
942
1084
|
|
|
943
|
-
## `contrail
|
|
1085
|
+
## `contrail users export`
|
|
944
1086
|
|
|
945
1087
|
Export all users in the org.
|
|
946
1088
|
|
|
947
1089
|
```
|
|
948
1090
|
USAGE
|
|
949
|
-
$ contrail
|
|
1091
|
+
$ contrail users export [-d <value>] [--overwrite]
|
|
950
1092
|
|
|
951
1093
|
FLAGS
|
|
952
|
-
-
|
|
1094
|
+
-d, --outDir=<value> [default: users.yml] The location for the file to be saved
|
|
1095
|
+
--overwrite Replaces existing files if they exist
|
|
953
1096
|
|
|
954
1097
|
DESCRIPTION
|
|
955
1098
|
Export all users in the org.
|
|
@@ -958,13 +1101,13 @@ EXAMPLES
|
|
|
958
1101
|
$ contrail users export
|
|
959
1102
|
```
|
|
960
1103
|
|
|
961
|
-
## `contrail
|
|
1104
|
+
## `contrail users upload USERSFILE`
|
|
962
1105
|
|
|
963
1106
|
Import all users in the users.yml file
|
|
964
1107
|
|
|
965
1108
|
```
|
|
966
1109
|
USAGE
|
|
967
|
-
$ contrail
|
|
1110
|
+
$ contrail users upload USERSFILE
|
|
968
1111
|
|
|
969
1112
|
ARGUMENTS
|
|
970
1113
|
USERSFILE The .yml file containing the users
|
|
@@ -976,13 +1119,13 @@ EXAMPLES
|
|
|
976
1119
|
$ contrail users import <USERS_FILE>
|
|
977
1120
|
```
|
|
978
1121
|
|
|
979
|
-
## `contrail
|
|
1122
|
+
## `contrail workflow-template-definitions install`
|
|
980
1123
|
|
|
981
1124
|
Install the template definitions of an app to your org
|
|
982
1125
|
|
|
983
1126
|
```
|
|
984
1127
|
USAGE
|
|
985
|
-
$ contrail
|
|
1128
|
+
$ contrail workflow-template-definitions install
|
|
986
1129
|
|
|
987
1130
|
DESCRIPTION
|
|
988
1131
|
Install the template definitions of an app to your org
|
|
@@ -991,13 +1134,13 @@ EXAMPLES
|
|
|
991
1134
|
$ contrail workflow-template-definitions install
|
|
992
1135
|
```
|
|
993
1136
|
|
|
994
|
-
## `contrail
|
|
1137
|
+
## `contrail workflow-template-definitions list`
|
|
995
1138
|
|
|
996
1139
|
Lists the workflow templates in the org
|
|
997
1140
|
|
|
998
1141
|
```
|
|
999
1142
|
USAGE
|
|
1000
|
-
$ contrail
|
|
1143
|
+
$ contrail workflow-template-definitions list
|
|
1001
1144
|
|
|
1002
1145
|
DESCRIPTION
|
|
1003
1146
|
Lists the workflow templates in the org
|
|
@@ -1006,13 +1149,13 @@ EXAMPLES
|
|
|
1006
1149
|
$ contrail workflow-template-definitions list
|
|
1007
1150
|
```
|
|
1008
1151
|
|
|
1009
|
-
## `contrail
|
|
1152
|
+
## `contrail workflow-templates delete`
|
|
1010
1153
|
|
|
1011
1154
|
Delete workflow templates from your org
|
|
1012
1155
|
|
|
1013
1156
|
```
|
|
1014
1157
|
USAGE
|
|
1015
|
-
$ contrail
|
|
1158
|
+
$ contrail workflow-templates delete
|
|
1016
1159
|
|
|
1017
1160
|
DESCRIPTION
|
|
1018
1161
|
Delete workflow templates from your org
|
|
@@ -1021,13 +1164,13 @@ EXAMPLES
|
|
|
1021
1164
|
$ contrail workflow-template delete
|
|
1022
1165
|
```
|
|
1023
1166
|
|
|
1024
|
-
## `contrail
|
|
1167
|
+
## `contrail workflow-templates list`
|
|
1025
1168
|
|
|
1026
1169
|
Lists the workflow templates in the org
|
|
1027
1170
|
|
|
1028
1171
|
```
|
|
1029
1172
|
USAGE
|
|
1030
|
-
$ contrail
|
|
1173
|
+
$ contrail workflow-templates list
|
|
1031
1174
|
|
|
1032
1175
|
DESCRIPTION
|
|
1033
1176
|
Lists the workflow templates in the org
|
|
@@ -1036,13 +1179,13 @@ EXAMPLES
|
|
|
1036
1179
|
$ contrail workflow-template list
|
|
1037
1180
|
```
|
|
1038
1181
|
|
|
1039
|
-
## `contrail
|
|
1182
|
+
## `contrail workflow-templates load FILELOCATION`
|
|
1040
1183
|
|
|
1041
1184
|
Loads your workflow from a local file
|
|
1042
1185
|
|
|
1043
1186
|
```
|
|
1044
1187
|
USAGE
|
|
1045
|
-
$ contrail
|
|
1188
|
+
$ contrail workflow-templates load FILELOCATION
|
|
1046
1189
|
|
|
1047
1190
|
ARGUMENTS
|
|
1048
1191
|
FILELOCATION The workflow template file to load
|