@salesforce/cli 2.19.5 → 2.19.7

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 CHANGED
@@ -24,7 +24,7 @@ $ npm install -g @salesforce/cli
24
24
  $ sf COMMAND
25
25
  running command...
26
26
  $ sf (--version|-v)
27
- @salesforce/cli/2.19.5 linux-x64 node-v20.9.0
27
+ @salesforce/cli/2.19.7 linux-x64 node-v20.9.0
28
28
  $ sf --help [COMMAND]
29
29
  USAGE
30
30
  $ sf COMMAND
@@ -107,8 +107,10 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI.
107
107
  - [`sf org create user`](#sf-org-create-user)
108
108
  - [`sf org delete sandbox`](#sf-org-delete-sandbox)
109
109
  - [`sf org delete scratch`](#sf-org-delete-scratch)
110
+ - [`sf org disable tracking`](#sf-org-disable-tracking)
110
111
  - [`sf org display`](#sf-org-display)
111
112
  - [`sf org display user`](#sf-org-display-user)
113
+ - [`sf org enable tracking`](#sf-org-enable-tracking)
112
114
  - [`sf org generate password`](#sf-org-generate-password)
113
115
  - [`sf org list`](#sf-org-list)
114
116
  - [`sf org list auth`](#sf-org-list-auth)
@@ -126,6 +128,28 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI.
126
128
  - [`sf org open`](#sf-org-open)
127
129
  - [`sf org resume sandbox`](#sf-org-resume-sandbox)
128
130
  - [`sf org resume scratch`](#sf-org-resume-scratch)
131
+ - [`sf package1 version create`](#sf-package1-version-create)
132
+ - [`sf package1 version create get`](#sf-package1-version-create-get)
133
+ - [`sf package1 version display`](#sf-package1-version-display)
134
+ - [`sf package1 version list`](#sf-package1-version-list)
135
+ - [`sf package create`](#sf-package-create)
136
+ - [`sf package delete`](#sf-package-delete)
137
+ - [`sf package install`](#sf-package-install)
138
+ - [`sf package install report`](#sf-package-install-report)
139
+ - [`sf package installed list`](#sf-package-installed-list)
140
+ - [`sf package list`](#sf-package-list)
141
+ - [`sf package uninstall`](#sf-package-uninstall)
142
+ - [`sf package uninstall report`](#sf-package-uninstall-report)
143
+ - [`sf package update`](#sf-package-update)
144
+ - [`sf package version create`](#sf-package-version-create)
145
+ - [`sf package version create list`](#sf-package-version-create-list)
146
+ - [`sf package version create report`](#sf-package-version-create-report)
147
+ - [`sf package version delete`](#sf-package-version-delete)
148
+ - [`sf package version displayancestry`](#sf-package-version-displayancestry)
149
+ - [`sf package version list`](#sf-package-version-list)
150
+ - [`sf package version promote`](#sf-package-version-promote)
151
+ - [`sf package version report`](#sf-package-version-report)
152
+ - [`sf package version update`](#sf-package-version-update)
129
153
  - [`sf plugins`](#sf-plugins)
130
154
  - [`sf plugins discover`](#sf-plugins-discover)
131
155
  - [`sf plugins:inspect PLUGIN...`](#sf-pluginsinspect-plugin)
@@ -806,7 +830,7 @@ EXAMPLES
806
830
  $ sf autocomplete --refresh-cache
807
831
  ```
808
832
 
809
- _See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/3.0.1/src/commands/autocomplete/index.ts)_
833
+ _See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/3.0.2/src/commands/autocomplete/index.ts)_
810
834
 
811
835
  ## `sf commands`
812
836
 
@@ -2327,7 +2351,7 @@ FLAG DESCRIPTIONS
2327
2351
  for a number of minutes, the client exits. Specify a longer wait time if timeouts occur frequently.
2328
2352
  ```
2329
2353
 
2330
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/force/org/clone.ts)_
2354
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.7/src/commands/force/org/clone.ts)_
2331
2355
 
2332
2356
  ## `sf force org create`
2333
2357
 
@@ -2375,7 +2399,7 @@ EXAMPLES
2375
2399
  $ sf force org create -t sandbox -f config/dev-sandbox-def.json -a MyDevSandbox -u prodOrg
2376
2400
  ```
2377
2401
 
2378
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/force/org/create.ts)_
2402
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.7/src/commands/force/org/create.ts)_
2379
2403
 
2380
2404
  ## `sf force org delete`
2381
2405
 
@@ -2407,7 +2431,7 @@ EXAMPLES
2407
2431
  $ sf force org delete -u MyOrgAlias -p
2408
2432
  ```
2409
2433
 
2410
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/force/org/delete.ts)_
2434
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.7/src/commands/force/org/delete.ts)_
2411
2435
 
2412
2436
  ## `sf force org status`
2413
2437
 
@@ -2445,7 +2469,7 @@ EXAMPLES
2445
2469
  $ sf force org status --sandboxname DevSbx1 --wait 45 --setdefaultusername -u prodOrg
2446
2470
  ```
2447
2471
 
2448
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/force/org/status.ts)_
2472
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.7/src/commands/force/org/status.ts)_
2449
2473
 
2450
2474
  ## `sf force source deploy`
2451
2475
 
@@ -3637,7 +3661,7 @@ FLAG DESCRIPTIONS
3637
3661
  sandbox.
3638
3662
  ```
3639
3663
 
3640
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/org/create/sandbox.ts)_
3664
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.7/src/commands/org/create/sandbox.ts)_
3641
3665
 
3642
3666
  ## `sf org create scratch`
3643
3667
 
@@ -3790,7 +3814,7 @@ FLAG DESCRIPTIONS
3790
3814
  Omit this flag to have Salesforce generate a unique username for your org.
3791
3815
  ```
3792
3816
 
3793
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/org/create/scratch.ts)_
3817
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.7/src/commands/org/create/scratch.ts)_
3794
3818
 
3795
3819
  ## `sf org create user`
3796
3820
 
@@ -3932,7 +3956,7 @@ EXAMPLES
3932
3956
  $ sf org delete sandbox --target-org my-sandbox --no-prompt
3933
3957
  ```
3934
3958
 
3935
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/org/delete/sandbox.ts)_
3959
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.7/src/commands/org/delete/sandbox.ts)_
3936
3960
 
3937
3961
  ## `sf org delete scratch`
3938
3962
 
@@ -3974,7 +3998,44 @@ EXAMPLES
3974
3998
  $ sf org delete scratch --target-org my-scratch-org --no-prompt
3975
3999
  ```
3976
4000
 
3977
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/org/delete/scratch.ts)_
4001
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.7/src/commands/org/delete/scratch.ts)_
4002
+
4003
+ ## `sf org disable tracking`
4004
+
4005
+ Prevent Salesforce CLI from tracking changes in your source files between your project and an org.
4006
+
4007
+ ```
4008
+ USAGE
4009
+ $ sf org disable tracking -o <value> [--json]
4010
+
4011
+ FLAGS
4012
+ -o, --target-org=<value> (required) Username or alias of the target org.
4013
+
4014
+ GLOBAL FLAGS
4015
+ --json Format output as json.
4016
+
4017
+ DESCRIPTION
4018
+ Prevent Salesforce CLI from tracking changes in your source files between your project and an org.
4019
+
4020
+ Disabling source tracking has no direct effect on the org, it affects only your local environment. Specifically,
4021
+ Salesforce CLI stores the setting in the org's local configuration file so that no source tracking operations are
4022
+ executed when working with the org.
4023
+
4024
+ EXAMPLES
4025
+ Disable source tracking for an org with alias "myscratch":
4026
+
4027
+ $ sf org disable tracking --target-org myscratch
4028
+
4029
+ Disable source tracking for an org using a username:
4030
+
4031
+ $ sf org disable tracking --target-org you@example.com
4032
+
4033
+ Disable source tracking for your default org:
4034
+
4035
+ $ sf org disable tracking
4036
+ ```
4037
+
4038
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.7/src/commands/org/disable/tracking.ts)_
3978
4039
 
3979
4040
  ## `sf org display`
3980
4041
 
@@ -4017,7 +4078,7 @@ EXAMPLES
4017
4078
  $ sf org display --target-org TestOrg1 --verbose
4018
4079
  ```
4019
4080
 
4020
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/org/display.ts)_
4081
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.7/src/commands/org/display.ts)_
4021
4082
 
4022
4083
  ## `sf org display user`
4023
4084
 
@@ -4056,6 +4117,46 @@ EXAMPLES
4056
4117
 
4057
4118
  _See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.0.4/src/commands/org/display/user.ts)_
4058
4119
 
4120
+ ## `sf org enable tracking`
4121
+
4122
+ Allow Salesforce CLI to track changes in your source files between your project and an org.
4123
+
4124
+ ```
4125
+ USAGE
4126
+ $ sf org enable tracking -o <value> [--json]
4127
+
4128
+ FLAGS
4129
+ -o, --target-org=<value> (required) Username or alias of the target org.
4130
+
4131
+ GLOBAL FLAGS
4132
+ --json Format output as json.
4133
+
4134
+ DESCRIPTION
4135
+ Allow Salesforce CLI to track changes in your source files between your project and an org.
4136
+
4137
+ Enabling source tracking has no direct effect on the org, it affects only your local environment. Specifically,
4138
+ Salesforce CLI stores the setting in the org's local configuration file so that source tracking operations are
4139
+ executed when working with the org.
4140
+
4141
+ This command throws an error if the org doesn't support tracking. Examples of orgs that don't support source tracking
4142
+ include Developer Edition orgs, production orgs, Partial Copy sandboxes, and Full sandboxes.
4143
+
4144
+ EXAMPLES
4145
+ Enable source tracking for an org with alias "myscratch":
4146
+
4147
+ $ sf org enable tracking --target-org myscratch
4148
+
4149
+ Enable source tracking for an org using a username:
4150
+
4151
+ $ sf org enable tracking --target-org you@example.com
4152
+
4153
+ Enable source tracking for your default org:
4154
+
4155
+ $ sf org enable tracking
4156
+ ```
4157
+
4158
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.7/src/commands/org/enable/tracking.ts)_
4159
+
4059
4160
  ## `sf org generate password`
4060
4161
 
4061
4162
  Generate a random password for scratch org users.
@@ -4156,7 +4257,7 @@ EXAMPLES
4156
4257
  $ sf org list --clean
4157
4258
  ```
4158
4259
 
4159
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/org/list.ts)_
4260
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.7/src/commands/org/list.ts)_
4160
4261
 
4161
4262
  ## `sf org list auth`
4162
4263
 
@@ -4187,7 +4288,7 @@ EXAMPLES
4187
4288
  $ sf org list auth
4188
4289
  ```
4189
4290
 
4190
- _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0.6/src/commands/org/list/auth.ts)_
4291
+ _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0.7/src/commands/org/list/auth.ts)_
4191
4292
 
4192
4293
  ## `sf org list limits`
4193
4294
 
@@ -4289,7 +4390,7 @@ FLAG DESCRIPTIONS
4289
4390
  Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.
4290
4391
  ```
4291
4392
 
4292
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/org/list/metadata.ts)_
4393
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.7/src/commands/org/list/metadata.ts)_
4293
4394
 
4294
4395
  ## `sf org list metadata-types`
4295
4396
 
@@ -4342,7 +4443,7 @@ FLAG DESCRIPTIONS
4342
4443
  Override the api version used for api requests made by this command
4343
4444
  ```
4344
4445
 
4345
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/org/list/metadata-types.ts)_
4446
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.7/src/commands/org/list/metadata-types.ts)_
4346
4447
 
4347
4448
  ## `sf org list sobject record-counts`
4348
4449
 
@@ -4460,7 +4561,7 @@ EXAMPLES
4460
4561
 
4461
4562
  $ sf org login access-token --instance-url https://mycompany.my.salesforce.com
4462
4563
 
4463
- Authorize the org without being prompted; you must have previously set the SFDX_ACCESS_TOKEN environment variable to
4564
+ Authorize the org without being prompted; you must have previously set the SF_ACCESS_TOKEN environment variable to
4464
4565
  the access token:
4465
4566
 
4466
4567
  $ sf org login access-token --instance-url https://dev-hub.my.salesforce.com --no-prompt
@@ -4475,7 +4576,7 @@ FLAG DESCRIPTIONS
4475
4576
  To specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.
4476
4577
  ```
4477
4578
 
4478
- _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0.6/src/commands/org/login/access-token.ts)_
4579
+ _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0.7/src/commands/org/login/access-token.ts)_
4479
4580
 
4480
4581
  ## `sf org login device`
4481
4582
 
@@ -4534,7 +4635,7 @@ FLAG DESCRIPTIONS
4534
4635
  To specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.
4535
4636
  ```
4536
4637
 
4537
- _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0.6/src/commands/org/login/device.ts)_
4638
+ _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0.7/src/commands/org/login/device.ts)_
4538
4639
 
4539
4640
  ## `sf org login jwt`
4540
4641
 
@@ -4623,7 +4724,7 @@ FLAG DESCRIPTIONS
4623
4724
  To specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.
4624
4725
  ```
4625
4726
 
4626
- _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0.6/src/commands/org/login/jwt.ts)_
4727
+ _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0.7/src/commands/org/login/jwt.ts)_
4627
4728
 
4628
4729
  ## `sf org login sfdx-url`
4629
4730
 
@@ -4681,7 +4782,7 @@ EXAMPLES
4681
4782
  $ sf org login sfdx-url --sfdx-url-file files/authFile.json --set-default --alias MyDefaultOrg
4682
4783
  ```
4683
4784
 
4684
- _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0.6/src/commands/org/login/sfdx-url.ts)_
4785
+ _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0.7/src/commands/org/login/sfdx-url.ts)_
4685
4786
 
4686
4787
  ## `sf org login web`
4687
4788
 
@@ -4766,7 +4867,7 @@ FLAG DESCRIPTIONS
4766
4867
  To specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.
4767
4868
  ```
4768
4869
 
4769
- _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0.6/src/commands/org/login/web.ts)_
4870
+ _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0.7/src/commands/org/login/web.ts)_
4770
4871
 
4771
4872
  ## `sf org logout`
4772
4873
 
@@ -4826,7 +4927,7 @@ FLAG DESCRIPTIONS
4826
4927
  All orgs includes Dev Hubs, sandboxes, DE orgs, and expired, deleted, and unknown-status scratch orgs.
4827
4928
  ```
4828
4929
 
4829
- _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0.6/src/commands/org/logout.ts)_
4930
+ _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0.7/src/commands/org/logout.ts)_
4830
4931
 
4831
4932
  ## `sf org open`
4832
4933
 
@@ -4891,7 +4992,7 @@ EXAMPLES
4891
4992
  $ sf org open --source-file force-app/main/default/flows/Hello.flow-meta.xml
4892
4993
  ```
4893
4994
 
4894
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/org/open.ts)_
4995
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.7/src/commands/org/open.ts)_
4895
4996
 
4896
4997
  ## `sf org resume sandbox`
4897
4998
 
@@ -4953,7 +5054,7 @@ FLAG DESCRIPTIONS
4953
5054
  returns the job ID. To resume checking the sandbox creation, rerun this command.
4954
5055
  ```
4955
5056
 
4956
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/org/resume/sandbox.ts)_
5057
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.7/src/commands/org/resume/sandbox.ts)_
4957
5058
 
4958
5059
  ## `sf org resume scratch`
4959
5060
 
@@ -4999,7 +5100,1092 @@ FLAG DESCRIPTIONS
4999
5100
  The job ID is valid for 24 hours after you start the scratch org creation.
5000
5101
  ```
5001
5102
 
5002
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/org/resume/scratch.ts)_
5103
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.7/src/commands/org/resume/scratch.ts)_
5104
+
5105
+ ## `sf package1 version create`
5106
+
5107
+ Create a first-generation package version in the release org.
5108
+
5109
+ ```
5110
+ USAGE
5111
+ $ sf package1 version create -o <value> -i <value> -n <value> [--api-version <value>] [-d <value>] [-v <value>] [-m] [-r
5112
+ <value>] [-p <value>] [-k <value>] [-w <value>]
5113
+
5114
+ FLAGS
5115
+ -d, --description=<value> Package version description.
5116
+ -i, --package-id=<value> (required) ID of the metadata package (starts with 033) of which you’re creating a
5117
+ new version.
5118
+ -k, --installation-key=<value> Installation key for key-protected package (default: null).
5119
+ -m, --managed-released Create a managed package version.
5120
+ -n, --name=<value> (required) Package version name.
5121
+ -o, --target-org=<value> (required) Username or alias of the target org.
5122
+ -p, --post-install-url=<value> Post install URL.
5123
+ -r, --release-notes-url=<value> Release notes URL.
5124
+ -v, --version=<value> Package version in major.minor format, for example, 3.2.
5125
+ -w, --wait=<value> Minutes to wait for the package version to be created (default: 2 minutes).
5126
+ --api-version=<value> Override the api version used for api requests made by this command
5127
+
5128
+ DESCRIPTION
5129
+ Create a first-generation package version in the release org.
5130
+
5131
+ The package version is based on the contents of the specified metadata package. Omit --managed-released if you want to
5132
+ create an unmanaged package version.
5133
+
5134
+ ALIASES
5135
+ $ sf force package1 version create
5136
+
5137
+ EXAMPLES
5138
+ Create a first-generation package version from the package with the specified ID and name the package version
5139
+ "example"; use your default org:
5140
+
5141
+ $ sf package1 version create --package-id 033... --name example
5142
+
5143
+ Same as previous example, but provide a description and wait for 30 minutes for the package version to be created;
5144
+ use the specified org:
5145
+
5146
+ $ sf package1 version create --package-id 033... --name example --description "example description" --wait 30 \
5147
+ --target-org myorg@example.com
5148
+
5149
+ FLAG DESCRIPTIONS
5150
+ -m, --managed-released Create a managed package version.
5151
+
5152
+ To create a beta version, don’t include this parameter.
5153
+
5154
+ -p, --post-install-url=<value> Post install URL.
5155
+
5156
+ The contents of the post-installation instructions URL are displayed in the UI after installation of the package
5157
+ version.
5158
+
5159
+ -r, --release-notes-url=<value> Release notes URL.
5160
+
5161
+ This link is displayed in the package installation UI to provide release notes for this package version to
5162
+ subscribers.
5163
+ ```
5164
+
5165
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/1.27.2/src/commands/package1/version/create.ts)_
5166
+
5167
+ ## `sf package1 version create get`
5168
+
5169
+ Retrieve the status of a package version creation request.
5170
+
5171
+ ```
5172
+ USAGE
5173
+ $ sf package1 version create get -o <value> -i <value> [--api-version <value>]
5174
+
5175
+ FLAGS
5176
+ -i, --request-id=<value> (required) ID of the PackageUploadRequest (starts with 0HD).
5177
+ -o, --target-org=<value> (required) Username or alias of the target org.
5178
+ --api-version=<value> Override the api version used for api requests made by this command
5179
+
5180
+ ALIASES
5181
+ $ sf force package1 version create get
5182
+
5183
+ EXAMPLES
5184
+ Get the status of the creation request for the package version with the specified ID in your default org:
5185
+
5186
+ $ sf package1 version create get --request-id 0HD...
5187
+
5188
+ Same as previous example, but use the specified org:
5189
+
5190
+ $ sf package1 version create get --request-id 0HD... --target-org myorg@example.com
5191
+ ```
5192
+
5193
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/1.27.2/src/commands/package1/version/create/get.ts)_
5194
+
5195
+ ## `sf package1 version display`
5196
+
5197
+ Display details about a first-generation package version.
5198
+
5199
+ ```
5200
+ USAGE
5201
+ $ sf package1 version display -o <value> -i <value> [--api-version <value>]
5202
+
5203
+ FLAGS
5204
+ -i, --package-version-id=<value> (required) ID (starts with 04t) of the metadata package version whose details you
5205
+ want to display.
5206
+ -o, --target-org=<value> (required) Username or alias of the target org.
5207
+ --api-version=<value> Override the api version used for api requests made by this command
5208
+
5209
+ ALIASES
5210
+ $ sf force package1 version display
5211
+
5212
+ EXAMPLES
5213
+ Display details about the first-generation package version with the specified ID in your default org:
5214
+
5215
+ $ sf package1 version display --package-version-id 04t...
5216
+
5217
+ Same as previous example, but use the specified org:
5218
+
5219
+ $ sf package1 version display --package-version-id 04t... --target-org myorg@example.com
5220
+ ```
5221
+
5222
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/1.27.2/src/commands/package1/version/display.ts)_
5223
+
5224
+ ## `sf package1 version list`
5225
+
5226
+ List package versions for the specified first-generation package or for the org.
5227
+
5228
+ ```
5229
+ USAGE
5230
+ $ sf package1 version list -o <value> [--api-version <value>] [-i <value>]
5231
+
5232
+ FLAGS
5233
+ -i, --package-id=<value> Metadata package ID (starts with 033) whose package versions you want to list.
5234
+ -o, --target-org=<value> (required) Username or alias of the target org.
5235
+ --api-version=<value> Override the api version used for api requests made by this command
5236
+
5237
+ ALIASES
5238
+ $ sf force package1 version list
5239
+
5240
+ EXAMPLES
5241
+ List all first-generation package versions in your default org:
5242
+
5243
+ $ sf package1 version list
5244
+
5245
+ List package versions for the specified first-generation package in the specifief org:
5246
+
5247
+ $ sf package1 version list --package-id 033... --target-org myorg@example.com
5248
+
5249
+ FLAG DESCRIPTIONS
5250
+ -i, --package-id=<value> Metadata package ID (starts with 033) whose package versions you want to list.
5251
+
5252
+ If not specified, shows all versions for all packages (managed and unmanaged) in the org.
5253
+ ```
5254
+
5255
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/1.27.2/src/commands/package1/version/list.ts)_
5256
+
5257
+ ## `sf package create`
5258
+
5259
+ Create a package.
5260
+
5261
+ ```
5262
+ USAGE
5263
+ $ sf package create -v <value> -n <value> -t Managed|Unlocked -r <value> [--api-version <value>] [-d <value>] [-e]
5264
+ [--org-dependent] [-o <value>]
5265
+
5266
+ FLAGS
5267
+ -d, --description=<value> Description of the package.
5268
+ -e, --no-namespace Create the package with no namespace; available only for unlocked packages.
5269
+ -n, --name=<value> (required) Name of the package to create.
5270
+ -o, --error-notification-username=<value> Active Dev Hub user designated to receive email notifications for package
5271
+ errors.
5272
+ -r, --path=<value> (required) Path to directory that contains the contents of the package.
5273
+ -t, --package-type=<option> (required) Type of package.
5274
+ <options: Managed|Unlocked>
5275
+ -v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
5276
+ --api-version=<value> Override the api version used for api requests made by this command
5277
+ --org-dependent Depends on unpackaged metadata in the installation org; applies to unlocked
5278
+ packages only.
5279
+
5280
+ DESCRIPTION
5281
+ Create a package.
5282
+
5283
+ First, use this command to create a package. Then create a package version.
5284
+
5285
+ If you don’t have a namespace defined in your sfdx-project.json file, use --no-namespace.
5286
+
5287
+ Your --name value must be unique within your namespace.
5288
+
5289
+ Run 'sf package list to list all packages in the Dev Hub org.
5290
+
5291
+ ALIASES
5292
+ $ sf force package create
5293
+
5294
+ EXAMPLES
5295
+ Create an unlocked package from the files in the "force-app" directory; uses your default Dev Hub org:
5296
+
5297
+ $ sf package create --name MyUnlockedPackage --package-type Unlocked --path force-app
5298
+
5299
+ Create a managed packaged from the "force-app" directory files, give the package a description, and use the
5300
+ specified Dev Hub org:
5301
+
5302
+ $ sf package create --name MyManagedPackage --description "Your Package Descripton" --package-type Managed \
5303
+ --path force-app --target-dev-hub devhub@example.com
5304
+
5305
+ FLAG DESCRIPTIONS
5306
+ -e, --no-namespace Create the package with no namespace; available only for unlocked packages.
5307
+
5308
+ This flag is useful when you’re migrating an existing org to packages. But use a namespaced package for new
5309
+ metadata.
5310
+
5311
+ -o, --error-notification-username=<value>
5312
+
5313
+ Active Dev Hub user designated to receive email notifications for package errors.
5314
+
5315
+ Email notifications include information about unhandled Apex exceptions, and install, upgrade, or uninstall failures
5316
+ associated with your package.
5317
+
5318
+ -t, --package-type=Managed|Unlocked Type of package.
5319
+
5320
+ The options for package type are Managed and Unlocked (Managed=DeveloperManagedSubscriberManaged,
5321
+ Unlocked=DeveloperControlledSubscriberEditable). These options determine upgrade and editability rules.
5322
+
5323
+ --org-dependent Depends on unpackaged metadata in the installation org; applies to unlocked packages only.
5324
+
5325
+ Use Source Tracking in Sandboxes to develop your org-dependent unlocked package. For more information, see "Create
5326
+ Org-Dependent Unlocked Packages" in the Salesforce DX Developer Guide.
5327
+ ```
5328
+
5329
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/1.27.2/src/commands/package/create.ts)_
5330
+
5331
+ ## `sf package delete`
5332
+
5333
+ Delete a package.
5334
+
5335
+ ```
5336
+ USAGE
5337
+ $ sf package delete -v <value> -p <value> [--api-version <value>] [-n]
5338
+
5339
+ FLAGS
5340
+ -n, --no-prompt Don’t prompt before deleting the package.
5341
+ -p, --package=<value> (required) ID (starts with 0Ho) or alias of the package to delete.
5342
+ -v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
5343
+ --api-version=<value> Override the api version used for api requests made by this command
5344
+
5345
+ DESCRIPTION
5346
+ Delete a package.
5347
+
5348
+ Specify the ID or alias of the package you want to delete.
5349
+
5350
+ Delete unlocked and second-generation managed packages. Before you delete a package, first delete all associated
5351
+ package versions.
5352
+
5353
+ ALIASES
5354
+ $ sf force package delete
5355
+
5356
+ EXAMPLES
5357
+ Delete a package using its alias from your default Dev Hub org:
5358
+
5359
+ $ sf package delete --package "Your Package Alias"
5360
+
5361
+ Delete a package using its ID from the specified Dev Hub org:
5362
+
5363
+ $ sf package delete --package 0Ho... --target-dev-hub devhub@example.com
5364
+ ```
5365
+
5366
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/1.27.2/src/commands/package/delete.ts)_
5367
+
5368
+ ## `sf package install`
5369
+
5370
+ Install a version of a package in the target org.
5371
+
5372
+ ```
5373
+ USAGE
5374
+ $ sf package install -o <value> -p <value> [--api-version <value>] [-w <value>] [-k <value>] [-b <value>] [-r] [-a
5375
+ all|package] [-s AllUsers|AdminsOnly] [-t DeprecateOnly|Mixed|Delete]
5376
+
5377
+ FLAGS
5378
+ -a, --apex-compile=<option> [default: all] Compile all Apex in the org and package, or only Apex in the package;
5379
+ unlocked packages only.
5380
+ <options: all|package>
5381
+ -b, --publish-wait=<value> [default: [object Object]] Maximum number of minutes to wait for the Subscriber
5382
+ Package Version ID to become available in the target org before canceling the install
5383
+ request.
5384
+ -k, --installation-key=<value> Installation key for key-protected package (default: null).
5385
+ -o, --target-org=<value> (required) Username or alias of the target org.
5386
+ -p, --package=<value> (required) ID (starts with 04t) or alias of the package version to install.
5387
+ -r, --no-prompt Don't prompt for confirmation.
5388
+ -s, --security-type=<option> [default: AdminsOnly] Security access type for the installed package. (deprecation
5389
+ notice: The default --security-type value will change from AllUsers to AdminsOnly in
5390
+ v47.0 or later.)
5391
+ <options: AllUsers|AdminsOnly>
5392
+ -t, --upgrade-type=<option> [default: Mixed] Upgrade type for the package installation; available only for
5393
+ unlocked packages.
5394
+ <options: DeprecateOnly|Mixed|Delete>
5395
+ -w, --wait=<value> [default: [object Object]] Number of minutes to wait for installation status.
5396
+ --api-version=<value> Override the api version used for api requests made by this command
5397
+
5398
+ DESCRIPTION
5399
+ Install a version of a package in the target org.
5400
+
5401
+ To install a package, specify a specific version of the package using the 04t package ID. The package and the version
5402
+ you specified installs in your default target org unless you supply the username for a different target org.
5403
+
5404
+ For package upgrades, to specify options for component deprecation or deletion of removed components, include an
5405
+ --upgrade-type value. To delete components that can be safely deleted and deprecate the others, specify --upgrade-type
5406
+ Mixed (the default). To deprecate all removed components, specify --upgrade-type DeprecateOnly. To delete all removed
5407
+ components, except for custom objects and custom fields, that don't have dependencies, specify --upgrade-type Delete.
5408
+ (Note: This option can result in the loss of data that is associated with the deleted components.) The default is
5409
+ Mixed.
5410
+
5411
+ ALIASES
5412
+ $ sf force package install
5413
+
5414
+ EXAMPLES
5415
+ Install a package version with the specified ID in the org with username "me@example.com":
5416
+
5417
+ $ sf package install --package 04t... --target-org me@example.com
5418
+
5419
+ Install a package version with the specified alias into your default org:
5420
+
5421
+ $ sf package install --package awesome_package_alias
5422
+
5423
+ Install a package version with an alias that includes spaces into your default org:
5424
+
5425
+ $ sf package install --package "Awesome Package Alias"
5426
+
5427
+ Install an unlocked package version with the specified ID and deprecate all removed components:
5428
+
5429
+ $ sf package install --package 04t... --upgrade-type DeprecateOnly
5430
+
5431
+ FLAG DESCRIPTIONS
5432
+ -a, --apex-compile=all|package
5433
+
5434
+ Compile all Apex in the org and package, or only Apex in the package; unlocked packages only.
5435
+
5436
+ Applies to unlocked packages only. Specifies whether to compile all Apex in the org and package, or only the Apex in
5437
+ the package.
5438
+
5439
+ For package installs into production orgs, or any org that has Apex Compile on Deploy enabled, the platform compiles
5440
+ all Apex in the org after the package install or upgrade operation completes.
5441
+
5442
+ This approach assures that package installs and upgrades don’t impact the performance of an org, and is done even if
5443
+ --apex-compile package is specified.
5444
+
5445
+ -r, --no-prompt Don't prompt for confirmation.
5446
+
5447
+ Allows the following without an explicit confirmation response: 1) Remote Site Settings and Content Security Policy
5448
+ websites to send or receive data, and 2) --upgrade-type Delete to proceed.
5449
+
5450
+ -t, --upgrade-type=DeprecateOnly|Mixed|Delete
5451
+
5452
+ Upgrade type for the package installation; available only for unlocked packages.
5453
+
5454
+ For package upgrades, specifies whether to mark all removed components as deprecated (DeprecateOnly), to delete
5455
+ removed components that can be safely deleted and deprecate the others (Mixed), or to delete all removed components,
5456
+ except for custom objects and custom fields, that don't have dependencies (Delete). The default is Mixed. Can
5457
+ specify DeprecateOnly or Delete only for unlocked package upgrades.
5458
+ ```
5459
+
5460
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/1.27.2/src/commands/package/install.ts)_
5461
+
5462
+ ## `sf package install report`
5463
+
5464
+ Retrieve the status of a package installation request.
5465
+
5466
+ ```
5467
+ USAGE
5468
+ $ sf package install report -o <value> -i <value> [--api-version <value>]
5469
+
5470
+ FLAGS
5471
+ -i, --request-id=<value> (required) ID of the package install request you want to check; starts with 0Hf.
5472
+ -o, --target-org=<value> (required) Username or alias of the target org.
5473
+ --api-version=<value> Override the api version used for api requests made by this command
5474
+
5475
+ ALIASES
5476
+ $ sf force package install report
5477
+
5478
+ EXAMPLES
5479
+ Retrieve the status of a package installation request with the specified ID on your default org:
5480
+
5481
+ $ sf package install report --request-id 0Hf...
5482
+
5483
+ Similar to previous example, except use the org with username me@example.com:
5484
+
5485
+ $ sf package install report --request-id 0Hf... --target-org me@example.com
5486
+ ```
5487
+
5488
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/1.27.2/src/commands/package/install/report.ts)_
5489
+
5490
+ ## `sf package installed list`
5491
+
5492
+ List the org’s installed packages.
5493
+
5494
+ ```
5495
+ USAGE
5496
+ $ sf package installed list -o <value> [--api-version <value>]
5497
+
5498
+ FLAGS
5499
+ -o, --target-org=<value> (required) Username or alias of the target org.
5500
+ --api-version=<value> Override the api version used for api requests made by this command
5501
+
5502
+ ALIASES
5503
+ $ sf force package installed list
5504
+
5505
+ EXAMPLES
5506
+ List the installed packages in your default org:
5507
+
5508
+ $ sf package installed list
5509
+
5510
+ List the installed packages in the org with username me@example.com:
5511
+
5512
+ $ sf package installed list --target-org me@example.com
5513
+ ```
5514
+
5515
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/1.27.2/src/commands/package/installed/list.ts)_
5516
+
5517
+ ## `sf package list`
5518
+
5519
+ List all packages in the Dev Hub org.
5520
+
5521
+ ```
5522
+ USAGE
5523
+ $ sf package list -v <value> [--api-version <value>] [--verbose]
5524
+
5525
+ FLAGS
5526
+ -v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
5527
+ --api-version=<value> Override the api version used for api requests made by this command
5528
+ --verbose Display extended package detail.
5529
+
5530
+ DESCRIPTION
5531
+ List all packages in the Dev Hub org.
5532
+
5533
+ Description
5534
+
5535
+ ALIASES
5536
+ $ sf force package list
5537
+
5538
+ EXAMPLES
5539
+ List all packages in the specified Dev Hub org:
5540
+
5541
+ $ sf package list --target-dev-hub devhub@example.com
5542
+
5543
+ List all packages details in the specified Dev Hub org, and show extended details about each package:
5544
+
5545
+ $ sf package list --target-dev-hub devhub@example.com --verbose
5546
+ ```
5547
+
5548
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/1.27.2/src/commands/package/list.ts)_
5549
+
5550
+ ## `sf package uninstall`
5551
+
5552
+ Uninstall a second-generation package from the target org.
5553
+
5554
+ ```
5555
+ USAGE
5556
+ $ sf package uninstall -o <value> -p <value> [--api-version <value>] [-w <value>]
5557
+
5558
+ FLAGS
5559
+ -o, --target-org=<value> (required) Username or alias of the target org.
5560
+ -p, --package=<value> (required) ID (starts with 04t) or alias of the package version to uninstall.
5561
+ -w, --wait=<value> [default: [object Object]] Number of minutes to wait for uninstall status.
5562
+ --api-version=<value> Override the api version used for api requests made by this command
5563
+
5564
+ DESCRIPTION
5565
+ Uninstall a second-generation package from the target org.
5566
+
5567
+ Specify the package ID for a second-generation package.
5568
+
5569
+ To list the org’s installed packages, run "sf package installed list".
5570
+
5571
+ To uninstall a first-generation package, from Setup, enter Installed Packages in the Quick Find box, then select
5572
+ Installed Packages.
5573
+
5574
+ ALIASES
5575
+ $ sf force package uninstall
5576
+
5577
+ EXAMPLES
5578
+ Uninstall a package with specified ID from an org with username me@example.com:
5579
+
5580
+ $ sf package uninstall --package 04t... --target-org me@example.com
5581
+
5582
+ Uninstall a package with the specified alias from your default org:
5583
+
5584
+ $ sf package uninstall --package undesirable_package_alias
5585
+
5586
+ Uninstall a package with an alias that contains spaces from your default org:
5587
+
5588
+ $ sf package uninstall --package "Undesirable Package Alias"
5589
+ ```
5590
+
5591
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/1.27.2/src/commands/package/uninstall.ts)_
5592
+
5593
+ ## `sf package uninstall report`
5594
+
5595
+ Retrieve the status of a package uninstall request.
5596
+
5597
+ ```
5598
+ USAGE
5599
+ $ sf package uninstall report -o <value> -i <value> [--api-version <value>]
5600
+
5601
+ FLAGS
5602
+ -i, --request-id=<value> (required) ID of the package uninstall request you want to check; starts with 06y.
5603
+ -o, --target-org=<value> (required) Username or alias of the target org.
5604
+ --api-version=<value> Override the api version used for api requests made by this command
5605
+
5606
+ ALIASES
5607
+ $ sf force package uninstall report
5608
+
5609
+ EXAMPLES
5610
+ Retrieve the status of a package uninstall in your default org using the specified request ID:
5611
+
5612
+ $ sf package uninstall report --request-id 06y...
5613
+
5614
+ Similar to previous example, but use the org with username me@example.com:
5615
+
5616
+ $ sf package uninstall report --request-id 06y... --target-org me@example.com
5617
+ ```
5618
+
5619
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/1.27.2/src/commands/package/uninstall/report.ts)_
5620
+
5621
+ ## `sf package update`
5622
+
5623
+ Update package details.
5624
+
5625
+ ```
5626
+ USAGE
5627
+ $ sf package update -v <value> -p <value> [--api-version <value>] [-n <value>] [-d <value>] [-o <value>]
5628
+ [--enable-app-analytics]
5629
+
5630
+ FLAGS
5631
+ -d, --description=<value> New description of the package.
5632
+ -n, --name=<value> New name of the package.
5633
+ -o, --error-notification-username=<value> Active Dev Hub user designated to receive email notifications for package
5634
+ errors.
5635
+ -p, --package=<value> (required) ID (starts with 0Ho) or alias of the package to update.
5636
+ -v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
5637
+ --api-version=<value> Override the api version used for api requests made by this command
5638
+ --[no-]enable-app-analytics Enable AppExchange App Analytics usage data collection on this managed
5639
+ package and its components.
5640
+
5641
+ DESCRIPTION
5642
+ Update package details.
5643
+
5644
+ Specify a new value for each option you want to update.
5645
+
5646
+ Run "sf package list" to list all packages in the Dev Hub org.
5647
+
5648
+ ALIASES
5649
+ $ sf force package update
5650
+
5651
+ EXAMPLES
5652
+ Update the name of the package with the specified alias; uses your default Dev Hub org:
5653
+
5654
+ $ sf package update --package "Your Package Alias" --name "New Package Name"
5655
+
5656
+ Update the description of the package with the specified ID; uses the specified Dev Hub org:
5657
+
5658
+ $ sf package update --package 0Ho... --description "New Package Description" --target-dev-hub devhub@example.com
5659
+
5660
+ FLAG DESCRIPTIONS
5661
+ -o, --error-notification-username=<value>
5662
+
5663
+ Active Dev Hub user designated to receive email notifications for package errors.
5664
+
5665
+ Email notifications include information about unhandled Apex exceptions, and install, upgrade, or uninstall failures
5666
+ associated with your package.
5667
+ ```
5668
+
5669
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/1.27.2/src/commands/package/update.ts)_
5670
+
5671
+ ## `sf package version create`
5672
+
5673
+ Create a package version in the Dev Hub org.
5674
+
5675
+ ```
5676
+ USAGE
5677
+ $ sf package version create -v <value> [--api-version <value>] [-b <value>] [-c | --skip-validation] [-f <value>] [-k
5678
+ <value>] [-x] [-p <value>] [-d <value>] [--post-install-script <value>] [--post-install-url <value>]
5679
+ [--releasenotes-url <value>] [--skip-ancestor-check] [-t <value>] [--uninstall-script <value>] [-e <value>] [-a
5680
+ <value>] [-n <value>] [-w <value>] [--language <value>] [--verbose]
5681
+
5682
+ FLAGS
5683
+ -a, --version-name=<value> Name of the package version to be created; overrides the sfdx-project.json value.
5684
+ -b, --branch=<value> Name of the branch in your source control system that the package version is based
5685
+ on.
5686
+ -c, --code-coverage Calculate and store the code coverage percentage by running the packaged Apex tests
5687
+ included in this package version.
5688
+ -d, --path=<value> Path to the directory that contains the contents of the package.
5689
+ -e, --version-description=<value> Description of the package version to be created; overrides the sfdx-project.json
5690
+ value.
5691
+ -f, --definition-file=<value> Path to a definition file similar to scratch org definition file that contains the
5692
+ list of features and org preferences that the metadata of the package version
5693
+ depends on.
5694
+ -k, --installation-key=<value> Installation key for key-protected package. (either --installation-key or
5695
+ --installation-key-bypass is required)
5696
+ -n, --version-number=<value> Version number of the package version to be created; overrides the
5697
+ sfdx-project.json value.
5698
+ -p, --package=<value> ID (starts with 0Ho) or alias of the package to create a version of.
5699
+ -t, --tag=<value> Package version’s tag.
5700
+ -v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
5701
+ -w, --wait=<value> [default: [object Object]] Number of minutes to wait for the package version to be
5702
+ created.
5703
+ -x, --installation-key-bypass Bypass the installation key requirement. (either --installation-key or
5704
+ --installation-key-bypass is required)
5705
+ --api-version=<value> Override the api version used for api requests made by this command
5706
+ --language=<value> Language for the package.
5707
+ --post-install-script=<value> Name of the post-install script; applies to managed packages only.
5708
+ --post-install-url=<value> Post-install instructions URL.
5709
+ --releasenotes-url=<value> Release notes URL.
5710
+ --skip-ancestor-check Overrides ancestry requirements, which allows you to specify a package ancestor
5711
+ that isn’t the highest released package version.
5712
+ --skip-validation Skip validation during package version creation; you can’t promote unvalidated
5713
+ package versions.
5714
+ --uninstall-script=<value> Uninstall script name; applies to managed packages only.
5715
+ --verbose Display verbose command output.
5716
+
5717
+ DESCRIPTION
5718
+ Create a package version in the Dev Hub org.
5719
+
5720
+ The package version is based on the package contents in the specified directory.
5721
+
5722
+ To retrieve details about a package version create request, including status and package version ID (04t), run "sf
5723
+ package version create report -i 08c...".
5724
+
5725
+ We recommend that you specify the --installation-key parameter to protect the contents of your package and to prevent
5726
+ unauthorized installation of your package.
5727
+
5728
+ To list package version creation requests in the org, run "sf package version create list".
5729
+ To promote a package version to released, you must use the --code-coverage parameter. The package must also meet the
5730
+ code coverage requirements. This requirement applies to both managed and unlocked packages.
5731
+
5732
+ We don’t calculate code coverage for org-dependent unlocked packages, or for package versions that specify
5733
+ --skip-validation.
5734
+
5735
+ ALIASES
5736
+ $ sf force package version create
5737
+
5738
+ EXAMPLES
5739
+ Create a package version from the contents of the "common" directory and give it an installation key of
5740
+ "password123"; uses your default Dev Hub org:
5741
+
5742
+ $ sf package version create --path common --installation-key password123
5743
+
5744
+ Create a package version from a package with the specified alias; uses the Dev Hub org with username
5745
+ devhub@example.com:
5746
+
5747
+ $ sf package version create --package "Your Package Alias" --installation-key password123 --target-dev-hub \
5748
+ devhub@example.com
5749
+
5750
+ Create a package version from a package with the specified ID:
5751
+
5752
+ $ sf package version create --package 0Ho... --installation-key password123
5753
+
5754
+ Create a package version and skip the validation step:
5755
+
5756
+ $ sf package version create --path common --installation-key password123 --skip-validation
5757
+
5758
+ FLAG DESCRIPTIONS
5759
+ -c, --code-coverage
5760
+
5761
+ Calculate and store the code coverage percentage by running the packaged Apex tests included in this package
5762
+ version.
5763
+
5764
+ Before you can promote and release a managed or unlocked package version, the Apex code must meet a minimum 75% code
5765
+ coverage requirement. We don’t calculate code coverage for org-dependent unlocked packages or for package versions
5766
+ that specify --skip-validation.
5767
+
5768
+ -n, --version-number=<value>
5769
+
5770
+ Version number of the package version to be created; overrides the sfdx-project.json value.
5771
+
5772
+ For information about the format of the version number, see
5773
+ https://developer.salesforce.com/docs/atlas.en-us.pkg2_dev.meta/pkg2_dev/sfdx_dev2gp_config_file.htm.
5774
+
5775
+ -x, --installation-key-bypass
5776
+
5777
+ Bypass the installation key requirement. (either --installation-key or --installation-key-bypass is required)
5778
+
5779
+ If you bypass this requirement, anyone can install your package.
5780
+
5781
+ --language=<value> Language for the package.
5782
+
5783
+ Specify the language using a language code listed under "Supported Languages" in Salesforce Help. If no language is
5784
+ specified, the language defaults to the language of the Dev Hub user who created the package.
5785
+
5786
+ --post-install-script=<value> Name of the post-install script; applies to managed packages only.
5787
+
5788
+ The post-install script is an Apex class within this package that is run in the installing org after installations
5789
+ or upgrades of this package version.
5790
+
5791
+ --post-install-url=<value> Post-install instructions URL.
5792
+
5793
+ The contents of the post-installation instructions URL are displayed in the UI after installation of the package
5794
+ version.
5795
+
5796
+ --releasenotes-url=<value> Release notes URL.
5797
+
5798
+ This link is displayed in the package installation UI to provide release notes for this package version to
5799
+ subscribers.
5800
+
5801
+ --skip-validation Skip validation during package version creation; you can’t promote unvalidated package versions.
5802
+
5803
+ Skips validation of dependencies, package ancestors, and metadata during package version creation. Skipping
5804
+ validation reduces the time it takes to create a new package version, but you can promote only validated package
5805
+ versions. Skipping validation can suppress important errors that can surface at a later stage. You can specify skip
5806
+ validation or code coverage, but not both. Code coverage is calculated during validation.
5807
+
5808
+ --uninstall-script=<value> Uninstall script name; applies to managed packages only.
5809
+
5810
+ The uninstall script is an Apex class within this package that is run in the installing org after uninstallations of
5811
+ this package.
5812
+
5813
+ --verbose Display verbose command output.
5814
+
5815
+ Display verbose command output. When polling for the status of the creation, this will output status and timeout
5816
+ data on a separate line for each poll request, which is useful in CI systems where timeouts can occur with long
5817
+ periods of no output from commands.
5818
+ ```
5819
+
5820
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/1.27.2/src/commands/package/version/create.ts)_
5821
+
5822
+ ## `sf package version create list`
5823
+
5824
+ List package version creation requests.
5825
+
5826
+ ```
5827
+ USAGE
5828
+ $ sf package version create list -v <value> [--api-version <value>] [-c <value>] [-s Queued|InProgress|Success|Error]
5829
+ [--show-conversions-only] [--verbose]
5830
+
5831
+ FLAGS
5832
+ -c, --created-last-days=<value> Number of days since the request was created, starting at 00:00:00 of first day to
5833
+ now. Use 0 for today.
5834
+ -s, --status=<option> Status of the version creation request, used to filter the list.
5835
+ <options: Queued|InProgress|Success|Error>
5836
+ -v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
5837
+ --api-version=<value> Override the api version used for api requests made by this command
5838
+ --show-conversions-only Filter the list output to display only converted package version.
5839
+ --verbose Displays additional information at a slight performance cost, such as the version
5840
+ name and number for each package version create request.
5841
+
5842
+ DESCRIPTION
5843
+ List package version creation requests.
5844
+
5845
+ Shows the details of each request to create a package version in the Dev Hub org.
5846
+
5847
+ All filter parameters are applied using the AND logical operator (not OR).
5848
+
5849
+ To get information about a specific request, run "sf package version create report" and supply the request ID.
5850
+
5851
+ ALIASES
5852
+ $ sf force package version create list
5853
+
5854
+ EXAMPLES
5855
+ List all package version creation requests in your default Dev Hub org:
5856
+
5857
+ $ sf package version create list
5858
+
5859
+ List package version creation requests from the last 3 days in the Dev Hub org with username devhub@example.com:
5860
+
5861
+ $ sf package version create list --created-last-days 3 --target-dev-hub
5862
+
5863
+ List package version creation requests with status Error:
5864
+
5865
+ $ sf package version create list --status Error
5866
+
5867
+ List package version creation requests with status InProgress:
5868
+
5869
+ $ sf package version create list --status InProgress
5870
+
5871
+ List package version creation requests with status Success that were created today:
5872
+
5873
+ $ sf package version create list --created-last-days 0 --status Success
5874
+ ```
5875
+
5876
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/1.27.2/src/commands/package/version/create/list.ts)_
5877
+
5878
+ ## `sf package version create report`
5879
+
5880
+ Retrieve details about a package version creation request.
5881
+
5882
+ ```
5883
+ USAGE
5884
+ $ sf package version create report -v <value> -i <value> [--api-version <value>]
5885
+
5886
+ FLAGS
5887
+ -i, --package-create-request-id=<value> (required) ID (starts with 08c) of the package version creation request you
5888
+ want to display.
5889
+ -v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
5890
+ --api-version=<value> Override the api version used for api requests made by this command
5891
+
5892
+ DESCRIPTION
5893
+ Retrieve details about a package version creation request.
5894
+
5895
+ Specify the request ID for which you want to view details. If applicable, the command displays errors related to the
5896
+ request.
5897
+
5898
+ To show all requests in the org, run "sf package version create list".
5899
+
5900
+ ALIASES
5901
+ $ sf force package version create report
5902
+
5903
+ EXAMPLES
5904
+ Retrieve details about the package version creation request with the specified ID; uses your default Dev Hub org:
5905
+
5906
+ $ sf package version create report --package-create-request-id 08c...
5907
+
5908
+ Retrieve details about the specified package version creation request in the Dev Hub org with username
5909
+ devhub@example.com:
5910
+
5911
+ $ sf package version create report --package-create-request-id 08c... --target-dev-hub devhub@example.com
5912
+ ```
5913
+
5914
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/1.27.2/src/commands/package/version/create/report.ts)_
5915
+
5916
+ ## `sf package version delete`
5917
+
5918
+ Delete a package version.
5919
+
5920
+ ```
5921
+ USAGE
5922
+ $ sf package version delete -v <value> -p <value> [--api-version <value>] [-n]
5923
+
5924
+ FLAGS
5925
+ -n, --no-prompt Don’t prompt before deleting the package version.
5926
+ -p, --package=<value> (required) ID (starts with 04t) or alias of the package version to delete.
5927
+ -v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
5928
+ --api-version=<value> Override the api version used for api requests made by this command
5929
+
5930
+ DESCRIPTION
5931
+ Delete a package version.
5932
+
5933
+ Specify the ID or alias of the package version you want to delete.
5934
+
5935
+ ALIASES
5936
+ $ sf force package version delete
5937
+
5938
+ EXAMPLES
5939
+ Delete a package version with the specified alias using your default Dev Hub org:
5940
+
5941
+ $ sf package version delete --package "Your Package Alias"
5942
+
5943
+ Delete a package version with the specified ID using the Dev Hub org with username "devhub@example.com":
5944
+
5945
+ $ sf package version delete --package 04t... --target-org devhub@example.com
5946
+ ```
5947
+
5948
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/1.27.2/src/commands/package/version/delete.ts)_
5949
+
5950
+ ## `sf package version displayancestry`
5951
+
5952
+ Display the ancestry tree for a 2GP managed package version.
5953
+
5954
+ ```
5955
+ USAGE
5956
+ $ sf package version displayancestry -v <value> -p <value> [--api-version <value>] [--dot-code] [--verbose]
5957
+
5958
+ FLAGS
5959
+ -p, --package=<value> (required) ID or alias of the package (starts with 0Ho) or package version (starts with
5960
+ 04t) to display ancestry for.
5961
+ -v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
5962
+ --api-version=<value> Override the api version used for api requests made by this command
5963
+ --dot-code Display the ancestry tree in DOT code.
5964
+ --verbose Display both the package version ID (starts with 04t) and the version number
5965
+ (major.minor.patch.build) in the ancestry tree.
5966
+
5967
+ ALIASES
5968
+ $ sf force package version displayancestry
5969
+
5970
+ EXAMPLES
5971
+ Display the ancestry tree for a package version with the specified alias, using your default Dev Hub org:
5972
+
5973
+ $ sf package version displayancestry --package package_version_alias
5974
+
5975
+ Similar to previous example, but display the output in DOT code:
5976
+
5977
+ $ sf package version displayancestry --package package_version_alias --dot-code
5978
+
5979
+ Display the ancestry tree for a package with the specified ID, using the Dev Hub org with username
5980
+ devhub@example.com:
5981
+
5982
+ $ sf package version displayancestry --package OHo... --target-dev-hub devhub@example.com
5983
+
5984
+ Display the ancestry tree of a package version with the specified ID, using your default Dev Hub org:
5985
+
5986
+ $ sf package version displayancestry --package 04t...
5987
+
5988
+ FLAG DESCRIPTIONS
5989
+ -p, --package=<value>
5990
+
5991
+ ID or alias of the package (starts with 0Ho) or package version (starts with 04t) to display ancestry for.
5992
+
5993
+ If you specify a package ID (starts with 0Ho) or alias, the ancestor tree for every package version associated with
5994
+ the package ID is displayed. If you specify a package version (starts with 04t) or alias, the ancestry tree of the
5995
+ specified package version is displayed.
5996
+
5997
+ --dot-code Display the ancestry tree in DOT code.
5998
+
5999
+ You can use the DOT code output in graph visualization software to create tree visualizations.
6000
+ ```
6001
+
6002
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/1.27.2/src/commands/package/version/displayancestry.ts)_
6003
+
6004
+ ## `sf package version list`
6005
+
6006
+ List all package versions in the Dev Hub org.
6007
+
6008
+ ```
6009
+ USAGE
6010
+ $ sf package version list -v <value> [--api-version <value>] [-c <value>] [--concise] [--show-conversions-only] [-m
6011
+ <value>] [-p <value>] [-r] [-o <value>] [--verbose]
6012
+
6013
+ FLAGS
6014
+ -c, --created-last-days=<value> Number of days since the request was created, starting at 00:00:00 of first day to
6015
+ now. Use 0 for today.
6016
+ -m, --modified-last-days=<value> Number of days since the items were modified, starting at 00:00:00 of first day to
6017
+ now. Use 0 for today.
6018
+ -o, --order-by=<value> Package version fields used to order the list.
6019
+ -p, --packages=<value> Comma-delimited list of packages (aliases or 0Ho IDs) to list.
6020
+ -r, --released Display released versions only (IsReleased=true).
6021
+ -v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
6022
+ --api-version=<value> Override the api version used for api requests made by this command
6023
+ --concise Display limited package version details.
6024
+ --show-conversions-only Filter the list output to display only converted package version.
6025
+ --verbose Display extended package version details.
6026
+
6027
+ DESCRIPTION
6028
+ List all package versions in the Dev Hub org.
6029
+
6030
+ Description
6031
+
6032
+ ALIASES
6033
+ $ sf force package version list
6034
+
6035
+ EXAMPLES
6036
+ List package versions in your default Dev Hub org that were created in the last 3 days; show only the released
6037
+ versions and order the list using the PatchVersion field. Display extended details about each package version:
6038
+
6039
+ $ sf package version list --verbose --created-last-days 3 --released --order-by PatchVersion
6040
+
6041
+ List the released package versions for the two specified packages that were modified today; use the Dev Hub org with
6042
+ username devhub@example.com:
6043
+
6044
+ $ sf package version list --packages 0Ho000000000000,0Ho000000000001 --released --modified-last-days 0 \
6045
+ --target-dev-hub devhub@example.com
6046
+
6047
+ List all released package versions in your default Dev Hub org:
6048
+
6049
+ $ sf package version list --released
6050
+
6051
+ List package versions that were modified today in your default Dev Hub org; show limited details about each one:
6052
+
6053
+ $ sf package version list --concise --modified-last-days 0
6054
+
6055
+ List released package versions that were created in the last 3 days in your default Dev Hub org; show limited
6056
+ details:
6057
+
6058
+ $ sf package version list --concise --created-last-days 3 --released
6059
+
6060
+ List released package versions that were modified today for the two packages with specified aliases in your default
6061
+ Dev Hub org:
6062
+
6063
+ $ sf package version list --packages exp-mgr,exp-mgr-util --released --modified-last-days 0
6064
+ ```
6065
+
6066
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/1.27.2/src/commands/package/version/list.ts)_
6067
+
6068
+ ## `sf package version promote`
6069
+
6070
+ Promote a package version to released.
6071
+
6072
+ ```
6073
+ USAGE
6074
+ $ sf package version promote -v <value> -p <value> [--api-version <value>] [-n]
6075
+
6076
+ FLAGS
6077
+ -n, --no-prompt Don't prompt to confirm setting the package version as released.
6078
+ -p, --package=<value> (required) ID (starts with 04t) or alias of the package version to promote.
6079
+ -v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
6080
+ --api-version=<value> Override the api version used for api requests made by this command
6081
+
6082
+ DESCRIPTION
6083
+ Promote a package version to released.
6084
+
6085
+ Supply the ID or alias of the package version you want to promote. Promotes the package version to released status.
6086
+
6087
+ ALIASES
6088
+ $ sf force package version promote
6089
+
6090
+ EXAMPLES
6091
+ Promote the package version with the specified ID to released; uses your default Dev Hub org:
6092
+
6093
+ $ sf package version promote --package 04t...
6094
+
6095
+ Promote the package version with the specified alias to released; uses the Dev Hub org with username
6096
+ devhub@example.com:
6097
+
6098
+ $ sf package version promote --package awesome_package_alias --target-dev-hub devhub@example.com
6099
+
6100
+ Promote the package version with an alias that has spaces to released:
6101
+
6102
+ $ sf package version promote --package "Awesome Package Alias"
6103
+ ```
6104
+
6105
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/1.27.2/src/commands/package/version/promote.ts)_
6106
+
6107
+ ## `sf package version report`
6108
+
6109
+ Retrieve details about a package version in the Dev Hub org.
6110
+
6111
+ ```
6112
+ USAGE
6113
+ $ sf package version report -v <value> -p <value> [--api-version <value>] [--verbose]
6114
+
6115
+ FLAGS
6116
+ -p, --package=<value> (required) ID (starts with 04t) or alias of the package to retrieve details for.
6117
+ -v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
6118
+ --api-version=<value> Override the api version used for api requests made by this command
6119
+ --verbose Display extended package version details.
6120
+
6121
+ DESCRIPTION
6122
+ Retrieve details about a package version in the Dev Hub org.
6123
+
6124
+ To update package version values, run "sf package version update".
6125
+
6126
+ ALIASES
6127
+ $ sf force package version report
6128
+
6129
+ EXAMPLES
6130
+ Retrieve details about the package version with the specified ID from your default Dev Hub org:
6131
+
6132
+ $ sf package version report --package 04t...
6133
+
6134
+ Retrieve details about the package version with the specified alias (that contains spaces) from the Dev Hub org with
6135
+ username devhub@example.com:
6136
+
6137
+ $ sf package version report --package "Your Package Alias" --target-dev-hub devhub@example.com
6138
+ ```
6139
+
6140
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/1.27.2/src/commands/package/version/report.ts)_
6141
+
6142
+ ## `sf package version update`
6143
+
6144
+ Update a package version.
6145
+
6146
+ ```
6147
+ USAGE
6148
+ $ sf package version update -v <value> -p <value> [--api-version <value>] [-a <value>] [-e <value>] [-b <value>] [-t
6149
+ <value>] [-k <value>]
6150
+
6151
+ FLAGS
6152
+ -a, --version-name=<value> New package version name.
6153
+ -b, --branch=<value> New package version branch.
6154
+ -e, --version-description=<value> New package version description.
6155
+ -k, --installation-key=<value> New installation key for key-protected package (default: null)
6156
+ -p, --package=<value> (required) ID (starts with 04t) or alias of the package to update a version of.
6157
+ -t, --tag=<value> New package version tag.
6158
+ -v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
6159
+ --api-version=<value> Override the api version used for api requests made by this command
6160
+
6161
+ DESCRIPTION
6162
+ Update a package version.
6163
+
6164
+ Specify a new value for each option you want to update.
6165
+
6166
+ To display details about a package version, run "sf package version display".
6167
+
6168
+ ALIASES
6169
+ $ sf force package version update
6170
+
6171
+ EXAMPLES
6172
+ Update the package version that has the specified alias (that contains spaces) with a new installation key
6173
+ "password123"; uses your default Dev Hub org:
6174
+
6175
+ $ sf package version update --package "Your Package Alias" --installation-key password123
6176
+
6177
+ Update the package version that has the specified ID with a new branch and tag; use the Dev Hub org with username
6178
+ devhub@example.com:
6179
+
6180
+ $ sf package version update --package 04t... --branch main --tag 'Release 1.0.7' --target-dev-hub \
6181
+ devhub@example.com
6182
+
6183
+ Update the package version that has the specified ID with a new description:
6184
+
6185
+ $ sf package version update --package 04t... --version-description "New Package Version Description"
6186
+ ```
6187
+
6188
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/1.27.2/src/commands/package/version/update.ts)_
5003
6189
 
5004
6190
  ## `sf plugins`
5005
6191