@salesforce/plugin-packaging 1.27.1 → 1.27.3
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 +94 -138
- package/lib/commands/package/convert.d.ts +9 -9
- package/lib/commands/package/convert.js +2 -2
- package/lib/commands/package/convert.js.map +1 -1
- package/lib/commands/package/create.d.ts +8 -8
- package/lib/commands/package/delete.d.ts +4 -4
- package/lib/commands/package/install/report.d.ts +4 -4
- package/lib/commands/package/install.d.ts +12 -13
- package/lib/commands/package/install.js.map +1 -1
- package/lib/commands/package/installed/list.d.ts +3 -3
- package/lib/commands/package/list.d.ts +3 -3
- package/lib/commands/package/uninstall/report.d.ts +4 -4
- package/lib/commands/package/uninstall.d.ts +5 -5
- package/lib/commands/package/update.d.ts +7 -7
- package/lib/commands/package/version/create/list.d.ts +5 -5
- package/lib/commands/package/version/create/report.d.ts +4 -4
- package/lib/commands/package/version/create/report.js +3 -1
- package/lib/commands/package/version/create/report.js.map +1 -1
- package/lib/commands/package/version/create.d.ts +19 -19
- package/lib/commands/package/version/create.js +2 -2
- package/lib/commands/package/version/create.js.map +1 -1
- package/lib/commands/package/version/delete.d.ts +4 -4
- package/lib/commands/package/version/displayancestry.d.ts +4 -4
- package/lib/commands/package/version/list.d.ts +7 -7
- package/lib/commands/package/version/list.js +2 -2
- package/lib/commands/package/version/list.js.map +1 -1
- package/lib/commands/package/version/promote.d.ts +4 -4
- package/lib/commands/package/version/report.d.ts +4 -4
- package/lib/commands/package/version/report.js +1 -1
- package/lib/commands/package/version/report.js.map +1 -1
- package/lib/commands/package/version/retrieve.d.ts +5 -5
- package/lib/commands/package/version/update.d.ts +9 -9
- package/lib/commands/package1/version/create/get.d.ts +4 -4
- package/lib/commands/package1/version/create.d.ts +11 -11
- package/lib/commands/package1/version/display.d.ts +4 -4
- package/lib/commands/package1/version/list.d.ts +4 -4
- package/lib/utils/hubFlag.d.ts +1 -1
- package/oclif.lock +421 -557
- package/oclif.manifest.json +25 -216
- package/package.json +14 -37
package/README.md
CHANGED
|
@@ -59,8 +59,8 @@ Create a first-generation package version in the release org.
|
|
|
59
59
|
|
|
60
60
|
```
|
|
61
61
|
USAGE
|
|
62
|
-
$ sf package1:version:create -o <value> -i <value> -n <value> [--
|
|
63
|
-
|
|
62
|
+
$ sf package1:version:create -o <value> -i <value> -n <value> [--api-version <value>] [-d <value>] [-v <value>] [-m] [-r
|
|
63
|
+
<value>] [-p <value>] [-k <value>] [-w <value>]
|
|
64
64
|
|
|
65
65
|
FLAGS
|
|
66
66
|
-d, --description=<value> Package version description.
|
|
@@ -69,16 +69,14 @@ FLAGS
|
|
|
69
69
|
-k, --installation-key=<value> Installation key for key-protected package (default: null).
|
|
70
70
|
-m, --managed-released Create a managed package version.
|
|
71
71
|
-n, --name=<value> (required) Package version name.
|
|
72
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
72
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
73
|
+
configuration variable is already set.
|
|
73
74
|
-p, --post-install-url=<value> Post install URL.
|
|
74
75
|
-r, --release-notes-url=<value> Release notes URL.
|
|
75
76
|
-v, --version=<value> Package version in major.minor format, for example, 3.2.
|
|
76
77
|
-w, --wait=<value> Minutes to wait for the package version to be created (default: 2 minutes).
|
|
77
78
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
78
79
|
|
|
79
|
-
GLOBAL FLAGS
|
|
80
|
-
--json Format output as json.
|
|
81
|
-
|
|
82
80
|
DESCRIPTION
|
|
83
81
|
Create a first-generation package version in the release org.
|
|
84
82
|
|
|
@@ -116,7 +114,7 @@ FLAG DESCRIPTIONS
|
|
|
116
114
|
subscribers.
|
|
117
115
|
```
|
|
118
116
|
|
|
119
|
-
_See code: [src/commands/package1/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
117
|
+
_See code: [src/commands/package1/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.3/src/commands/package1/version/create.ts)_
|
|
120
118
|
|
|
121
119
|
## `sf package1:version:create:get`
|
|
122
120
|
|
|
@@ -124,16 +122,14 @@ Retrieve the status of a package version creation request.
|
|
|
124
122
|
|
|
125
123
|
```
|
|
126
124
|
USAGE
|
|
127
|
-
$ sf package1:version:create:get -o <value> -i <value> [--
|
|
125
|
+
$ sf package1:version:create:get -o <value> -i <value> [--api-version <value>]
|
|
128
126
|
|
|
129
127
|
FLAGS
|
|
130
128
|
-i, --request-id=<value> (required) ID of the PackageUploadRequest (starts with 0HD).
|
|
131
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
129
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
130
|
+
configuration variable is already set.
|
|
132
131
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
133
132
|
|
|
134
|
-
GLOBAL FLAGS
|
|
135
|
-
--json Format output as json.
|
|
136
|
-
|
|
137
133
|
ALIASES
|
|
138
134
|
$ sf force:package1:version:create:get
|
|
139
135
|
|
|
@@ -147,7 +143,7 @@ EXAMPLES
|
|
|
147
143
|
$ sf package1:version:create:get --request-id 0HD... --target-org myorg@example.com
|
|
148
144
|
```
|
|
149
145
|
|
|
150
|
-
_See code: [src/commands/package1/version/create/get.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
146
|
+
_See code: [src/commands/package1/version/create/get.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.3/src/commands/package1/version/create/get.ts)_
|
|
151
147
|
|
|
152
148
|
## `sf package1:version:display`
|
|
153
149
|
|
|
@@ -155,17 +151,15 @@ Display details about a first-generation package version.
|
|
|
155
151
|
|
|
156
152
|
```
|
|
157
153
|
USAGE
|
|
158
|
-
$ sf package1:version:display -o <value> -i <value> [--
|
|
154
|
+
$ sf package1:version:display -o <value> -i <value> [--api-version <value>]
|
|
159
155
|
|
|
160
156
|
FLAGS
|
|
161
157
|
-i, --package-version-id=<value> (required) ID (starts with 04t) of the metadata package version whose details you
|
|
162
158
|
want to display.
|
|
163
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
159
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
160
|
+
configuration variable is already set.
|
|
164
161
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
165
162
|
|
|
166
|
-
GLOBAL FLAGS
|
|
167
|
-
--json Format output as json.
|
|
168
|
-
|
|
169
163
|
ALIASES
|
|
170
164
|
$ sf force:package1:version:display
|
|
171
165
|
|
|
@@ -179,7 +173,7 @@ EXAMPLES
|
|
|
179
173
|
$ sf package1:version:display --package-version-id 04t... --target-org myorg@example.com
|
|
180
174
|
```
|
|
181
175
|
|
|
182
|
-
_See code: [src/commands/package1/version/display.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
176
|
+
_See code: [src/commands/package1/version/display.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.3/src/commands/package1/version/display.ts)_
|
|
183
177
|
|
|
184
178
|
## `sf package1:version:list`
|
|
185
179
|
|
|
@@ -187,16 +181,14 @@ List package versions for the specified first-generation package or for the org.
|
|
|
187
181
|
|
|
188
182
|
```
|
|
189
183
|
USAGE
|
|
190
|
-
$ sf package1:version:list -o <value> [--
|
|
184
|
+
$ sf package1:version:list -o <value> [--api-version <value>] [-i <value>]
|
|
191
185
|
|
|
192
186
|
FLAGS
|
|
193
187
|
-i, --package-id=<value> Metadata package ID (starts with 033) whose package versions you want to list.
|
|
194
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
188
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
189
|
+
configuration variable is already set.
|
|
195
190
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
196
191
|
|
|
197
|
-
GLOBAL FLAGS
|
|
198
|
-
--json Format output as json.
|
|
199
|
-
|
|
200
192
|
ALIASES
|
|
201
193
|
$ sf force:package1:version:list
|
|
202
194
|
|
|
@@ -215,7 +207,7 @@ FLAG DESCRIPTIONS
|
|
|
215
207
|
If not specified, shows all versions for all packages (managed and unmanaged) in the org.
|
|
216
208
|
```
|
|
217
209
|
|
|
218
|
-
_See code: [src/commands/package1/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
210
|
+
_See code: [src/commands/package1/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.3/src/commands/package1/version/list.ts)_
|
|
219
211
|
|
|
220
212
|
## `sf package:create`
|
|
221
213
|
|
|
@@ -223,8 +215,8 @@ Create a package.
|
|
|
223
215
|
|
|
224
216
|
```
|
|
225
217
|
USAGE
|
|
226
|
-
$ sf package:create -v <value> -n <value> -t Managed|Unlocked -r <value> [--
|
|
227
|
-
|
|
218
|
+
$ sf package:create -v <value> -n <value> -t Managed|Unlocked -r <value> [--api-version <value>] [-d <value>] [-e]
|
|
219
|
+
[--org-dependent] [-o <value>]
|
|
228
220
|
|
|
229
221
|
FLAGS
|
|
230
222
|
-d, --description=<value> Description of the package.
|
|
@@ -235,14 +227,12 @@ FLAGS
|
|
|
235
227
|
-r, --path=<value> (required) Path to directory that contains the contents of the package.
|
|
236
228
|
-t, --package-type=<option> (required) Type of package.
|
|
237
229
|
<options: Managed|Unlocked>
|
|
238
|
-
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
|
|
230
|
+
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the
|
|
231
|
+
`target-dev-hub` configuration variable is already set.
|
|
239
232
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
240
233
|
--org-dependent Depends on unpackaged metadata in the installation org; applies to unlocked
|
|
241
234
|
packages only.
|
|
242
235
|
|
|
243
|
-
GLOBAL FLAGS
|
|
244
|
-
--json Format output as json.
|
|
245
|
-
|
|
246
236
|
DESCRIPTION
|
|
247
237
|
Create a package.
|
|
248
238
|
|
|
@@ -292,7 +282,7 @@ FLAG DESCRIPTIONS
|
|
|
292
282
|
Org-Dependent Unlocked Packages" in the Salesforce DX Developer Guide.
|
|
293
283
|
```
|
|
294
284
|
|
|
295
|
-
_See code: [src/commands/package/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
285
|
+
_See code: [src/commands/package/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.3/src/commands/package/create.ts)_
|
|
296
286
|
|
|
297
287
|
## `sf package:delete`
|
|
298
288
|
|
|
@@ -300,17 +290,15 @@ Delete a package.
|
|
|
300
290
|
|
|
301
291
|
```
|
|
302
292
|
USAGE
|
|
303
|
-
$ sf package:delete -v <value> -p <value> [--
|
|
293
|
+
$ sf package:delete -v <value> -p <value> [--api-version <value>] [-n]
|
|
304
294
|
|
|
305
295
|
FLAGS
|
|
306
296
|
-n, --no-prompt Don’t prompt before deleting the package.
|
|
307
297
|
-p, --package=<value> (required) ID (starts with 0Ho) or alias of the package to delete.
|
|
308
|
-
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
|
|
298
|
+
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the `target-dev-hub`
|
|
299
|
+
configuration variable is already set.
|
|
309
300
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
310
301
|
|
|
311
|
-
GLOBAL FLAGS
|
|
312
|
-
--json Format output as json.
|
|
313
|
-
|
|
314
302
|
DESCRIPTION
|
|
315
303
|
Delete a package.
|
|
316
304
|
|
|
@@ -332,7 +320,7 @@ EXAMPLES
|
|
|
332
320
|
$ sf package:delete --package 0Ho... --target-dev-hub devhub@example.com
|
|
333
321
|
```
|
|
334
322
|
|
|
335
|
-
_See code: [src/commands/package/delete.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
323
|
+
_See code: [src/commands/package/delete.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.3/src/commands/package/delete.ts)_
|
|
336
324
|
|
|
337
325
|
## `sf package:install`
|
|
338
326
|
|
|
@@ -340,8 +328,8 @@ Install a version of a package in the target org.
|
|
|
340
328
|
|
|
341
329
|
```
|
|
342
330
|
USAGE
|
|
343
|
-
$ sf package:install -o <value> -p <value> [--
|
|
344
|
-
|
|
331
|
+
$ sf package:install -o <value> -p <value> [--api-version <value>] [-w <value>] [-k <value>] [-b <value>] [-r] [-a
|
|
332
|
+
all|package] [-s AllUsers|AdminsOnly] [-t DeprecateOnly|Mixed|Delete]
|
|
345
333
|
|
|
346
334
|
FLAGS
|
|
347
335
|
-a, --apex-compile=<option> [default: all] Compile all Apex in the org and package, or only Apex in the package;
|
|
@@ -350,7 +338,8 @@ FLAGS
|
|
|
350
338
|
-b, --publish-wait=<value> [default: 0 minutes] Maximum number of minutes to wait for the Subscriber Package
|
|
351
339
|
Version ID to become available in the target org before canceling the install request.
|
|
352
340
|
-k, --installation-key=<value> Installation key for key-protected package (default: null).
|
|
353
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
341
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
342
|
+
configuration variable is already set.
|
|
354
343
|
-p, --package=<value> (required) ID (starts with 04t) or alias of the package version to install.
|
|
355
344
|
-r, --no-prompt Don't prompt for confirmation.
|
|
356
345
|
-s, --security-type=<option> [default: AdminsOnly] Security access type for the installed package. (deprecation
|
|
@@ -363,9 +352,6 @@ FLAGS
|
|
|
363
352
|
-w, --wait=<value> [default: 0 minutes] Number of minutes to wait for installation status.
|
|
364
353
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
365
354
|
|
|
366
|
-
GLOBAL FLAGS
|
|
367
|
-
--json Format output as json.
|
|
368
|
-
|
|
369
355
|
DESCRIPTION
|
|
370
356
|
Install a version of a package in the target org.
|
|
371
357
|
|
|
@@ -428,7 +414,7 @@ FLAG DESCRIPTIONS
|
|
|
428
414
|
specify DeprecateOnly or Delete only for unlocked package upgrades.
|
|
429
415
|
```
|
|
430
416
|
|
|
431
|
-
_See code: [src/commands/package/install.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
417
|
+
_See code: [src/commands/package/install.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.3/src/commands/package/install.ts)_
|
|
432
418
|
|
|
433
419
|
## `sf package:install:report`
|
|
434
420
|
|
|
@@ -436,16 +422,14 @@ Retrieve the status of a package installation request.
|
|
|
436
422
|
|
|
437
423
|
```
|
|
438
424
|
USAGE
|
|
439
|
-
$ sf package:install:report -o <value> -i <value> [--
|
|
425
|
+
$ sf package:install:report -o <value> -i <value> [--api-version <value>]
|
|
440
426
|
|
|
441
427
|
FLAGS
|
|
442
428
|
-i, --request-id=<value> (required) ID of the package install request you want to check; starts with 0Hf.
|
|
443
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
429
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
430
|
+
configuration variable is already set.
|
|
444
431
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
445
432
|
|
|
446
|
-
GLOBAL FLAGS
|
|
447
|
-
--json Format output as json.
|
|
448
|
-
|
|
449
433
|
ALIASES
|
|
450
434
|
$ sf force:package:install:report
|
|
451
435
|
|
|
@@ -459,7 +443,7 @@ EXAMPLES
|
|
|
459
443
|
$ sf package:install:report --request-id 0Hf... --target-org me@example.com
|
|
460
444
|
```
|
|
461
445
|
|
|
462
|
-
_See code: [src/commands/package/install/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
446
|
+
_See code: [src/commands/package/install/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.3/src/commands/package/install/report.ts)_
|
|
463
447
|
|
|
464
448
|
## `sf package:installed:list`
|
|
465
449
|
|
|
@@ -467,15 +451,13 @@ List the org’s installed packages.
|
|
|
467
451
|
|
|
468
452
|
```
|
|
469
453
|
USAGE
|
|
470
|
-
$ sf package:installed:list -o <value> [--
|
|
454
|
+
$ sf package:installed:list -o <value> [--api-version <value>]
|
|
471
455
|
|
|
472
456
|
FLAGS
|
|
473
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
457
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
458
|
+
configuration variable is already set.
|
|
474
459
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
475
460
|
|
|
476
|
-
GLOBAL FLAGS
|
|
477
|
-
--json Format output as json.
|
|
478
|
-
|
|
479
461
|
ALIASES
|
|
480
462
|
$ sf force:package:installed:list
|
|
481
463
|
|
|
@@ -489,7 +471,7 @@ EXAMPLES
|
|
|
489
471
|
$ sf package:installed:list --target-org me@example.com
|
|
490
472
|
```
|
|
491
473
|
|
|
492
|
-
_See code: [src/commands/package/installed/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
474
|
+
_See code: [src/commands/package/installed/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.3/src/commands/package/installed/list.ts)_
|
|
493
475
|
|
|
494
476
|
## `sf package:list`
|
|
495
477
|
|
|
@@ -497,16 +479,14 @@ List all packages in the Dev Hub org.
|
|
|
497
479
|
|
|
498
480
|
```
|
|
499
481
|
USAGE
|
|
500
|
-
$ sf package:list -v <value> [--
|
|
482
|
+
$ sf package:list -v <value> [--api-version <value>] [--verbose]
|
|
501
483
|
|
|
502
484
|
FLAGS
|
|
503
|
-
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
|
|
485
|
+
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the `target-dev-hub`
|
|
486
|
+
configuration variable is already set.
|
|
504
487
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
505
488
|
--verbose Display extended package detail.
|
|
506
489
|
|
|
507
|
-
GLOBAL FLAGS
|
|
508
|
-
--json Format output as json.
|
|
509
|
-
|
|
510
490
|
DESCRIPTION
|
|
511
491
|
List all packages in the Dev Hub org.
|
|
512
492
|
|
|
@@ -525,7 +505,7 @@ EXAMPLES
|
|
|
525
505
|
$ sf package:list --target-dev-hub devhub@example.com --verbose
|
|
526
506
|
```
|
|
527
507
|
|
|
528
|
-
_See code: [src/commands/package/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
508
|
+
_See code: [src/commands/package/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.3/src/commands/package/list.ts)_
|
|
529
509
|
|
|
530
510
|
## `sf package:uninstall`
|
|
531
511
|
|
|
@@ -533,17 +513,15 @@ Uninstall a second-generation package from the target org.
|
|
|
533
513
|
|
|
534
514
|
```
|
|
535
515
|
USAGE
|
|
536
|
-
$ sf package:uninstall -o <value> -p <value> [--
|
|
516
|
+
$ sf package:uninstall -o <value> -p <value> [--api-version <value>] [-w <value>]
|
|
537
517
|
|
|
538
518
|
FLAGS
|
|
539
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
519
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
520
|
+
configuration variable is already set.
|
|
540
521
|
-p, --package=<value> (required) ID (starts with 04t) or alias of the package version to uninstall.
|
|
541
522
|
-w, --wait=<value> [default: 0 minutes] Number of minutes to wait for uninstall status.
|
|
542
523
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
543
524
|
|
|
544
|
-
GLOBAL FLAGS
|
|
545
|
-
--json Format output as json.
|
|
546
|
-
|
|
547
525
|
DESCRIPTION
|
|
548
526
|
Uninstall a second-generation package from the target org.
|
|
549
527
|
|
|
@@ -571,7 +549,7 @@ EXAMPLES
|
|
|
571
549
|
$ sf package:uninstall --package "Undesirable Package Alias"
|
|
572
550
|
```
|
|
573
551
|
|
|
574
|
-
_See code: [src/commands/package/uninstall.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
552
|
+
_See code: [src/commands/package/uninstall.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.3/src/commands/package/uninstall.ts)_
|
|
575
553
|
|
|
576
554
|
## `sf package:uninstall:report`
|
|
577
555
|
|
|
@@ -579,16 +557,14 @@ Retrieve the status of a package uninstall request.
|
|
|
579
557
|
|
|
580
558
|
```
|
|
581
559
|
USAGE
|
|
582
|
-
$ sf package:uninstall:report -o <value> -i <value> [--
|
|
560
|
+
$ sf package:uninstall:report -o <value> -i <value> [--api-version <value>]
|
|
583
561
|
|
|
584
562
|
FLAGS
|
|
585
563
|
-i, --request-id=<value> (required) ID of the package uninstall request you want to check; starts with 06y.
|
|
586
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
564
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
565
|
+
configuration variable is already set.
|
|
587
566
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
588
567
|
|
|
589
|
-
GLOBAL FLAGS
|
|
590
|
-
--json Format output as json.
|
|
591
|
-
|
|
592
568
|
ALIASES
|
|
593
569
|
$ sf force:package:uninstall:report
|
|
594
570
|
|
|
@@ -602,7 +578,7 @@ EXAMPLES
|
|
|
602
578
|
$ sf package:uninstall:report --request-id 06y... --target-org me@example.com
|
|
603
579
|
```
|
|
604
580
|
|
|
605
|
-
_See code: [src/commands/package/uninstall/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
581
|
+
_See code: [src/commands/package/uninstall/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.3/src/commands/package/uninstall/report.ts)_
|
|
606
582
|
|
|
607
583
|
## `sf package:update`
|
|
608
584
|
|
|
@@ -610,7 +586,7 @@ Update package details.
|
|
|
610
586
|
|
|
611
587
|
```
|
|
612
588
|
USAGE
|
|
613
|
-
$ sf package:update -v <value> -p <value> [--
|
|
589
|
+
$ sf package:update -v <value> -p <value> [--api-version <value>] [-n <value>] [-d <value>] [-o <value>]
|
|
614
590
|
[--enable-app-analytics]
|
|
615
591
|
|
|
616
592
|
FLAGS
|
|
@@ -619,14 +595,12 @@ FLAGS
|
|
|
619
595
|
-o, --error-notification-username=<value> Active Dev Hub user designated to receive email notifications for package
|
|
620
596
|
errors.
|
|
621
597
|
-p, --package=<value> (required) ID (starts with 0Ho) or alias of the package to update.
|
|
622
|
-
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
|
|
598
|
+
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the
|
|
599
|
+
`target-dev-hub` configuration variable is already set.
|
|
623
600
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
624
601
|
--[no-]enable-app-analytics Enable AppExchange App Analytics usage data collection on this managed
|
|
625
602
|
package and its components.
|
|
626
603
|
|
|
627
|
-
GLOBAL FLAGS
|
|
628
|
-
--json Format output as json.
|
|
629
|
-
|
|
630
604
|
DESCRIPTION
|
|
631
605
|
Update package details.
|
|
632
606
|
|
|
@@ -655,7 +629,7 @@ FLAG DESCRIPTIONS
|
|
|
655
629
|
associated with your package.
|
|
656
630
|
```
|
|
657
631
|
|
|
658
|
-
_See code: [src/commands/package/update.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
632
|
+
_See code: [src/commands/package/update.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.3/src/commands/package/update.ts)_
|
|
659
633
|
|
|
660
634
|
## `sf package:version:create`
|
|
661
635
|
|
|
@@ -663,8 +637,8 @@ Create a package version in the Dev Hub org.
|
|
|
663
637
|
|
|
664
638
|
```
|
|
665
639
|
USAGE
|
|
666
|
-
$ sf package:version:create -v <value> [--
|
|
667
|
-
|
|
640
|
+
$ sf package:version:create -v <value> [--api-version <value>] [-b <value>] [-c | --skip-validation] [-f <value>] [-k
|
|
641
|
+
<value>] [-x] [-p <value>] [-d <value>] [--post-install-script <value>] [--post-install-url <value>]
|
|
668
642
|
[--releasenotes-url <value>] [--skip-ancestor-check] [-t <value>] [--uninstall-script <value>] [-e <value>] [-a
|
|
669
643
|
<value>] [-n <value>] [-w <value>] [--language <value>] [--verbose]
|
|
670
644
|
|
|
@@ -686,7 +660,8 @@ FLAGS
|
|
|
686
660
|
sfdx-project.json value.
|
|
687
661
|
-p, --package=<value> ID (starts with 0Ho) or alias of the package to create a version of.
|
|
688
662
|
-t, --tag=<value> Package version’s tag.
|
|
689
|
-
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
|
|
663
|
+
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the
|
|
664
|
+
`target-dev-hub` configuration variable is already set.
|
|
690
665
|
-w, --wait=<value> [default: 0 minutes] Number of minutes to wait for the package version to be
|
|
691
666
|
created.
|
|
692
667
|
-x, --installation-key-bypass Bypass the installation key requirement. (either --installation-key or
|
|
@@ -703,9 +678,6 @@ FLAGS
|
|
|
703
678
|
--uninstall-script=<value> Uninstall script name; applies to managed packages only.
|
|
704
679
|
--verbose Display verbose command output.
|
|
705
680
|
|
|
706
|
-
GLOBAL FLAGS
|
|
707
|
-
--json Format output as json.
|
|
708
|
-
|
|
709
681
|
DESCRIPTION
|
|
710
682
|
Create a package version in the Dev Hub org.
|
|
711
683
|
|
|
@@ -809,7 +781,7 @@ FLAG DESCRIPTIONS
|
|
|
809
781
|
periods of no output from commands.
|
|
810
782
|
```
|
|
811
783
|
|
|
812
|
-
_See code: [src/commands/package/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
784
|
+
_See code: [src/commands/package/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.3/src/commands/package/version/create.ts)_
|
|
813
785
|
|
|
814
786
|
## `sf package:version:create:list`
|
|
815
787
|
|
|
@@ -817,7 +789,7 @@ List package version creation requests.
|
|
|
817
789
|
|
|
818
790
|
```
|
|
819
791
|
USAGE
|
|
820
|
-
$ sf package:version:create:list -v <value> [--
|
|
792
|
+
$ sf package:version:create:list -v <value> [--api-version <value>] [-c <value>] [-s Queued|InProgress|Success|Error]
|
|
821
793
|
[--show-conversions-only] [--verbose]
|
|
822
794
|
|
|
823
795
|
FLAGS
|
|
@@ -825,15 +797,13 @@ FLAGS
|
|
|
825
797
|
now. Use 0 for today.
|
|
826
798
|
-s, --status=<option> Status of the version creation request, used to filter the list.
|
|
827
799
|
<options: Queued|InProgress|Success|Error>
|
|
828
|
-
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
|
|
800
|
+
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the `target-dev-hub`
|
|
801
|
+
configuration variable is already set.
|
|
829
802
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
830
803
|
--show-conversions-only Filter the list output to display only converted package version.
|
|
831
804
|
--verbose Displays additional information at a slight performance cost, such as the version
|
|
832
805
|
name and number for each package version create request.
|
|
833
806
|
|
|
834
|
-
GLOBAL FLAGS
|
|
835
|
-
--json Format output as json.
|
|
836
|
-
|
|
837
807
|
DESCRIPTION
|
|
838
808
|
List package version creation requests.
|
|
839
809
|
|
|
@@ -868,7 +838,7 @@ EXAMPLES
|
|
|
868
838
|
$ sf package:version:create:list --created-last-days 0 --status Success
|
|
869
839
|
```
|
|
870
840
|
|
|
871
|
-
_See code: [src/commands/package/version/create/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
841
|
+
_See code: [src/commands/package/version/create/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.3/src/commands/package/version/create/list.ts)_
|
|
872
842
|
|
|
873
843
|
## `sf package:version:create:report`
|
|
874
844
|
|
|
@@ -876,17 +846,15 @@ Retrieve details about a package version creation request.
|
|
|
876
846
|
|
|
877
847
|
```
|
|
878
848
|
USAGE
|
|
879
|
-
$ sf package:version:create:report -v <value> -i <value> [--
|
|
849
|
+
$ sf package:version:create:report -v <value> -i <value> [--api-version <value>]
|
|
880
850
|
|
|
881
851
|
FLAGS
|
|
882
852
|
-i, --package-create-request-id=<value> (required) ID (starts with 08c) of the package version creation request you
|
|
883
853
|
want to display.
|
|
884
|
-
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
|
|
854
|
+
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the
|
|
855
|
+
`target-dev-hub` configuration variable is already set.
|
|
885
856
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
886
857
|
|
|
887
|
-
GLOBAL FLAGS
|
|
888
|
-
--json Format output as json.
|
|
889
|
-
|
|
890
858
|
DESCRIPTION
|
|
891
859
|
Retrieve details about a package version creation request.
|
|
892
860
|
|
|
@@ -909,7 +877,7 @@ EXAMPLES
|
|
|
909
877
|
$ sf package:version:create:report --package-create-request-id 08c... --target-dev-hub devhub@example.com
|
|
910
878
|
```
|
|
911
879
|
|
|
912
|
-
_See code: [src/commands/package/version/create/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
880
|
+
_See code: [src/commands/package/version/create/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.3/src/commands/package/version/create/report.ts)_
|
|
913
881
|
|
|
914
882
|
## `sf package:version:delete`
|
|
915
883
|
|
|
@@ -917,17 +885,15 @@ Delete a package version.
|
|
|
917
885
|
|
|
918
886
|
```
|
|
919
887
|
USAGE
|
|
920
|
-
$ sf package:version:delete -v <value> -p <value> [--
|
|
888
|
+
$ sf package:version:delete -v <value> -p <value> [--api-version <value>] [-n]
|
|
921
889
|
|
|
922
890
|
FLAGS
|
|
923
891
|
-n, --no-prompt Don’t prompt before deleting the package version.
|
|
924
892
|
-p, --package=<value> (required) ID (starts with 04t) or alias of the package version to delete.
|
|
925
|
-
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
|
|
893
|
+
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the `target-dev-hub`
|
|
894
|
+
configuration variable is already set.
|
|
926
895
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
927
896
|
|
|
928
|
-
GLOBAL FLAGS
|
|
929
|
-
--json Format output as json.
|
|
930
|
-
|
|
931
897
|
DESCRIPTION
|
|
932
898
|
Delete a package version.
|
|
933
899
|
|
|
@@ -946,7 +912,7 @@ EXAMPLES
|
|
|
946
912
|
$ sf package:version:delete --package 04t... --target-org devhub@example.com
|
|
947
913
|
```
|
|
948
914
|
|
|
949
|
-
_See code: [src/commands/package/version/delete.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
915
|
+
_See code: [src/commands/package/version/delete.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.3/src/commands/package/version/delete.ts)_
|
|
950
916
|
|
|
951
917
|
## `sf package:version:displayancestry`
|
|
952
918
|
|
|
@@ -954,20 +920,18 @@ Display the ancestry tree for a 2GP managed package version.
|
|
|
954
920
|
|
|
955
921
|
```
|
|
956
922
|
USAGE
|
|
957
|
-
$ sf package:version:displayancestry -v <value> -p <value> [--
|
|
923
|
+
$ sf package:version:displayancestry -v <value> -p <value> [--api-version <value>] [--dot-code] [--verbose]
|
|
958
924
|
|
|
959
925
|
FLAGS
|
|
960
926
|
-p, --package=<value> (required) ID or alias of the package (starts with 0Ho) or package version (starts with
|
|
961
927
|
04t) to display ancestry for.
|
|
962
|
-
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
|
|
928
|
+
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the `target-dev-hub`
|
|
929
|
+
configuration variable is already set.
|
|
963
930
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
964
931
|
--dot-code Display the ancestry tree in DOT code.
|
|
965
932
|
--verbose Display both the package version ID (starts with 04t) and the version number
|
|
966
933
|
(major.minor.patch.build) in the ancestry tree.
|
|
967
934
|
|
|
968
|
-
GLOBAL FLAGS
|
|
969
|
-
--json Format output as json.
|
|
970
|
-
|
|
971
935
|
ALIASES
|
|
972
936
|
$ sf force:package:version:displayancestry
|
|
973
937
|
|
|
@@ -1003,7 +967,7 @@ FLAG DESCRIPTIONS
|
|
|
1003
967
|
You can use the DOT code output in graph visualization software to create tree visualizations.
|
|
1004
968
|
```
|
|
1005
969
|
|
|
1006
|
-
_See code: [src/commands/package/version/displayancestry.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
970
|
+
_See code: [src/commands/package/version/displayancestry.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.3/src/commands/package/version/displayancestry.ts)_
|
|
1007
971
|
|
|
1008
972
|
## `sf package:version:list`
|
|
1009
973
|
|
|
@@ -1011,8 +975,8 @@ List all package versions in the Dev Hub org.
|
|
|
1011
975
|
|
|
1012
976
|
```
|
|
1013
977
|
USAGE
|
|
1014
|
-
$ sf package:version:list -v <value> [--
|
|
1015
|
-
|
|
978
|
+
$ sf package:version:list -v <value> [--api-version <value>] [-c <value>] [--concise] [--show-conversions-only] [-m
|
|
979
|
+
<value>] [-p <value>] [-r] [-o <value>] [--verbose]
|
|
1016
980
|
|
|
1017
981
|
FLAGS
|
|
1018
982
|
-c, --created-last-days=<value> Number of days since the request was created, starting at 00:00:00 of first day to
|
|
@@ -1022,15 +986,13 @@ FLAGS
|
|
|
1022
986
|
-o, --order-by=<value> Package version fields used to order the list.
|
|
1023
987
|
-p, --packages=<value> Comma-delimited list of packages (aliases or 0Ho IDs) to list.
|
|
1024
988
|
-r, --released Display released versions only (IsReleased=true).
|
|
1025
|
-
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
|
|
989
|
+
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the
|
|
990
|
+
`target-dev-hub` configuration variable is already set.
|
|
1026
991
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1027
992
|
--concise Display limited package version details.
|
|
1028
993
|
--show-conversions-only Filter the list output to display only converted package version.
|
|
1029
994
|
--verbose Display extended package version details.
|
|
1030
995
|
|
|
1031
|
-
GLOBAL FLAGS
|
|
1032
|
-
--json Format output as json.
|
|
1033
|
-
|
|
1034
996
|
DESCRIPTION
|
|
1035
997
|
List all package versions in the Dev Hub org.
|
|
1036
998
|
|
|
@@ -1070,7 +1032,7 @@ EXAMPLES
|
|
|
1070
1032
|
$ sf package:version:list --packages exp-mgr,exp-mgr-util --released --modified-last-days 0
|
|
1071
1033
|
```
|
|
1072
1034
|
|
|
1073
|
-
_See code: [src/commands/package/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
1035
|
+
_See code: [src/commands/package/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.3/src/commands/package/version/list.ts)_
|
|
1074
1036
|
|
|
1075
1037
|
## `sf package:version:promote`
|
|
1076
1038
|
|
|
@@ -1078,17 +1040,15 @@ Promote a package version to released.
|
|
|
1078
1040
|
|
|
1079
1041
|
```
|
|
1080
1042
|
USAGE
|
|
1081
|
-
$ sf package:version:promote -v <value> -p <value> [--
|
|
1043
|
+
$ sf package:version:promote -v <value> -p <value> [--api-version <value>] [-n]
|
|
1082
1044
|
|
|
1083
1045
|
FLAGS
|
|
1084
1046
|
-n, --no-prompt Don't prompt to confirm setting the package version as released.
|
|
1085
1047
|
-p, --package=<value> (required) ID (starts with 04t) or alias of the package version to promote.
|
|
1086
|
-
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
|
|
1048
|
+
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the `target-dev-hub`
|
|
1049
|
+
configuration variable is already set.
|
|
1087
1050
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1088
1051
|
|
|
1089
|
-
GLOBAL FLAGS
|
|
1090
|
-
--json Format output as json.
|
|
1091
|
-
|
|
1092
1052
|
DESCRIPTION
|
|
1093
1053
|
Promote a package version to released.
|
|
1094
1054
|
|
|
@@ -1112,7 +1072,7 @@ EXAMPLES
|
|
|
1112
1072
|
$ sf package:version:promote --package "Awesome Package Alias"
|
|
1113
1073
|
```
|
|
1114
1074
|
|
|
1115
|
-
_See code: [src/commands/package/version/promote.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
1075
|
+
_See code: [src/commands/package/version/promote.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.3/src/commands/package/version/promote.ts)_
|
|
1116
1076
|
|
|
1117
1077
|
## `sf package:version:report`
|
|
1118
1078
|
|
|
@@ -1120,17 +1080,15 @@ Retrieve details about a package version in the Dev Hub org.
|
|
|
1120
1080
|
|
|
1121
1081
|
```
|
|
1122
1082
|
USAGE
|
|
1123
|
-
$ sf package:version:report -v <value> -p <value> [--
|
|
1083
|
+
$ sf package:version:report -v <value> -p <value> [--api-version <value>] [--verbose]
|
|
1124
1084
|
|
|
1125
1085
|
FLAGS
|
|
1126
1086
|
-p, --package=<value> (required) ID (starts with 04t) or alias of the package to retrieve details for.
|
|
1127
|
-
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
|
|
1087
|
+
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the `target-dev-hub`
|
|
1088
|
+
configuration variable is already set.
|
|
1128
1089
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1129
1090
|
--verbose Display extended package version details.
|
|
1130
1091
|
|
|
1131
|
-
GLOBAL FLAGS
|
|
1132
|
-
--json Format output as json.
|
|
1133
|
-
|
|
1134
1092
|
DESCRIPTION
|
|
1135
1093
|
Retrieve details about a package version in the Dev Hub org.
|
|
1136
1094
|
|
|
@@ -1150,7 +1108,7 @@ EXAMPLES
|
|
|
1150
1108
|
$ sf package:version:report --package "Your Package Alias" --target-dev-hub devhub@example.com
|
|
1151
1109
|
```
|
|
1152
1110
|
|
|
1153
|
-
_See code: [src/commands/package/version/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
1111
|
+
_See code: [src/commands/package/version/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.3/src/commands/package/version/report.ts)_
|
|
1154
1112
|
|
|
1155
1113
|
## `sf package:version:update`
|
|
1156
1114
|
|
|
@@ -1158,8 +1116,8 @@ Update a package version.
|
|
|
1158
1116
|
|
|
1159
1117
|
```
|
|
1160
1118
|
USAGE
|
|
1161
|
-
$ sf package:version:update -v <value> -p <value> [--
|
|
1162
|
-
|
|
1119
|
+
$ sf package:version:update -v <value> -p <value> [--api-version <value>] [-a <value>] [-e <value>] [-b <value>] [-t
|
|
1120
|
+
<value>] [-k <value>]
|
|
1163
1121
|
|
|
1164
1122
|
FLAGS
|
|
1165
1123
|
-a, --version-name=<value> New package version name.
|
|
@@ -1168,12 +1126,10 @@ FLAGS
|
|
|
1168
1126
|
-k, --installation-key=<value> New installation key for key-protected package (default: null)
|
|
1169
1127
|
-p, --package=<value> (required) ID (starts with 04t) or alias of the package to update a version of.
|
|
1170
1128
|
-t, --tag=<value> New package version tag.
|
|
1171
|
-
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
|
|
1129
|
+
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the
|
|
1130
|
+
`target-dev-hub` configuration variable is already set.
|
|
1172
1131
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1173
1132
|
|
|
1174
|
-
GLOBAL FLAGS
|
|
1175
|
-
--json Format output as json.
|
|
1176
|
-
|
|
1177
1133
|
DESCRIPTION
|
|
1178
1134
|
Update a package version.
|
|
1179
1135
|
|
|
@@ -1201,6 +1157,6 @@ EXAMPLES
|
|
|
1201
1157
|
$ sf package:version:update --package 04t... --version-description "New Package Version Description"
|
|
1202
1158
|
```
|
|
1203
1159
|
|
|
1204
|
-
_See code: [src/commands/package/version/update.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
1160
|
+
_See code: [src/commands/package/version/update.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.3/src/commands/package/version/update.ts)_
|
|
1205
1161
|
|
|
1206
1162
|
<!-- commandsstop -->
|