@salesforce/plugin-packaging 1.26.3 → 1.26.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 +50 -1183
- package/lib/commands/package/list.js.map +1 -1
- package/lib/commands/package/version/create.js +2 -1
- package/lib/commands/package/version/create.js.map +1 -1
- package/lib/commands/package/version/report.js.map +1 -1
- package/lib/commands/package/version/retrieve.js +1 -1
- package/lib/commands/package/version/retrieve.js.map +1 -1
- package/messages/package_version_create.md +4 -0
- package/oclif.lock +522 -437
- package/oclif.manifest.json +2 -1
- package/package.json +17 -18
package/README.md
CHANGED
|
@@ -30,28 +30,6 @@ See [DEVELOPING.md](DEVELOPING.md)
|
|
|
30
30
|
|
|
31
31
|
<!-- commands -->
|
|
32
32
|
|
|
33
|
-
- [`sf force:package1:version:create`](#sf-forcepackage1versioncreate)
|
|
34
|
-
- [`sf force:package1:version:create:get`](#sf-forcepackage1versioncreateget)
|
|
35
|
-
- [`sf force:package1:version:display`](#sf-forcepackage1versiondisplay)
|
|
36
|
-
- [`sf force:package1:version:list`](#sf-forcepackage1versionlist)
|
|
37
|
-
- [`sf force:package:create`](#sf-forcepackagecreate)
|
|
38
|
-
- [`sf force:package:delete`](#sf-forcepackagedelete)
|
|
39
|
-
- [`sf force:package:install`](#sf-forcepackageinstall)
|
|
40
|
-
- [`sf force:package:install:report`](#sf-forcepackageinstallreport)
|
|
41
|
-
- [`sf force:package:installed:list`](#sf-forcepackageinstalledlist)
|
|
42
|
-
- [`sf force:package:list`](#sf-forcepackagelist)
|
|
43
|
-
- [`sf force:package:uninstall`](#sf-forcepackageuninstall)
|
|
44
|
-
- [`sf force:package:uninstall:report`](#sf-forcepackageuninstallreport)
|
|
45
|
-
- [`sf force:package:update`](#sf-forcepackageupdate)
|
|
46
|
-
- [`sf force:package:version:create`](#sf-forcepackageversioncreate)
|
|
47
|
-
- [`sf force:package:version:create:list`](#sf-forcepackageversioncreatelist)
|
|
48
|
-
- [`sf force:package:version:create:report`](#sf-forcepackageversioncreatereport)
|
|
49
|
-
- [`sf force:package:version:delete`](#sf-forcepackageversiondelete)
|
|
50
|
-
- [`sf force:package:version:displayancestry`](#sf-forcepackageversiondisplayancestry)
|
|
51
|
-
- [`sf force:package:version:list`](#sf-forcepackageversionlist)
|
|
52
|
-
- [`sf force:package:version:promote`](#sf-forcepackageversionpromote)
|
|
53
|
-
- [`sf force:package:version:report`](#sf-forcepackageversionreport)
|
|
54
|
-
- [`sf force:package:version:update`](#sf-forcepackageversionupdate)
|
|
55
33
|
- [`sf package1:version:create`](#sf-package1versioncreate)
|
|
56
34
|
- [`sf package1:version:create:get`](#sf-package1versioncreateget)
|
|
57
35
|
- [`sf package1:version:display`](#sf-package1versiondisplay)
|
|
@@ -75,1116 +53,6 @@ See [DEVELOPING.md](DEVELOPING.md)
|
|
|
75
53
|
- [`sf package:version:report`](#sf-packageversionreport)
|
|
76
54
|
- [`sf package:version:update`](#sf-packageversionupdate)
|
|
77
55
|
|
|
78
|
-
## `sf force:package1:version:create`
|
|
79
|
-
|
|
80
|
-
Create a first-generation package version in the release org.
|
|
81
|
-
|
|
82
|
-
```
|
|
83
|
-
USAGE
|
|
84
|
-
$ sf force:package1:version:create -o <value> -i <value> -n <value> [--json] [--api-version <value>] [-d <value>] [-v <value>]
|
|
85
|
-
[-m] [-r <value>] [-p <value>] [-k <value>] [-w <value>]
|
|
86
|
-
|
|
87
|
-
FLAGS
|
|
88
|
-
-d, --description=<value> Package version description.
|
|
89
|
-
-i, --package-id=<value> (required) ID of the metadata package (starts with 033) of which you’re creating a
|
|
90
|
-
new version.
|
|
91
|
-
-k, --installation-key=<value> Installation key for key-protected package (default: null).
|
|
92
|
-
-m, --managed-released Create a managed package version.
|
|
93
|
-
-n, --name=<value> (required) Package version name.
|
|
94
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
95
|
-
-p, --post-install-url=<value> Post install URL.
|
|
96
|
-
-r, --release-notes-url=<value> Release notes URL.
|
|
97
|
-
-v, --version=<value> Package version in major.minor format, for example, 3.2.
|
|
98
|
-
-w, --wait=<value> Minutes to wait for the package version to be created (default: 2 minutes).
|
|
99
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
100
|
-
|
|
101
|
-
GLOBAL FLAGS
|
|
102
|
-
--json Format output as json.
|
|
103
|
-
|
|
104
|
-
DESCRIPTION
|
|
105
|
-
Create a first-generation package version in the release org.
|
|
106
|
-
|
|
107
|
-
The package version is based on the contents of the specified metadata package. Omit --managed-released if you want to
|
|
108
|
-
create an unmanaged package version.
|
|
109
|
-
|
|
110
|
-
ALIASES
|
|
111
|
-
$ sf force:package1:version:create
|
|
112
|
-
|
|
113
|
-
EXAMPLES
|
|
114
|
-
Create a first-generation package version from the package with the specified ID and name the package version
|
|
115
|
-
"example"; use your default org:
|
|
116
|
-
|
|
117
|
-
$ sf force:package1:version:create --package-id 033... --name example
|
|
118
|
-
|
|
119
|
-
Same as previous example, but provide a description and wait for 30 minutes for the package version to be created;
|
|
120
|
-
use the specified org:
|
|
121
|
-
|
|
122
|
-
$ sf force:package1:version:create --package-id 033... --name example --description "example description" --wait \
|
|
123
|
-
30 --target-org myorg@example.com
|
|
124
|
-
|
|
125
|
-
FLAG DESCRIPTIONS
|
|
126
|
-
-m, --managed-released Create a managed package version.
|
|
127
|
-
|
|
128
|
-
To create a beta version, don’t include this parameter.
|
|
129
|
-
|
|
130
|
-
-p, --post-install-url=<value> Post install URL.
|
|
131
|
-
|
|
132
|
-
The contents of the post-installation instructions URL are displayed in the UI after installation of the package
|
|
133
|
-
version.
|
|
134
|
-
|
|
135
|
-
-r, --release-notes-url=<value> Release notes URL.
|
|
136
|
-
|
|
137
|
-
This link is displayed in the package installation UI to provide release notes for this package version to
|
|
138
|
-
subscribers.
|
|
139
|
-
```
|
|
140
|
-
|
|
141
|
-
## `sf force:package1:version:create:get`
|
|
142
|
-
|
|
143
|
-
Retrieve the status of a package version creation request.
|
|
144
|
-
|
|
145
|
-
```
|
|
146
|
-
USAGE
|
|
147
|
-
$ sf force:package1:version:create:get -o <value> -i <value> [--json] [--api-version <value>]
|
|
148
|
-
|
|
149
|
-
FLAGS
|
|
150
|
-
-i, --request-id=<value> (required) ID of the PackageUploadRequest (starts with 0HD).
|
|
151
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
152
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
153
|
-
|
|
154
|
-
GLOBAL FLAGS
|
|
155
|
-
--json Format output as json.
|
|
156
|
-
|
|
157
|
-
ALIASES
|
|
158
|
-
$ sf force:package1:version:create:get
|
|
159
|
-
|
|
160
|
-
EXAMPLES
|
|
161
|
-
Get the status of the creation request for the package version with the specified ID in your default org:
|
|
162
|
-
|
|
163
|
-
$ sf force:package1:version:create:get --request-id 0HD...
|
|
164
|
-
|
|
165
|
-
Same as previous example, but use the specified org:
|
|
166
|
-
|
|
167
|
-
$ sf force:package1:version:create:get --request-id 0HD... --target-org myorg@example.com
|
|
168
|
-
```
|
|
169
|
-
|
|
170
|
-
## `sf force:package1:version:display`
|
|
171
|
-
|
|
172
|
-
Display details about a first-generation package version.
|
|
173
|
-
|
|
174
|
-
```
|
|
175
|
-
USAGE
|
|
176
|
-
$ sf force:package1:version:display -o <value> -i <value> [--json] [--api-version <value>]
|
|
177
|
-
|
|
178
|
-
FLAGS
|
|
179
|
-
-i, --package-version-id=<value> (required) ID (starts with 04t) of the metadata package version whose details you
|
|
180
|
-
want to display.
|
|
181
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
182
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
183
|
-
|
|
184
|
-
GLOBAL FLAGS
|
|
185
|
-
--json Format output as json.
|
|
186
|
-
|
|
187
|
-
ALIASES
|
|
188
|
-
$ sf force:package1:version:display
|
|
189
|
-
|
|
190
|
-
EXAMPLES
|
|
191
|
-
Display details about the first-generation package version with the specified ID in your default org:
|
|
192
|
-
|
|
193
|
-
$ sf force:package1:version:display --package-version-id 04t...
|
|
194
|
-
|
|
195
|
-
Same as previous example, but use the specified org:
|
|
196
|
-
|
|
197
|
-
$ sf force:package1:version:display --package-version-id 04t... --target-org myorg@example.com
|
|
198
|
-
```
|
|
199
|
-
|
|
200
|
-
## `sf force:package1:version:list`
|
|
201
|
-
|
|
202
|
-
List package versions for the specified first-generation package or for the org.
|
|
203
|
-
|
|
204
|
-
```
|
|
205
|
-
USAGE
|
|
206
|
-
$ sf force:package1:version:list -o <value> [--json] [--api-version <value>] [-i <value>]
|
|
207
|
-
|
|
208
|
-
FLAGS
|
|
209
|
-
-i, --package-id=<value> Metadata package ID (starts with 033) whose package versions you want to list.
|
|
210
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
211
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
212
|
-
|
|
213
|
-
GLOBAL FLAGS
|
|
214
|
-
--json Format output as json.
|
|
215
|
-
|
|
216
|
-
ALIASES
|
|
217
|
-
$ sf force:package1:version:list
|
|
218
|
-
|
|
219
|
-
EXAMPLES
|
|
220
|
-
List all first-generation package versions in your default org:
|
|
221
|
-
|
|
222
|
-
$ sf force:package1:version:list
|
|
223
|
-
|
|
224
|
-
List package versions for the specified first-generation package in the specifief org:
|
|
225
|
-
|
|
226
|
-
$ sf force:package1:version:list --package-id 033... --target-org myorg@example.com
|
|
227
|
-
|
|
228
|
-
FLAG DESCRIPTIONS
|
|
229
|
-
-i, --package-id=<value> Metadata package ID (starts with 033) whose package versions you want to list.
|
|
230
|
-
|
|
231
|
-
If not specified, shows all versions for all packages (managed and unmanaged) in the org.
|
|
232
|
-
```
|
|
233
|
-
|
|
234
|
-
## `sf force:package:create`
|
|
235
|
-
|
|
236
|
-
Create a package.
|
|
237
|
-
|
|
238
|
-
```
|
|
239
|
-
USAGE
|
|
240
|
-
$ sf force:package:create -v <value> -n <value> -t Managed|Unlocked -r <value> [--json] [--api-version <value>] [-d
|
|
241
|
-
<value>] [-e] [--org-dependent] [-o <value>]
|
|
242
|
-
|
|
243
|
-
FLAGS
|
|
244
|
-
-d, --description=<value> Description of the package.
|
|
245
|
-
-e, --no-namespace Create the package with no namespace; available only for unlocked packages.
|
|
246
|
-
-n, --name=<value> (required) Name of the package to create.
|
|
247
|
-
-o, --error-notification-username=<value> Active Dev Hub user designated to receive email notifications for package
|
|
248
|
-
errors.
|
|
249
|
-
-r, --path=<value> (required) Path to directory that contains the contents of the package.
|
|
250
|
-
-t, --package-type=<option> (required) Type of package.
|
|
251
|
-
<options: Managed|Unlocked>
|
|
252
|
-
-v, --target-dev-hub=<value> (required) [default: william.ruemmele@brave-bear-5fmf7j.com] Username or
|
|
253
|
-
alias of the Dev Hub org.
|
|
254
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
255
|
-
--org-dependent Depends on unpackaged metadata in the installation org; applies to unlocked
|
|
256
|
-
packages only.
|
|
257
|
-
|
|
258
|
-
GLOBAL FLAGS
|
|
259
|
-
--json Format output as json.
|
|
260
|
-
|
|
261
|
-
DESCRIPTION
|
|
262
|
-
Create a package.
|
|
263
|
-
|
|
264
|
-
First, use this command to create a package. Then create a package version.
|
|
265
|
-
|
|
266
|
-
If you don’t have a namespace defined in your sfdx-project.json file, use --no-namespace.
|
|
267
|
-
|
|
268
|
-
Your --name value must be unique within your namespace.
|
|
269
|
-
|
|
270
|
-
Run 'sf package list to list all packages in the Dev Hub org.
|
|
271
|
-
|
|
272
|
-
ALIASES
|
|
273
|
-
$ sf force:package:create
|
|
274
|
-
|
|
275
|
-
EXAMPLES
|
|
276
|
-
Create an unlocked package from the files in the "force-app" directory; uses your default Dev Hub org:
|
|
277
|
-
|
|
278
|
-
$ sf force:package:create --name MyUnlockedPackage --package-type Unlocked --path force-app
|
|
279
|
-
|
|
280
|
-
Create a managed packaged from the "force-app" directory files, give the package a description, and use the
|
|
281
|
-
specified Dev Hub org:
|
|
282
|
-
|
|
283
|
-
$ sf force:package:create --name MyManagedPackage --description "Your Package Descripton" --package-type Managed \
|
|
284
|
-
--path force-app --target-dev-hub devhub@example.com
|
|
285
|
-
|
|
286
|
-
FLAG DESCRIPTIONS
|
|
287
|
-
-e, --no-namespace Create the package with no namespace; available only for unlocked packages.
|
|
288
|
-
|
|
289
|
-
This flag is useful when you’re migrating an existing org to packages. But use a namespaced package for new
|
|
290
|
-
metadata.
|
|
291
|
-
|
|
292
|
-
-o, --error-notification-username=<value>
|
|
293
|
-
|
|
294
|
-
Active Dev Hub user designated to receive email notifications for package errors.
|
|
295
|
-
|
|
296
|
-
Email notifications include information about unhandled Apex exceptions, and install, upgrade, or uninstall failures
|
|
297
|
-
associated with your package.
|
|
298
|
-
|
|
299
|
-
-t, --package-type=Managed|Unlocked Type of package.
|
|
300
|
-
|
|
301
|
-
The options for package type are Managed and Unlocked (Managed=DeveloperManagedSubscriberManaged,
|
|
302
|
-
Unlocked=DeveloperControlledSubscriberEditable). These options determine upgrade and editability rules.
|
|
303
|
-
|
|
304
|
-
--org-dependent Depends on unpackaged metadata in the installation org; applies to unlocked packages only.
|
|
305
|
-
|
|
306
|
-
Use Source Tracking in Sandboxes to develop your org-dependent unlocked package. For more information, see "Create
|
|
307
|
-
Org-Dependent Unlocked Packages" in the Salesforce DX Developer Guide.
|
|
308
|
-
```
|
|
309
|
-
|
|
310
|
-
## `sf force:package:delete`
|
|
311
|
-
|
|
312
|
-
Delete a package.
|
|
313
|
-
|
|
314
|
-
```
|
|
315
|
-
USAGE
|
|
316
|
-
$ sf force:package:delete -v <value> -p <value> [--json] [--api-version <value>] [-n]
|
|
317
|
-
|
|
318
|
-
FLAGS
|
|
319
|
-
-n, --no-prompt Don’t prompt before deleting the package.
|
|
320
|
-
-p, --package=<value> (required) ID (starts with 0Ho) or alias of the package to delete.
|
|
321
|
-
-v, --target-dev-hub=<value> (required) [default: william.ruemmele@brave-bear-5fmf7j.com] Username or alias of the
|
|
322
|
-
Dev Hub org.
|
|
323
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
324
|
-
|
|
325
|
-
GLOBAL FLAGS
|
|
326
|
-
--json Format output as json.
|
|
327
|
-
|
|
328
|
-
DESCRIPTION
|
|
329
|
-
Delete a package.
|
|
330
|
-
|
|
331
|
-
Specify the ID or alias of the package you want to delete.
|
|
332
|
-
|
|
333
|
-
Delete unlocked and second-generation managed packages. Before you delete a package, first delete all associated
|
|
334
|
-
package versions.
|
|
335
|
-
|
|
336
|
-
ALIASES
|
|
337
|
-
$ sf force:package:delete
|
|
338
|
-
|
|
339
|
-
EXAMPLES
|
|
340
|
-
Delete a package using its alias from your default Dev Hub org:
|
|
341
|
-
|
|
342
|
-
$ sf force:package:delete --package "Your Package Alias"
|
|
343
|
-
|
|
344
|
-
Delete a package using its ID from the specified Dev Hub org:
|
|
345
|
-
|
|
346
|
-
$ sf force:package:delete --package 0Ho... --target-dev-hub devhub@example.com
|
|
347
|
-
```
|
|
348
|
-
|
|
349
|
-
## `sf force:package:install`
|
|
350
|
-
|
|
351
|
-
Install a version of a package in the target org.
|
|
352
|
-
|
|
353
|
-
```
|
|
354
|
-
USAGE
|
|
355
|
-
$ sf force:package:install -o <value> -p <value> [--json] [--api-version <value>] [-w <value>] [-k <value>] [-b <value>]
|
|
356
|
-
[-r] [-a all|package] [-s AllUsers|AdminsOnly] [-t DeprecateOnly|Mixed|Delete]
|
|
357
|
-
|
|
358
|
-
FLAGS
|
|
359
|
-
-a, --apex-compile=<option> [default: all] Compile all Apex in the org and package, or only Apex in the package;
|
|
360
|
-
unlocked packages only.
|
|
361
|
-
<options: all|package>
|
|
362
|
-
-b, --publish-wait=<value> [default: 0 minutes] Maximum number of minutes to wait for the Subscriber Package
|
|
363
|
-
Version ID to become available in the target org before canceling the install request.
|
|
364
|
-
-k, --installation-key=<value> Installation key for key-protected package (default: null).
|
|
365
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
366
|
-
-p, --package=<value> (required) ID (starts with 04t) or alias of the package version to install.
|
|
367
|
-
-r, --no-prompt Don't prompt for confirmation.
|
|
368
|
-
-s, --security-type=<option> [default: AdminsOnly] Security access type for the installed package. (deprecation
|
|
369
|
-
notice: The default --security-type value will change from AllUsers to AdminsOnly in
|
|
370
|
-
v47.0 or later.)
|
|
371
|
-
<options: AllUsers|AdminsOnly>
|
|
372
|
-
-t, --upgrade-type=<option> [default: Mixed] Upgrade type for the package installation; available only for
|
|
373
|
-
unlocked packages.
|
|
374
|
-
<options: DeprecateOnly|Mixed|Delete>
|
|
375
|
-
-w, --wait=<value> [default: 0 minutes] Number of minutes to wait for installation status.
|
|
376
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
377
|
-
|
|
378
|
-
GLOBAL FLAGS
|
|
379
|
-
--json Format output as json.
|
|
380
|
-
|
|
381
|
-
DESCRIPTION
|
|
382
|
-
Install a version of a package in the target org.
|
|
383
|
-
|
|
384
|
-
To install a package, specify a specific version of the package using the 04t package ID. The package and the version
|
|
385
|
-
you specified installs in your default target org unless you supply the username for a different target org.
|
|
386
|
-
|
|
387
|
-
For package upgrades, to specify options for component deprecation or deletion of removed components, include an
|
|
388
|
-
--upgrade-type value. To delete components that can be safely deleted and deprecate the others, specify --upgrade-type
|
|
389
|
-
Mixed (the default). To deprecate all removed components, specify --upgrade-type DeprecateOnly. To delete all removed
|
|
390
|
-
components, except for custom objects and custom fields, that don't have dependencies, specify --upgrade-type Delete.
|
|
391
|
-
(Note: This option can result in the loss of data that is associated with the deleted components.) The default is
|
|
392
|
-
Mixed.
|
|
393
|
-
|
|
394
|
-
ALIASES
|
|
395
|
-
$ sf force:package:install
|
|
396
|
-
|
|
397
|
-
EXAMPLES
|
|
398
|
-
Install a package version with the specified ID in the org with username "me@example.com":
|
|
399
|
-
|
|
400
|
-
$ sf force:package:install --package 04t... --target-org me@example.com
|
|
401
|
-
|
|
402
|
-
Install a package version with the specified alias into your default org:
|
|
403
|
-
|
|
404
|
-
$ sf force:package:install --package awesome_package_alias
|
|
405
|
-
|
|
406
|
-
Install a package version with an alias that includes spaces into your default org:
|
|
407
|
-
|
|
408
|
-
$ sf force:package:install --package "Awesome Package Alias"
|
|
409
|
-
|
|
410
|
-
Install an unlocked package version with the specified ID and deprecate all removed components:
|
|
411
|
-
|
|
412
|
-
$ sf force:package:install --package 04t... --upgrade-type DeprecateOnly
|
|
413
|
-
|
|
414
|
-
FLAG DESCRIPTIONS
|
|
415
|
-
-a, --apex-compile=all|package
|
|
416
|
-
|
|
417
|
-
Compile all Apex in the org and package, or only Apex in the package; unlocked packages only.
|
|
418
|
-
|
|
419
|
-
Applies to unlocked packages only. Specifies whether to compile all Apex in the org and package, or only the Apex in
|
|
420
|
-
the package.
|
|
421
|
-
|
|
422
|
-
For package installs into production orgs, or any org that has Apex Compile on Deploy enabled, the platform compiles
|
|
423
|
-
all Apex in the org after the package install or upgrade operation completes.
|
|
424
|
-
|
|
425
|
-
This approach assures that package installs and upgrades don’t impact the performance of an org, and is done even if
|
|
426
|
-
--apex-compile package is specified.
|
|
427
|
-
|
|
428
|
-
-r, --no-prompt Don't prompt for confirmation.
|
|
429
|
-
|
|
430
|
-
Allows the following without an explicit confirmation response: 1) Remote Site Settings and Content Security Policy
|
|
431
|
-
websites to send or receive data, and 2) --upgrade-type Delete to proceed.
|
|
432
|
-
|
|
433
|
-
-t, --upgrade-type=DeprecateOnly|Mixed|Delete
|
|
434
|
-
|
|
435
|
-
Upgrade type for the package installation; available only for unlocked packages.
|
|
436
|
-
|
|
437
|
-
For package upgrades, specifies whether to mark all removed components as deprecated (DeprecateOnly), to delete
|
|
438
|
-
removed components that can be safely deleted and deprecate the others (Mixed), or to delete all removed components,
|
|
439
|
-
except for custom objects and custom fields, that don't have dependencies (Delete). The default is Mixed. Can
|
|
440
|
-
specify DeprecateOnly or Delete only for unlocked package upgrades.
|
|
441
|
-
```
|
|
442
|
-
|
|
443
|
-
## `sf force:package:install:report`
|
|
444
|
-
|
|
445
|
-
Retrieve the status of a package installation request.
|
|
446
|
-
|
|
447
|
-
```
|
|
448
|
-
USAGE
|
|
449
|
-
$ sf force:package:install:report -o <value> -i <value> [--json] [--api-version <value>]
|
|
450
|
-
|
|
451
|
-
FLAGS
|
|
452
|
-
-i, --request-id=<value> (required) ID of the package install request you want to check; starts with 0Hf.
|
|
453
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
454
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
455
|
-
|
|
456
|
-
GLOBAL FLAGS
|
|
457
|
-
--json Format output as json.
|
|
458
|
-
|
|
459
|
-
ALIASES
|
|
460
|
-
$ sf force:package:install:report
|
|
461
|
-
|
|
462
|
-
EXAMPLES
|
|
463
|
-
Retrieve the status of a package installation request with the specified ID on your default org:
|
|
464
|
-
|
|
465
|
-
$ sf force:package:install:report --request-id 0Hf...
|
|
466
|
-
|
|
467
|
-
Similar to previous example, except use the org with username me@example.com:
|
|
468
|
-
|
|
469
|
-
$ sf force:package:install:report --request-id 0Hf... --target-org me@example.com
|
|
470
|
-
```
|
|
471
|
-
|
|
472
|
-
## `sf force:package:installed:list`
|
|
473
|
-
|
|
474
|
-
List the org’s installed packages.
|
|
475
|
-
|
|
476
|
-
```
|
|
477
|
-
USAGE
|
|
478
|
-
$ sf force:package:installed:list -o <value> [--json] [--api-version <value>]
|
|
479
|
-
|
|
480
|
-
FLAGS
|
|
481
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
482
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
483
|
-
|
|
484
|
-
GLOBAL FLAGS
|
|
485
|
-
--json Format output as json.
|
|
486
|
-
|
|
487
|
-
ALIASES
|
|
488
|
-
$ sf force:package:installed:list
|
|
489
|
-
|
|
490
|
-
EXAMPLES
|
|
491
|
-
List the installed packages in your default org:
|
|
492
|
-
|
|
493
|
-
$ sf force:package:installed:list
|
|
494
|
-
|
|
495
|
-
List the installed packages in the org with username me@example.com:
|
|
496
|
-
|
|
497
|
-
$ sf force:package:installed:list --target-org me@example.com
|
|
498
|
-
```
|
|
499
|
-
|
|
500
|
-
## `sf force:package:list`
|
|
501
|
-
|
|
502
|
-
List all packages in the Dev Hub org.
|
|
503
|
-
|
|
504
|
-
```
|
|
505
|
-
USAGE
|
|
506
|
-
$ sf force:package:list -v <value> [--json] [--api-version <value>] [--verbose]
|
|
507
|
-
|
|
508
|
-
FLAGS
|
|
509
|
-
-v, --target-dev-hub=<value> (required) [default: william.ruemmele@brave-bear-5fmf7j.com] Username or alias of the
|
|
510
|
-
Dev Hub org.
|
|
511
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
512
|
-
--verbose Display extended package detail.
|
|
513
|
-
|
|
514
|
-
GLOBAL FLAGS
|
|
515
|
-
--json Format output as json.
|
|
516
|
-
|
|
517
|
-
DESCRIPTION
|
|
518
|
-
List all packages in the Dev Hub org.
|
|
519
|
-
|
|
520
|
-
Description
|
|
521
|
-
|
|
522
|
-
ALIASES
|
|
523
|
-
$ sf force:package:list
|
|
524
|
-
|
|
525
|
-
EXAMPLES
|
|
526
|
-
List all packages in the specified Dev Hub org:
|
|
527
|
-
|
|
528
|
-
$ sf force:package:list --target-dev-hub devhub@example.com
|
|
529
|
-
|
|
530
|
-
List all packages details in the specified Dev Hub org, and show extended details about each package:
|
|
531
|
-
|
|
532
|
-
$ sf force:package:list --target-dev-hub devhub@example.com --verbose
|
|
533
|
-
```
|
|
534
|
-
|
|
535
|
-
## `sf force:package:uninstall`
|
|
536
|
-
|
|
537
|
-
Uninstall a second-generation package from the target org.
|
|
538
|
-
|
|
539
|
-
```
|
|
540
|
-
USAGE
|
|
541
|
-
$ sf force:package:uninstall -o <value> -p <value> [--json] [--api-version <value>] [-w <value>]
|
|
542
|
-
|
|
543
|
-
FLAGS
|
|
544
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
545
|
-
-p, --package=<value> (required) ID (starts with 04t) or alias of the package version to uninstall.
|
|
546
|
-
-w, --wait=<value> [default: 0 minutes] Number of minutes to wait for uninstall status.
|
|
547
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
548
|
-
|
|
549
|
-
GLOBAL FLAGS
|
|
550
|
-
--json Format output as json.
|
|
551
|
-
|
|
552
|
-
DESCRIPTION
|
|
553
|
-
Uninstall a second-generation package from the target org.
|
|
554
|
-
|
|
555
|
-
Specify the package ID for a second-generation package.
|
|
556
|
-
|
|
557
|
-
To list the org’s installed packages, run "sf package installed list".
|
|
558
|
-
|
|
559
|
-
To uninstall a first-generation package, from Setup, enter Installed Packages in the Quick Find box, then select
|
|
560
|
-
Installed Packages.
|
|
561
|
-
|
|
562
|
-
ALIASES
|
|
563
|
-
$ sf force:package:uninstall
|
|
564
|
-
|
|
565
|
-
EXAMPLES
|
|
566
|
-
Uninstall a package with specified ID from an org with username me@example.com:
|
|
567
|
-
|
|
568
|
-
$ sf force:package:uninstall --package 04t... --target-org me@example.com
|
|
569
|
-
|
|
570
|
-
Uninstall a package with the specified alias from your default org:
|
|
571
|
-
|
|
572
|
-
$ sf force:package:uninstall --package undesirable_package_alias
|
|
573
|
-
|
|
574
|
-
Uninstall a package with an alias that contains spaces from your default org:
|
|
575
|
-
|
|
576
|
-
$ sf force:package:uninstall --package "Undesirable Package Alias"
|
|
577
|
-
```
|
|
578
|
-
|
|
579
|
-
## `sf force:package:uninstall:report`
|
|
580
|
-
|
|
581
|
-
Retrieve the status of a package uninstall request.
|
|
582
|
-
|
|
583
|
-
```
|
|
584
|
-
USAGE
|
|
585
|
-
$ sf force:package:uninstall:report -o <value> -i <value> [--json] [--api-version <value>]
|
|
586
|
-
|
|
587
|
-
FLAGS
|
|
588
|
-
-i, --request-id=<value> (required) ID of the package uninstall request you want to check; starts with 06y.
|
|
589
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
590
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
591
|
-
|
|
592
|
-
GLOBAL FLAGS
|
|
593
|
-
--json Format output as json.
|
|
594
|
-
|
|
595
|
-
ALIASES
|
|
596
|
-
$ sf force:package:uninstall:report
|
|
597
|
-
|
|
598
|
-
EXAMPLES
|
|
599
|
-
Retrieve the status of a package uninstall in your default org using the specified request ID:
|
|
600
|
-
|
|
601
|
-
$ sf force:package:uninstall:report --request-id 06y...
|
|
602
|
-
|
|
603
|
-
Similar to previous example, but use the org with username me@example.com:
|
|
604
|
-
|
|
605
|
-
$ sf force:package:uninstall:report --request-id 06y... --target-org me@example.com
|
|
606
|
-
```
|
|
607
|
-
|
|
608
|
-
## `sf force:package:update`
|
|
609
|
-
|
|
610
|
-
Update package details.
|
|
611
|
-
|
|
612
|
-
```
|
|
613
|
-
USAGE
|
|
614
|
-
$ sf force:package:update -v <value> -p <value> [--json] [--api-version <value>] [-n <value>] [-d <value>] [-o
|
|
615
|
-
<value>]
|
|
616
|
-
|
|
617
|
-
FLAGS
|
|
618
|
-
-d, --description=<value> New description of the package.
|
|
619
|
-
-n, --name=<value> New name of the package.
|
|
620
|
-
-o, --error-notification-username=<value> Active Dev Hub user designated to receive email notifications for package
|
|
621
|
-
errors.
|
|
622
|
-
-p, --package=<value> (required) ID (starts with 0Ho) or alias of the package to update.
|
|
623
|
-
-v, --target-dev-hub=<value> (required) [default: william.ruemmele@brave-bear-5fmf7j.com] Username or
|
|
624
|
-
alias of the Dev Hub org.
|
|
625
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
626
|
-
|
|
627
|
-
GLOBAL FLAGS
|
|
628
|
-
--json Format output as json.
|
|
629
|
-
|
|
630
|
-
DESCRIPTION
|
|
631
|
-
Update package details.
|
|
632
|
-
|
|
633
|
-
Specify a new value for each option you want to update.
|
|
634
|
-
|
|
635
|
-
Run "sf package list" to list all packages in the Dev Hub org.
|
|
636
|
-
|
|
637
|
-
ALIASES
|
|
638
|
-
$ sf force:package:update
|
|
639
|
-
|
|
640
|
-
EXAMPLES
|
|
641
|
-
Update the name of the package with the specified alias; uses your default Dev Hub org:
|
|
642
|
-
|
|
643
|
-
$ sf force:package:update --package "Your Package Alias" --name "New Package Name"
|
|
644
|
-
|
|
645
|
-
Update the description of the package with the specified ID; uses the specified Dev Hub org:
|
|
646
|
-
|
|
647
|
-
$ sf force:package:update --package 0Ho... --description "New Package Description" --target-dev-hub \
|
|
648
|
-
devhub@example.com
|
|
649
|
-
|
|
650
|
-
FLAG DESCRIPTIONS
|
|
651
|
-
-o, --error-notification-username=<value>
|
|
652
|
-
|
|
653
|
-
Active Dev Hub user designated to receive email notifications for package errors.
|
|
654
|
-
|
|
655
|
-
Email notifications include information about unhandled Apex exceptions, and install, upgrade, or uninstall failures
|
|
656
|
-
associated with your package.
|
|
657
|
-
```
|
|
658
|
-
|
|
659
|
-
## `sf force:package:version:create`
|
|
660
|
-
|
|
661
|
-
Create a package version in the Dev Hub org.
|
|
662
|
-
|
|
663
|
-
```
|
|
664
|
-
USAGE
|
|
665
|
-
$ sf force:package:version:create -v <value> [--json] [--api-version <value>] [-b <value>] [-c | --skip-validation] [-f <value>]
|
|
666
|
-
[-k <value>] [-x] [-p <value>] [-d <value>] [--post-install-script <value>] [--post-install-url <value>]
|
|
667
|
-
[--releasenotes-url <value>] [--skip-ancestor-check] [-t <value>] [--uninstall-script <value>] [-e <value>] [-a
|
|
668
|
-
<value>] [-n <value>] [-w <value>] [--language <value>] [--verbose]
|
|
669
|
-
|
|
670
|
-
FLAGS
|
|
671
|
-
-a, --version-name=<value> Name of the package version to be created; overrides the sfdx-project.json value.
|
|
672
|
-
-b, --branch=<value> Name of the branch in your source control system that the package version is based
|
|
673
|
-
on.
|
|
674
|
-
-c, --code-coverage Calculate and store the code coverage percentage by running the packaged Apex tests
|
|
675
|
-
included in this package version.
|
|
676
|
-
-d, --path=<value> Path to the directory that contains the contents of the package.
|
|
677
|
-
-e, --version-description=<value> Description of the package version to be created; overrides the sfdx-project.json
|
|
678
|
-
value.
|
|
679
|
-
-f, --definition-file=<value> Path to a definition file similar to scratch org definition file that contains the
|
|
680
|
-
list of features and org preferences that the metadata of the package version
|
|
681
|
-
depends on.
|
|
682
|
-
-k, --installation-key=<value> Installation key for key-protected package. (either --installation-key or
|
|
683
|
-
--installation-key-bypass is required)
|
|
684
|
-
-n, --version-number=<value> Version number of the package version to be created; overrides the
|
|
685
|
-
sfdx-project.json value.
|
|
686
|
-
-p, --package=<value> ID (starts with 0Ho) or alias of the package to create a version of.
|
|
687
|
-
-t, --tag=<value> Package version’s tag.
|
|
688
|
-
-v, --target-dev-hub=<value> (required) [default: william.ruemmele@brave-bear-5fmf7j.com] Username or alias of
|
|
689
|
-
the Dev Hub org.
|
|
690
|
-
-w, --wait=<value> [default: 0 minutes] Number of minutes to wait for the package version to be
|
|
691
|
-
created.
|
|
692
|
-
-x, --installation-key-bypass Bypass the installation key requirement. (either --installation-key or
|
|
693
|
-
--installation-key-bypass is required)
|
|
694
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
695
|
-
--language=<value> Language for the package.
|
|
696
|
-
--post-install-script=<value> Name of the post-install script; applies to managed packages only.
|
|
697
|
-
--post-install-url=<value> Post-install instructions URL.
|
|
698
|
-
--releasenotes-url=<value> Release notes URL.
|
|
699
|
-
--skip-ancestor-check Overrides ancestry requirements, which allows you to specify a package ancestor
|
|
700
|
-
that isn’t the highest released package version.
|
|
701
|
-
--skip-validation Skip validation during package version creation; you can’t promote unvalidated
|
|
702
|
-
package versions.
|
|
703
|
-
--uninstall-script=<value> Uninstall script name; applies to managed packages only.
|
|
704
|
-
--verbose Display verbose command output.
|
|
705
|
-
|
|
706
|
-
GLOBAL FLAGS
|
|
707
|
-
--json Format output as json.
|
|
708
|
-
|
|
709
|
-
DESCRIPTION
|
|
710
|
-
Create a package version in the Dev Hub org.
|
|
711
|
-
|
|
712
|
-
The package version is based on the package contents in the specified directory.
|
|
713
|
-
|
|
714
|
-
To retrieve details about a package version create request, including status and package version ID (04t), run "sf
|
|
715
|
-
package version create report -i 08c...".
|
|
716
|
-
|
|
717
|
-
We recommend that you specify the --installation-key parameter to protect the contents of your package and to prevent
|
|
718
|
-
unauthorized installation of your package.
|
|
719
|
-
|
|
720
|
-
To list package version creation requests in the org, run "sf package version create list".
|
|
721
|
-
To promote a package version to released, you must use the --code-coverage parameter. The package must also meet the
|
|
722
|
-
code coverage requirements. This requirement applies to both managed and unlocked packages.
|
|
723
|
-
|
|
724
|
-
We don’t calculate code coverage for org-dependent unlocked packages, or for package versions that specify
|
|
725
|
-
--skip-validation.
|
|
726
|
-
|
|
727
|
-
ALIASES
|
|
728
|
-
$ sf force:package:version:create
|
|
729
|
-
|
|
730
|
-
EXAMPLES
|
|
731
|
-
Create a package version from the contents of the "common" directory and give it an installation key of
|
|
732
|
-
"password123"; uses your default Dev Hub org:
|
|
733
|
-
|
|
734
|
-
$ sf force:package:version:create --path common --installation-key password123
|
|
735
|
-
|
|
736
|
-
Create a package version from a package with the specified alias; uses the Dev Hub org with username
|
|
737
|
-
devhub@example.com:
|
|
738
|
-
|
|
739
|
-
$ sf force:package:version:create --package "Your Package Alias" --installation-key password123 --target-dev-hub \
|
|
740
|
-
devhub@example.com
|
|
741
|
-
|
|
742
|
-
Create a package version from a package with the specified ID:
|
|
743
|
-
|
|
744
|
-
$ sf force:package:version:create --package 0Ho... --installation-key password123
|
|
745
|
-
|
|
746
|
-
Create a package version and skip the validation step:
|
|
747
|
-
|
|
748
|
-
$ sf force:package:version:create --path common --installation-key password123 --skip-validation
|
|
749
|
-
|
|
750
|
-
FLAG DESCRIPTIONS
|
|
751
|
-
-c, --code-coverage
|
|
752
|
-
|
|
753
|
-
Calculate and store the code coverage percentage by running the packaged Apex tests included in this package
|
|
754
|
-
version.
|
|
755
|
-
|
|
756
|
-
Before you can promote and release a managed or unlocked package version, the Apex code must meet a minimum 75% code
|
|
757
|
-
coverage requirement. We don’t calculate code coverage for org-dependent unlocked packages or for package versions
|
|
758
|
-
that specify --skip-validation.
|
|
759
|
-
|
|
760
|
-
-x, --installation-key-bypass
|
|
761
|
-
|
|
762
|
-
Bypass the installation key requirement. (either --installation-key or --installation-key-bypass is required)
|
|
763
|
-
|
|
764
|
-
If you bypass this requirement, anyone can install your package.
|
|
765
|
-
|
|
766
|
-
--language=<value> Language for the package.
|
|
767
|
-
|
|
768
|
-
Specify the language using a language code listed under "Supported Languages" in Salesforce Help. If no language is
|
|
769
|
-
specified, the language defaults to the language of the Dev Hub user who created the package.
|
|
770
|
-
|
|
771
|
-
--post-install-script=<value> Name of the post-install script; applies to managed packages only.
|
|
772
|
-
|
|
773
|
-
The post-install script is an Apex class within this package that is run in the installing org after installations
|
|
774
|
-
or upgrades of this package version.
|
|
775
|
-
|
|
776
|
-
--post-install-url=<value> Post-install instructions URL.
|
|
777
|
-
|
|
778
|
-
The contents of the post-installation instructions URL are displayed in the UI after installation of the package
|
|
779
|
-
version.
|
|
780
|
-
|
|
781
|
-
--releasenotes-url=<value> Release notes URL.
|
|
782
|
-
|
|
783
|
-
This link is displayed in the package installation UI to provide release notes for this package version to
|
|
784
|
-
subscribers.
|
|
785
|
-
|
|
786
|
-
--skip-validation Skip validation during package version creation; you can’t promote unvalidated package versions.
|
|
787
|
-
|
|
788
|
-
Skips validation of dependencies, package ancestors, and metadata during package version creation. Skipping
|
|
789
|
-
validation reduces the time it takes to create a new package version, but you can promote only validated package
|
|
790
|
-
versions. Skipping validation can suppress important errors that can surface at a later stage. You can specify skip
|
|
791
|
-
validation or code coverage, but not both. Code coverage is calculated during validation.
|
|
792
|
-
|
|
793
|
-
--uninstall-script=<value> Uninstall script name; applies to managed packages only.
|
|
794
|
-
|
|
795
|
-
The uninstall script is an Apex class within this package that is run in the installing org after uninstallations of
|
|
796
|
-
this package.
|
|
797
|
-
|
|
798
|
-
--verbose Display verbose command output.
|
|
799
|
-
|
|
800
|
-
Display verbose command output. When polling for the status of the creation, this will output status and timeout
|
|
801
|
-
data on a separate line for each poll request, which is useful in CI systems where timeouts can occur with long
|
|
802
|
-
periods of no output from commands.
|
|
803
|
-
```
|
|
804
|
-
|
|
805
|
-
## `sf force:package:version:create:list`
|
|
806
|
-
|
|
807
|
-
List package version creation requests.
|
|
808
|
-
|
|
809
|
-
```
|
|
810
|
-
USAGE
|
|
811
|
-
$ sf force:package:version:create:list -v <value> [--json] [--api-version <value>] [-c <value>] [-s Queued|InProgress|Success|Error]
|
|
812
|
-
[--verbose]
|
|
813
|
-
|
|
814
|
-
FLAGS
|
|
815
|
-
-c, --created-last-days=<value> Number of days since the request was created, starting at 00:00:00 of first day to
|
|
816
|
-
now. Use 0 for today.
|
|
817
|
-
-s, --status=<option> Status of the version creation request, used to filter the list.
|
|
818
|
-
<options: Queued|InProgress|Success|Error>
|
|
819
|
-
-v, --target-dev-hub=<value> (required) [default: william.ruemmele@brave-bear-5fmf7j.com] Username or alias of the
|
|
820
|
-
Dev Hub org.
|
|
821
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
822
|
-
--verbose Displays additional information at a slight performance cost, such as the version
|
|
823
|
-
name and number for each package version create request.
|
|
824
|
-
|
|
825
|
-
GLOBAL FLAGS
|
|
826
|
-
--json Format output as json.
|
|
827
|
-
|
|
828
|
-
DESCRIPTION
|
|
829
|
-
List package version creation requests.
|
|
830
|
-
|
|
831
|
-
Shows the details of each request to create a package version in the Dev Hub org.
|
|
832
|
-
|
|
833
|
-
All filter parameters are applied using the AND logical operator (not OR).
|
|
834
|
-
|
|
835
|
-
To get information about a specific request, run "sf package version create report" and supply the request ID.
|
|
836
|
-
|
|
837
|
-
ALIASES
|
|
838
|
-
$ sf force:package:version:create:list
|
|
839
|
-
|
|
840
|
-
EXAMPLES
|
|
841
|
-
List all package version creation requests in your default Dev Hub org:
|
|
842
|
-
|
|
843
|
-
$ sf force:package:version:create:list
|
|
844
|
-
|
|
845
|
-
List package version creation requests from the last 3 days in the Dev Hub org with username devhub@example.com:
|
|
846
|
-
|
|
847
|
-
$ sf force:package:version:create:list --created-last-days 3 --target-dev-hub
|
|
848
|
-
|
|
849
|
-
List package version creation requests with status Error:
|
|
850
|
-
|
|
851
|
-
$ sf force:package:version:create:list --status Error
|
|
852
|
-
|
|
853
|
-
List package version creation requests with status InProgress:
|
|
854
|
-
|
|
855
|
-
$ sf force:package:version:create:list --status InProgress
|
|
856
|
-
|
|
857
|
-
List package version creation requests with status Success that were created today:
|
|
858
|
-
|
|
859
|
-
$ sf force:package:version:create:list --created-last-days 0 --status Success
|
|
860
|
-
```
|
|
861
|
-
|
|
862
|
-
## `sf force:package:version:create:report`
|
|
863
|
-
|
|
864
|
-
Retrieve details about a package version creation request.
|
|
865
|
-
|
|
866
|
-
```
|
|
867
|
-
USAGE
|
|
868
|
-
$ sf force:package:version:create:report -v <value> -i <value> [--json] [--api-version <value>]
|
|
869
|
-
|
|
870
|
-
FLAGS
|
|
871
|
-
-i, --package-create-request-id=<value> (required) ID (starts with 08c) of the package version creation request you
|
|
872
|
-
want to display.
|
|
873
|
-
-v, --target-dev-hub=<value> (required) [default: william.ruemmele@brave-bear-5fmf7j.com] Username or
|
|
874
|
-
alias of the Dev Hub org.
|
|
875
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
876
|
-
|
|
877
|
-
GLOBAL FLAGS
|
|
878
|
-
--json Format output as json.
|
|
879
|
-
|
|
880
|
-
DESCRIPTION
|
|
881
|
-
Retrieve details about a package version creation request.
|
|
882
|
-
|
|
883
|
-
Specify the request ID for which you want to view details. If applicable, the command displays errors related to the
|
|
884
|
-
request.
|
|
885
|
-
|
|
886
|
-
To show all requests in the org, run "sf package version create list".
|
|
887
|
-
|
|
888
|
-
ALIASES
|
|
889
|
-
$ sf force:package:version:create:report
|
|
890
|
-
|
|
891
|
-
EXAMPLES
|
|
892
|
-
Retrieve details about the package version creation request with the specified ID; uses your default Dev Hub org:
|
|
893
|
-
|
|
894
|
-
$ sf force:package:version:create:report --package-create-request-id 08c...
|
|
895
|
-
|
|
896
|
-
Retrieve details about the specified package version creation request in the Dev Hub org with username
|
|
897
|
-
devhub@example.com:
|
|
898
|
-
|
|
899
|
-
$ sf force:package:version:create:report --package-create-request-id 08c... --target-dev-hub devhub@example.com
|
|
900
|
-
```
|
|
901
|
-
|
|
902
|
-
## `sf force:package:version:delete`
|
|
903
|
-
|
|
904
|
-
Delete a package version.
|
|
905
|
-
|
|
906
|
-
```
|
|
907
|
-
USAGE
|
|
908
|
-
$ sf force:package:version:delete -v <value> -p <value> [--json] [--api-version <value>] [-n]
|
|
909
|
-
|
|
910
|
-
FLAGS
|
|
911
|
-
-n, --no-prompt Don’t prompt before deleting the package version.
|
|
912
|
-
-p, --package=<value> (required) ID (starts with 04t) or alias of the package version to delete.
|
|
913
|
-
-v, --target-dev-hub=<value> (required) [default: william.ruemmele@brave-bear-5fmf7j.com] Username or alias of the
|
|
914
|
-
Dev Hub org.
|
|
915
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
916
|
-
|
|
917
|
-
GLOBAL FLAGS
|
|
918
|
-
--json Format output as json.
|
|
919
|
-
|
|
920
|
-
DESCRIPTION
|
|
921
|
-
Delete a package version.
|
|
922
|
-
|
|
923
|
-
Specify the ID or alias of the package version you want to delete.
|
|
924
|
-
|
|
925
|
-
ALIASES
|
|
926
|
-
$ sf force:package:version:delete
|
|
927
|
-
|
|
928
|
-
EXAMPLES
|
|
929
|
-
Delete a package version with the specified alias using your default Dev Hub org:
|
|
930
|
-
|
|
931
|
-
$ sf force:package:version:delete --package "Your Package Alias"
|
|
932
|
-
|
|
933
|
-
Delete a package version with the specified ID using the Dev Hub org with username "devhub@example.com":
|
|
934
|
-
|
|
935
|
-
$ sf force:package:version:delete --package 04t... --target-org devhub@example.com
|
|
936
|
-
```
|
|
937
|
-
|
|
938
|
-
## `sf force:package:version:displayancestry`
|
|
939
|
-
|
|
940
|
-
Display the ancestry tree for a 2GP managed package version.
|
|
941
|
-
|
|
942
|
-
```
|
|
943
|
-
USAGE
|
|
944
|
-
$ sf force:package:version:displayancestry -v <value> -p <value> [--json] [--api-version <value>] [--dot-code]
|
|
945
|
-
[--verbose]
|
|
946
|
-
|
|
947
|
-
FLAGS
|
|
948
|
-
-p, --package=<value> (required) ID or alias of the package (starts with 0Ho) or package version (starts with
|
|
949
|
-
04t) to display ancestry for.
|
|
950
|
-
-v, --target-dev-hub=<value> (required) [default: william.ruemmele@brave-bear-5fmf7j.com] Username or alias of the
|
|
951
|
-
Dev Hub org.
|
|
952
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
953
|
-
--dot-code Display the ancestry tree in DOT code.
|
|
954
|
-
--verbose Display both the package version ID (starts with 04t) and the version number
|
|
955
|
-
(major.minor.patch.build) in the ancestry tree.
|
|
956
|
-
|
|
957
|
-
GLOBAL FLAGS
|
|
958
|
-
--json Format output as json.
|
|
959
|
-
|
|
960
|
-
ALIASES
|
|
961
|
-
$ sf force:package:version:displayancestry
|
|
962
|
-
|
|
963
|
-
EXAMPLES
|
|
964
|
-
Display the ancestry tree for a package version with the specified alias, using your default Dev Hub org:
|
|
965
|
-
|
|
966
|
-
$ sf force:package:version:displayancestry --package package_version_alias
|
|
967
|
-
|
|
968
|
-
Similar to previous example, but display the output in DOT code:
|
|
969
|
-
|
|
970
|
-
$ sf force:package:version:displayancestry --package package_version_alias --dot-code
|
|
971
|
-
|
|
972
|
-
Display the ancestry tree for a package with the specified ID, using the Dev Hub org with username
|
|
973
|
-
devhub@example.com:
|
|
974
|
-
|
|
975
|
-
$ sf force:package:version:displayancestry --package OHo... --target-dev-hub devhub@example.com
|
|
976
|
-
|
|
977
|
-
Display the ancestry tree of a package version with the specified ID, using your default Dev Hub org:
|
|
978
|
-
|
|
979
|
-
$ sf force:package:version:displayancestry --package 04t...
|
|
980
|
-
|
|
981
|
-
FLAG DESCRIPTIONS
|
|
982
|
-
-p, --package=<value>
|
|
983
|
-
|
|
984
|
-
ID or alias of the package (starts with 0Ho) or package version (starts with 04t) to display ancestry for.
|
|
985
|
-
|
|
986
|
-
If you specify a package ID (starts with 0Ho) or alias, the ancestor tree for every package version associated with
|
|
987
|
-
the package ID is displayed. If you specify a package version (starts with 04t) or alias, the ancestry tree of the
|
|
988
|
-
specified package version is displayed.
|
|
989
|
-
|
|
990
|
-
--dot-code Display the ancestry tree in DOT code.
|
|
991
|
-
|
|
992
|
-
You can use the DOT code output in graph visualization software to create tree visualizations.
|
|
993
|
-
```
|
|
994
|
-
|
|
995
|
-
## `sf force:package:version:list`
|
|
996
|
-
|
|
997
|
-
List all package versions in the Dev Hub org.
|
|
998
|
-
|
|
999
|
-
```
|
|
1000
|
-
USAGE
|
|
1001
|
-
$ sf force:package:version:list -v <value> [--json] [--api-version <value>] [-c <value>] [--concise] [-m <value>] [-p <value>]
|
|
1002
|
-
[-r] [-o <value>] [--verbose]
|
|
1003
|
-
|
|
1004
|
-
FLAGS
|
|
1005
|
-
-c, --created-last-days=<value> Number of days since the request was created, starting at 00:00:00 of first day to
|
|
1006
|
-
now. Use 0 for today.
|
|
1007
|
-
-m, --modified-last-days=<value> Number of days since the items were modified, starting at 00:00:00 of first day to
|
|
1008
|
-
now. Use 0 for today.
|
|
1009
|
-
-o, --order-by=<value> Package version fields used to order the list.
|
|
1010
|
-
-p, --packages=<value> Comma-delimited list of packages (aliases or 0Ho IDs) to list.
|
|
1011
|
-
-r, --released Display released versions only (IsReleased=true).
|
|
1012
|
-
-v, --target-dev-hub=<value> (required) [default: william.ruemmele@brave-bear-5fmf7j.com] Username or alias of
|
|
1013
|
-
the Dev Hub org.
|
|
1014
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
1015
|
-
--concise Display limited package version details.
|
|
1016
|
-
--verbose Display extended package version details.
|
|
1017
|
-
|
|
1018
|
-
GLOBAL FLAGS
|
|
1019
|
-
--json Format output as json.
|
|
1020
|
-
|
|
1021
|
-
DESCRIPTION
|
|
1022
|
-
List all package versions in the Dev Hub org.
|
|
1023
|
-
|
|
1024
|
-
Description
|
|
1025
|
-
|
|
1026
|
-
ALIASES
|
|
1027
|
-
$ sf force:package:version:list
|
|
1028
|
-
|
|
1029
|
-
EXAMPLES
|
|
1030
|
-
List package versions in your default Dev Hub org that were created in the last 3 days; show only the released
|
|
1031
|
-
versions and order the list using the PatchVersion field. Display extended details about each package version:
|
|
1032
|
-
|
|
1033
|
-
$ sf force:package:version:list --verbose --created-last-days 3 --released --order-by PatchVersion
|
|
1034
|
-
|
|
1035
|
-
List the released package versions for the two specified packages that were modified today; use the Dev Hub org with
|
|
1036
|
-
username devhub@example.com:
|
|
1037
|
-
|
|
1038
|
-
$ sf force:package:version:list --packages 0Ho000000000000,0Ho000000000001 --released --modified-last-days 0 \
|
|
1039
|
-
--target-dev-hub devhub@example.com
|
|
1040
|
-
|
|
1041
|
-
List all released package versions in your default Dev Hub org:
|
|
1042
|
-
|
|
1043
|
-
$ sf force:package:version:list --released
|
|
1044
|
-
|
|
1045
|
-
List package versions that were modified today in your default Dev Hub org; show limited details about each one:
|
|
1046
|
-
|
|
1047
|
-
$ sf force:package:version:list --concise --modified-last-days 0
|
|
1048
|
-
|
|
1049
|
-
List released package versions that were created in the last 3 days in your default Dev Hub org; show limited
|
|
1050
|
-
details:
|
|
1051
|
-
|
|
1052
|
-
$ sf force:package:version:list --concise --created-last-days 3 --released
|
|
1053
|
-
|
|
1054
|
-
List released package versions that were modified today for the two packages with specified aliases in your default
|
|
1055
|
-
Dev Hub org:
|
|
1056
|
-
|
|
1057
|
-
$ sf force:package:version:list --packages exp-mgr,exp-mgr-util --released --modified-last-days 0
|
|
1058
|
-
```
|
|
1059
|
-
|
|
1060
|
-
## `sf force:package:version:promote`
|
|
1061
|
-
|
|
1062
|
-
Promote a package version to released.
|
|
1063
|
-
|
|
1064
|
-
```
|
|
1065
|
-
USAGE
|
|
1066
|
-
$ sf force:package:version:promote -v <value> -p <value> [--json] [--api-version <value>] [-n]
|
|
1067
|
-
|
|
1068
|
-
FLAGS
|
|
1069
|
-
-n, --no-prompt Don't prompt to confirm setting the package version as released.
|
|
1070
|
-
-p, --package=<value> (required) ID (starts with 04t) or alias of the package version to promote.
|
|
1071
|
-
-v, --target-dev-hub=<value> (required) [default: william.ruemmele@brave-bear-5fmf7j.com] Username or alias of the
|
|
1072
|
-
Dev Hub org.
|
|
1073
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
1074
|
-
|
|
1075
|
-
GLOBAL FLAGS
|
|
1076
|
-
--json Format output as json.
|
|
1077
|
-
|
|
1078
|
-
DESCRIPTION
|
|
1079
|
-
Promote a package version to released.
|
|
1080
|
-
|
|
1081
|
-
Supply the ID or alias of the package version you want to promote. Promotes the package version to released status.
|
|
1082
|
-
|
|
1083
|
-
ALIASES
|
|
1084
|
-
$ sf force:package:version:promote
|
|
1085
|
-
|
|
1086
|
-
EXAMPLES
|
|
1087
|
-
Promote the package version with the specified ID to released; uses your default Dev Hub org:
|
|
1088
|
-
|
|
1089
|
-
$ sf force:package:version:promote --package 04t...
|
|
1090
|
-
|
|
1091
|
-
Promote the package version with the specified alias to released; uses the Dev Hub org with username
|
|
1092
|
-
devhub@example.com:
|
|
1093
|
-
|
|
1094
|
-
$ sf force:package:version:promote --package awesome_package_alias --target-dev-hub devhub@example.com
|
|
1095
|
-
|
|
1096
|
-
Promote the package version with an alias that has spaces to released:
|
|
1097
|
-
|
|
1098
|
-
$ sf force:package:version:promote --package "Awesome Package Alias"
|
|
1099
|
-
```
|
|
1100
|
-
|
|
1101
|
-
## `sf force:package:version:report`
|
|
1102
|
-
|
|
1103
|
-
Retrieve details about a package version in the Dev Hub org.
|
|
1104
|
-
|
|
1105
|
-
```
|
|
1106
|
-
USAGE
|
|
1107
|
-
$ sf force:package:version:report -v <value> -p <value> [--json] [--api-version <value>] [--verbose]
|
|
1108
|
-
|
|
1109
|
-
FLAGS
|
|
1110
|
-
-p, --package=<value> (required) ID (starts with 04t) or alias of the package to retrieve details for.
|
|
1111
|
-
-v, --target-dev-hub=<value> (required) [default: william.ruemmele@brave-bear-5fmf7j.com] Username or alias of the
|
|
1112
|
-
Dev Hub org.
|
|
1113
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
1114
|
-
--verbose Display extended package version details.
|
|
1115
|
-
|
|
1116
|
-
GLOBAL FLAGS
|
|
1117
|
-
--json Format output as json.
|
|
1118
|
-
|
|
1119
|
-
DESCRIPTION
|
|
1120
|
-
Retrieve details about a package version in the Dev Hub org.
|
|
1121
|
-
|
|
1122
|
-
To update package version values, run "sf package version update".
|
|
1123
|
-
|
|
1124
|
-
ALIASES
|
|
1125
|
-
$ sf force:package:version:report
|
|
1126
|
-
|
|
1127
|
-
EXAMPLES
|
|
1128
|
-
Retrieve details about the package version with the specified ID from your default Dev Hub org:
|
|
1129
|
-
|
|
1130
|
-
$ sf force:package:version:report --package 04t...
|
|
1131
|
-
|
|
1132
|
-
Retrieve details about the package version with the specified alias (that contains spaces) from the Dev Hub org with
|
|
1133
|
-
username devhub@example.com:
|
|
1134
|
-
|
|
1135
|
-
$ sf force:package:version:report --package "Your Package Alias" --target-dev-hub devhub@example.com
|
|
1136
|
-
```
|
|
1137
|
-
|
|
1138
|
-
## `sf force:package:version:update`
|
|
1139
|
-
|
|
1140
|
-
Update a package version.
|
|
1141
|
-
|
|
1142
|
-
```
|
|
1143
|
-
USAGE
|
|
1144
|
-
$ sf force:package:version:update -v <value> -p <value> [--json] [--api-version <value>] [-a <value>] [-e <value>] [-b <value>]
|
|
1145
|
-
[-t <value>] [-k <value>]
|
|
1146
|
-
|
|
1147
|
-
FLAGS
|
|
1148
|
-
-a, --version-name=<value> New package version name.
|
|
1149
|
-
-b, --branch=<value> New package version branch.
|
|
1150
|
-
-e, --version-description=<value> New package version description.
|
|
1151
|
-
-k, --installation-key=<value> New installation key for key-protected package (default: null)
|
|
1152
|
-
-p, --package=<value> (required) ID (starts with 04t) or alias of the package to update a version of.
|
|
1153
|
-
-t, --tag=<value> New package version tag.
|
|
1154
|
-
-v, --target-dev-hub=<value> (required) [default: william.ruemmele@brave-bear-5fmf7j.com] Username or alias of
|
|
1155
|
-
the Dev Hub org.
|
|
1156
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
1157
|
-
|
|
1158
|
-
GLOBAL FLAGS
|
|
1159
|
-
--json Format output as json.
|
|
1160
|
-
|
|
1161
|
-
DESCRIPTION
|
|
1162
|
-
Update a package version.
|
|
1163
|
-
|
|
1164
|
-
Specify a new value for each option you want to update.
|
|
1165
|
-
|
|
1166
|
-
To display details about a package version, run "sf package version display".
|
|
1167
|
-
|
|
1168
|
-
ALIASES
|
|
1169
|
-
$ sf force:package:version:update
|
|
1170
|
-
|
|
1171
|
-
EXAMPLES
|
|
1172
|
-
Update the package version that has the specified alias (that contains spaces) with a new installation key
|
|
1173
|
-
"password123"; uses your default Dev Hub org:
|
|
1174
|
-
|
|
1175
|
-
$ sf force:package:version:update --package "Your Package Alias" --installation-key password123
|
|
1176
|
-
|
|
1177
|
-
Update the package version that has the specified ID with a new branch and tag; use the Dev Hub org with username
|
|
1178
|
-
devhub@example.com:
|
|
1179
|
-
|
|
1180
|
-
$ sf force:package:version:update --package 04t... --branch main --tag 'Release 1.0.7' --target-dev-hub \
|
|
1181
|
-
devhub@example.com
|
|
1182
|
-
|
|
1183
|
-
Update the package version that has the specified ID with a new description:
|
|
1184
|
-
|
|
1185
|
-
$ sf force:package:version:update --package 04t... --version-description "New Package Version Description"
|
|
1186
|
-
```
|
|
1187
|
-
|
|
1188
56
|
## `sf package1:version:create`
|
|
1189
57
|
|
|
1190
58
|
Create a first-generation package version in the release org.
|
|
@@ -1248,7 +116,7 @@ FLAG DESCRIPTIONS
|
|
|
1248
116
|
subscribers.
|
|
1249
117
|
```
|
|
1250
118
|
|
|
1251
|
-
_See code: [src/commands/package1/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/
|
|
119
|
+
_See code: [src/commands/package1/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.26.5/src/commands/package1/version/create.ts)_
|
|
1252
120
|
|
|
1253
121
|
## `sf package1:version:create:get`
|
|
1254
122
|
|
|
@@ -1279,7 +147,7 @@ EXAMPLES
|
|
|
1279
147
|
$ sf package1:version:create:get --request-id 0HD... --target-org myorg@example.com
|
|
1280
148
|
```
|
|
1281
149
|
|
|
1282
|
-
_See code: [src/commands/package1/version/create/get.ts](https://github.com/salesforcecli/plugin-packaging/blob/
|
|
150
|
+
_See code: [src/commands/package1/version/create/get.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.26.5/src/commands/package1/version/create/get.ts)_
|
|
1283
151
|
|
|
1284
152
|
## `sf package1:version:display`
|
|
1285
153
|
|
|
@@ -1311,7 +179,7 @@ EXAMPLES
|
|
|
1311
179
|
$ sf package1:version:display --package-version-id 04t... --target-org myorg@example.com
|
|
1312
180
|
```
|
|
1313
181
|
|
|
1314
|
-
_See code: [src/commands/package1/version/display.ts](https://github.com/salesforcecli/plugin-packaging/blob/
|
|
182
|
+
_See code: [src/commands/package1/version/display.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.26.5/src/commands/package1/version/display.ts)_
|
|
1315
183
|
|
|
1316
184
|
## `sf package1:version:list`
|
|
1317
185
|
|
|
@@ -1347,7 +215,7 @@ FLAG DESCRIPTIONS
|
|
|
1347
215
|
If not specified, shows all versions for all packages (managed and unmanaged) in the org.
|
|
1348
216
|
```
|
|
1349
217
|
|
|
1350
|
-
_See code: [src/commands/package1/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/
|
|
218
|
+
_See code: [src/commands/package1/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.26.5/src/commands/package1/version/list.ts)_
|
|
1351
219
|
|
|
1352
220
|
## `sf package:create`
|
|
1353
221
|
|
|
@@ -1367,8 +235,7 @@ FLAGS
|
|
|
1367
235
|
-r, --path=<value> (required) Path to directory that contains the contents of the package.
|
|
1368
236
|
-t, --package-type=<option> (required) Type of package.
|
|
1369
237
|
<options: Managed|Unlocked>
|
|
1370
|
-
-v, --target-dev-hub=<value> (required)
|
|
1371
|
-
alias of the Dev Hub org.
|
|
238
|
+
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
|
|
1372
239
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1373
240
|
--org-dependent Depends on unpackaged metadata in the installation org; applies to unlocked
|
|
1374
241
|
packages only.
|
|
@@ -1425,7 +292,7 @@ FLAG DESCRIPTIONS
|
|
|
1425
292
|
Org-Dependent Unlocked Packages" in the Salesforce DX Developer Guide.
|
|
1426
293
|
```
|
|
1427
294
|
|
|
1428
|
-
_See code: [src/commands/package/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/
|
|
295
|
+
_See code: [src/commands/package/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.26.5/src/commands/package/create.ts)_
|
|
1429
296
|
|
|
1430
297
|
## `sf package:delete`
|
|
1431
298
|
|
|
@@ -1438,8 +305,7 @@ USAGE
|
|
|
1438
305
|
FLAGS
|
|
1439
306
|
-n, --no-prompt Don’t prompt before deleting the package.
|
|
1440
307
|
-p, --package=<value> (required) ID (starts with 0Ho) or alias of the package to delete.
|
|
1441
|
-
-v, --target-dev-hub=<value> (required)
|
|
1442
|
-
Dev Hub org.
|
|
308
|
+
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
|
|
1443
309
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1444
310
|
|
|
1445
311
|
GLOBAL FLAGS
|
|
@@ -1466,7 +332,7 @@ EXAMPLES
|
|
|
1466
332
|
$ sf package:delete --package 0Ho... --target-dev-hub devhub@example.com
|
|
1467
333
|
```
|
|
1468
334
|
|
|
1469
|
-
_See code: [src/commands/package/delete.ts](https://github.com/salesforcecli/plugin-packaging/blob/
|
|
335
|
+
_See code: [src/commands/package/delete.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.26.5/src/commands/package/delete.ts)_
|
|
1470
336
|
|
|
1471
337
|
## `sf package:install`
|
|
1472
338
|
|
|
@@ -1562,7 +428,7 @@ FLAG DESCRIPTIONS
|
|
|
1562
428
|
specify DeprecateOnly or Delete only for unlocked package upgrades.
|
|
1563
429
|
```
|
|
1564
430
|
|
|
1565
|
-
_See code: [src/commands/package/install.ts](https://github.com/salesforcecli/plugin-packaging/blob/
|
|
431
|
+
_See code: [src/commands/package/install.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.26.5/src/commands/package/install.ts)_
|
|
1566
432
|
|
|
1567
433
|
## `sf package:install:report`
|
|
1568
434
|
|
|
@@ -1593,7 +459,7 @@ EXAMPLES
|
|
|
1593
459
|
$ sf package:install:report --request-id 0Hf... --target-org me@example.com
|
|
1594
460
|
```
|
|
1595
461
|
|
|
1596
|
-
_See code: [src/commands/package/install/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/
|
|
462
|
+
_See code: [src/commands/package/install/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.26.5/src/commands/package/install/report.ts)_
|
|
1597
463
|
|
|
1598
464
|
## `sf package:installed:list`
|
|
1599
465
|
|
|
@@ -1623,7 +489,7 @@ EXAMPLES
|
|
|
1623
489
|
$ sf package:installed:list --target-org me@example.com
|
|
1624
490
|
```
|
|
1625
491
|
|
|
1626
|
-
_See code: [src/commands/package/installed/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/
|
|
492
|
+
_See code: [src/commands/package/installed/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.26.5/src/commands/package/installed/list.ts)_
|
|
1627
493
|
|
|
1628
494
|
## `sf package:list`
|
|
1629
495
|
|
|
@@ -1634,8 +500,7 @@ USAGE
|
|
|
1634
500
|
$ sf package:list -v <value> [--json] [--api-version <value>] [--verbose]
|
|
1635
501
|
|
|
1636
502
|
FLAGS
|
|
1637
|
-
-v, --target-dev-hub=<value> (required)
|
|
1638
|
-
Dev Hub org.
|
|
503
|
+
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
|
|
1639
504
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1640
505
|
--verbose Display extended package detail.
|
|
1641
506
|
|
|
@@ -1660,7 +525,7 @@ EXAMPLES
|
|
|
1660
525
|
$ sf package:list --target-dev-hub devhub@example.com --verbose
|
|
1661
526
|
```
|
|
1662
527
|
|
|
1663
|
-
_See code: [src/commands/package/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/
|
|
528
|
+
_See code: [src/commands/package/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.26.5/src/commands/package/list.ts)_
|
|
1664
529
|
|
|
1665
530
|
## `sf package:uninstall`
|
|
1666
531
|
|
|
@@ -1706,7 +571,7 @@ EXAMPLES
|
|
|
1706
571
|
$ sf package:uninstall --package "Undesirable Package Alias"
|
|
1707
572
|
```
|
|
1708
573
|
|
|
1709
|
-
_See code: [src/commands/package/uninstall.ts](https://github.com/salesforcecli/plugin-packaging/blob/
|
|
574
|
+
_See code: [src/commands/package/uninstall.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.26.5/src/commands/package/uninstall.ts)_
|
|
1710
575
|
|
|
1711
576
|
## `sf package:uninstall:report`
|
|
1712
577
|
|
|
@@ -1737,7 +602,7 @@ EXAMPLES
|
|
|
1737
602
|
$ sf package:uninstall:report --request-id 06y... --target-org me@example.com
|
|
1738
603
|
```
|
|
1739
604
|
|
|
1740
|
-
_See code: [src/commands/package/uninstall/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/
|
|
605
|
+
_See code: [src/commands/package/uninstall/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.26.5/src/commands/package/uninstall/report.ts)_
|
|
1741
606
|
|
|
1742
607
|
## `sf package:update`
|
|
1743
608
|
|
|
@@ -1746,6 +611,7 @@ Update package details.
|
|
|
1746
611
|
```
|
|
1747
612
|
USAGE
|
|
1748
613
|
$ sf package:update -v <value> -p <value> [--json] [--api-version <value>] [-n <value>] [-d <value>] [-o <value>]
|
|
614
|
+
[--enable-app-analytics]
|
|
1749
615
|
|
|
1750
616
|
FLAGS
|
|
1751
617
|
-d, --description=<value> New description of the package.
|
|
@@ -1753,9 +619,10 @@ FLAGS
|
|
|
1753
619
|
-o, --error-notification-username=<value> Active Dev Hub user designated to receive email notifications for package
|
|
1754
620
|
errors.
|
|
1755
621
|
-p, --package=<value> (required) ID (starts with 0Ho) or alias of the package to update.
|
|
1756
|
-
-v, --target-dev-hub=<value> (required)
|
|
1757
|
-
alias of the Dev Hub org.
|
|
622
|
+
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
|
|
1758
623
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
624
|
+
--[no-]enable-app-analytics Enable AppExchange App Analytics usage data collection on this managed
|
|
625
|
+
package and its components.
|
|
1759
626
|
|
|
1760
627
|
GLOBAL FLAGS
|
|
1761
628
|
--json Format output as json.
|
|
@@ -1788,7 +655,7 @@ FLAG DESCRIPTIONS
|
|
|
1788
655
|
associated with your package.
|
|
1789
656
|
```
|
|
1790
657
|
|
|
1791
|
-
_See code: [src/commands/package/update.ts](https://github.com/salesforcecli/plugin-packaging/blob/
|
|
658
|
+
_See code: [src/commands/package/update.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.26.5/src/commands/package/update.ts)_
|
|
1792
659
|
|
|
1793
660
|
## `sf package:version:create`
|
|
1794
661
|
|
|
@@ -1819,8 +686,7 @@ FLAGS
|
|
|
1819
686
|
sfdx-project.json value.
|
|
1820
687
|
-p, --package=<value> ID (starts with 0Ho) or alias of the package to create a version of.
|
|
1821
688
|
-t, --tag=<value> Package version’s tag.
|
|
1822
|
-
-v, --target-dev-hub=<value> (required)
|
|
1823
|
-
the Dev Hub org.
|
|
689
|
+
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
|
|
1824
690
|
-w, --wait=<value> [default: 0 minutes] Number of minutes to wait for the package version to be
|
|
1825
691
|
created.
|
|
1826
692
|
-x, --installation-key-bypass Bypass the installation key requirement. (either --installation-key or
|
|
@@ -1891,6 +757,13 @@ FLAG DESCRIPTIONS
|
|
|
1891
757
|
coverage requirement. We don’t calculate code coverage for org-dependent unlocked packages or for package versions
|
|
1892
758
|
that specify --skip-validation.
|
|
1893
759
|
|
|
760
|
+
-n, --version-number=<value>
|
|
761
|
+
|
|
762
|
+
Version number of the package version to be created; overrides the sfdx-project.json value.
|
|
763
|
+
|
|
764
|
+
For information about the format of the version number, see
|
|
765
|
+
https://developer.salesforce.com/docs/atlas.en-us.pkg2_dev.meta/pkg2_dev/sfdx_dev2gp_config_file.htm.
|
|
766
|
+
|
|
1894
767
|
-x, --installation-key-bypass
|
|
1895
768
|
|
|
1896
769
|
Bypass the installation key requirement. (either --installation-key or --installation-key-bypass is required)
|
|
@@ -1936,7 +809,7 @@ FLAG DESCRIPTIONS
|
|
|
1936
809
|
periods of no output from commands.
|
|
1937
810
|
```
|
|
1938
811
|
|
|
1939
|
-
_See code: [src/commands/package/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/
|
|
812
|
+
_See code: [src/commands/package/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.26.5/src/commands/package/version/create.ts)_
|
|
1940
813
|
|
|
1941
814
|
## `sf package:version:create:list`
|
|
1942
815
|
|
|
@@ -1945,16 +818,16 @@ List package version creation requests.
|
|
|
1945
818
|
```
|
|
1946
819
|
USAGE
|
|
1947
820
|
$ sf package:version:create:list -v <value> [--json] [--api-version <value>] [-c <value>] [-s Queued|InProgress|Success|Error]
|
|
1948
|
-
[--verbose]
|
|
821
|
+
[--show-conversions-only] [--verbose]
|
|
1949
822
|
|
|
1950
823
|
FLAGS
|
|
1951
824
|
-c, --created-last-days=<value> Number of days since the request was created, starting at 00:00:00 of first day to
|
|
1952
825
|
now. Use 0 for today.
|
|
1953
826
|
-s, --status=<option> Status of the version creation request, used to filter the list.
|
|
1954
827
|
<options: Queued|InProgress|Success|Error>
|
|
1955
|
-
-v, --target-dev-hub=<value> (required)
|
|
1956
|
-
Dev Hub org.
|
|
828
|
+
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
|
|
1957
829
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
830
|
+
--show-conversions-only Filter the list output to display only converted package version.
|
|
1958
831
|
--verbose Displays additional information at a slight performance cost, such as the version
|
|
1959
832
|
name and number for each package version create request.
|
|
1960
833
|
|
|
@@ -1995,7 +868,7 @@ EXAMPLES
|
|
|
1995
868
|
$ sf package:version:create:list --created-last-days 0 --status Success
|
|
1996
869
|
```
|
|
1997
870
|
|
|
1998
|
-
_See code: [src/commands/package/version/create/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/
|
|
871
|
+
_See code: [src/commands/package/version/create/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.26.5/src/commands/package/version/create/list.ts)_
|
|
1999
872
|
|
|
2000
873
|
## `sf package:version:create:report`
|
|
2001
874
|
|
|
@@ -2008,8 +881,7 @@ USAGE
|
|
|
2008
881
|
FLAGS
|
|
2009
882
|
-i, --package-create-request-id=<value> (required) ID (starts with 08c) of the package version creation request you
|
|
2010
883
|
want to display.
|
|
2011
|
-
-v, --target-dev-hub=<value> (required)
|
|
2012
|
-
alias of the Dev Hub org.
|
|
884
|
+
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
|
|
2013
885
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
2014
886
|
|
|
2015
887
|
GLOBAL FLAGS
|
|
@@ -2037,7 +909,7 @@ EXAMPLES
|
|
|
2037
909
|
$ sf package:version:create:report --package-create-request-id 08c... --target-dev-hub devhub@example.com
|
|
2038
910
|
```
|
|
2039
911
|
|
|
2040
|
-
_See code: [src/commands/package/version/create/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/
|
|
912
|
+
_See code: [src/commands/package/version/create/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.26.5/src/commands/package/version/create/report.ts)_
|
|
2041
913
|
|
|
2042
914
|
## `sf package:version:delete`
|
|
2043
915
|
|
|
@@ -2050,8 +922,7 @@ USAGE
|
|
|
2050
922
|
FLAGS
|
|
2051
923
|
-n, --no-prompt Don’t prompt before deleting the package version.
|
|
2052
924
|
-p, --package=<value> (required) ID (starts with 04t) or alias of the package version to delete.
|
|
2053
|
-
-v, --target-dev-hub=<value> (required)
|
|
2054
|
-
Dev Hub org.
|
|
925
|
+
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
|
|
2055
926
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
2056
927
|
|
|
2057
928
|
GLOBAL FLAGS
|
|
@@ -2075,7 +946,7 @@ EXAMPLES
|
|
|
2075
946
|
$ sf package:version:delete --package 04t... --target-org devhub@example.com
|
|
2076
947
|
```
|
|
2077
948
|
|
|
2078
|
-
_See code: [src/commands/package/version/delete.ts](https://github.com/salesforcecli/plugin-packaging/blob/
|
|
949
|
+
_See code: [src/commands/package/version/delete.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.26.5/src/commands/package/version/delete.ts)_
|
|
2079
950
|
|
|
2080
951
|
## `sf package:version:displayancestry`
|
|
2081
952
|
|
|
@@ -2088,8 +959,7 @@ USAGE
|
|
|
2088
959
|
FLAGS
|
|
2089
960
|
-p, --package=<value> (required) ID or alias of the package (starts with 0Ho) or package version (starts with
|
|
2090
961
|
04t) to display ancestry for.
|
|
2091
|
-
-v, --target-dev-hub=<value> (required)
|
|
2092
|
-
Dev Hub org.
|
|
962
|
+
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
|
|
2093
963
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
2094
964
|
--dot-code Display the ancestry tree in DOT code.
|
|
2095
965
|
--verbose Display both the package version ID (starts with 04t) and the version number
|
|
@@ -2133,7 +1003,7 @@ FLAG DESCRIPTIONS
|
|
|
2133
1003
|
You can use the DOT code output in graph visualization software to create tree visualizations.
|
|
2134
1004
|
```
|
|
2135
1005
|
|
|
2136
|
-
_See code: [src/commands/package/version/displayancestry.ts](https://github.com/salesforcecli/plugin-packaging/blob/
|
|
1006
|
+
_See code: [src/commands/package/version/displayancestry.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.26.5/src/commands/package/version/displayancestry.ts)_
|
|
2137
1007
|
|
|
2138
1008
|
## `sf package:version:list`
|
|
2139
1009
|
|
|
@@ -2141,8 +1011,8 @@ List all package versions in the Dev Hub org.
|
|
|
2141
1011
|
|
|
2142
1012
|
```
|
|
2143
1013
|
USAGE
|
|
2144
|
-
$ sf package:version:list -v <value> [--json] [--api-version <value>] [-c <value>] [--concise] [-
|
|
2145
|
-
[-r] [-o <value>] [--verbose]
|
|
1014
|
+
$ sf package:version:list -v <value> [--json] [--api-version <value>] [-c <value>] [--concise] [--show-conversions-only]
|
|
1015
|
+
[-m <value>] [-p <value>] [-r] [-o <value>] [--verbose]
|
|
2146
1016
|
|
|
2147
1017
|
FLAGS
|
|
2148
1018
|
-c, --created-last-days=<value> Number of days since the request was created, starting at 00:00:00 of first day to
|
|
@@ -2152,10 +1022,10 @@ FLAGS
|
|
|
2152
1022
|
-o, --order-by=<value> Package version fields used to order the list.
|
|
2153
1023
|
-p, --packages=<value> Comma-delimited list of packages (aliases or 0Ho IDs) to list.
|
|
2154
1024
|
-r, --released Display released versions only (IsReleased=true).
|
|
2155
|
-
-v, --target-dev-hub=<value> (required)
|
|
2156
|
-
the Dev Hub org.
|
|
1025
|
+
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
|
|
2157
1026
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
2158
1027
|
--concise Display limited package version details.
|
|
1028
|
+
--show-conversions-only Filter the list output to display only converted package version.
|
|
2159
1029
|
--verbose Display extended package version details.
|
|
2160
1030
|
|
|
2161
1031
|
GLOBAL FLAGS
|
|
@@ -2200,7 +1070,7 @@ EXAMPLES
|
|
|
2200
1070
|
$ sf package:version:list --packages exp-mgr,exp-mgr-util --released --modified-last-days 0
|
|
2201
1071
|
```
|
|
2202
1072
|
|
|
2203
|
-
_See code: [src/commands/package/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/
|
|
1073
|
+
_See code: [src/commands/package/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.26.5/src/commands/package/version/list.ts)_
|
|
2204
1074
|
|
|
2205
1075
|
## `sf package:version:promote`
|
|
2206
1076
|
|
|
@@ -2213,8 +1083,7 @@ USAGE
|
|
|
2213
1083
|
FLAGS
|
|
2214
1084
|
-n, --no-prompt Don't prompt to confirm setting the package version as released.
|
|
2215
1085
|
-p, --package=<value> (required) ID (starts with 04t) or alias of the package version to promote.
|
|
2216
|
-
-v, --target-dev-hub=<value> (required)
|
|
2217
|
-
Dev Hub org.
|
|
1086
|
+
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
|
|
2218
1087
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
2219
1088
|
|
|
2220
1089
|
GLOBAL FLAGS
|
|
@@ -2243,7 +1112,7 @@ EXAMPLES
|
|
|
2243
1112
|
$ sf package:version:promote --package "Awesome Package Alias"
|
|
2244
1113
|
```
|
|
2245
1114
|
|
|
2246
|
-
_See code: [src/commands/package/version/promote.ts](https://github.com/salesforcecli/plugin-packaging/blob/
|
|
1115
|
+
_See code: [src/commands/package/version/promote.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.26.5/src/commands/package/version/promote.ts)_
|
|
2247
1116
|
|
|
2248
1117
|
## `sf package:version:report`
|
|
2249
1118
|
|
|
@@ -2255,8 +1124,7 @@ USAGE
|
|
|
2255
1124
|
|
|
2256
1125
|
FLAGS
|
|
2257
1126
|
-p, --package=<value> (required) ID (starts with 04t) or alias of the package to retrieve details for.
|
|
2258
|
-
-v, --target-dev-hub=<value> (required)
|
|
2259
|
-
Dev Hub org.
|
|
1127
|
+
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
|
|
2260
1128
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
2261
1129
|
--verbose Display extended package version details.
|
|
2262
1130
|
|
|
@@ -2282,7 +1150,7 @@ EXAMPLES
|
|
|
2282
1150
|
$ sf package:version:report --package "Your Package Alias" --target-dev-hub devhub@example.com
|
|
2283
1151
|
```
|
|
2284
1152
|
|
|
2285
|
-
_See code: [src/commands/package/version/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/
|
|
1153
|
+
_See code: [src/commands/package/version/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.26.5/src/commands/package/version/report.ts)_
|
|
2286
1154
|
|
|
2287
1155
|
## `sf package:version:update`
|
|
2288
1156
|
|
|
@@ -2300,8 +1168,7 @@ FLAGS
|
|
|
2300
1168
|
-k, --installation-key=<value> New installation key for key-protected package (default: null)
|
|
2301
1169
|
-p, --package=<value> (required) ID (starts with 04t) or alias of the package to update a version of.
|
|
2302
1170
|
-t, --tag=<value> New package version tag.
|
|
2303
|
-
-v, --target-dev-hub=<value> (required)
|
|
2304
|
-
the Dev Hub org.
|
|
1171
|
+
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
|
|
2305
1172
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
2306
1173
|
|
|
2307
1174
|
GLOBAL FLAGS
|
|
@@ -2334,6 +1201,6 @@ EXAMPLES
|
|
|
2334
1201
|
$ sf package:version:update --package 04t... --version-description "New Package Version Description"
|
|
2335
1202
|
```
|
|
2336
1203
|
|
|
2337
|
-
_See code: [src/commands/package/version/update.ts](https://github.com/salesforcecli/plugin-packaging/blob/
|
|
1204
|
+
_See code: [src/commands/package/version/update.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.26.5/src/commands/package/version/update.ts)_
|
|
2338
1205
|
|
|
2339
1206
|
<!-- commandsstop -->
|