@salesforce/plugin-packaging 1.22.3-dev.0 → 1.23.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/README.md +2070 -537
  2. package/lib/commands/package/update.js +0 -1
  3. package/lib/commands/package/update.js.map +1 -1
  4. package/oclif.manifest.json +1 -2
  5. package/package.json +9 -8
package/README.md CHANGED
@@ -2,14 +2,14 @@
2
2
 
3
3
  [![NPM](https://img.shields.io/npm/v/@salesforce/plugin-packaging.svg?label=@salesforce/plugin-packaging)](https://www.npmjs.com/package/@salesforce/plugin-packaging) [![Downloads/week](https://img.shields.io/npm/dw/@salesforce/plugin-packaging.svg)](https://npmjs.org/package/@salesforce/plugin-packaging) [![License](https://img.shields.io/badge/License-BSD%203--Clause-brightgreen.svg)](https://raw.githubusercontent.com/salesforcecli/plugin-packaging/main/LICENSE.txt)
4
4
 
5
- ### This plugin provides the sfdx cli commands that support the Salesforce Packaging Platform.
5
+ ### This plugin provides the sf cli commands that support the Salesforce Packaging Platform.
6
6
 
7
7
  ## Install
8
8
 
9
9
  This plugin is bundled with the Salesforce CLI, so you typically don't need to install it. However, if you want to install a specific version of the plugin you can run:
10
10
 
11
11
  ```bash
12
- sfdx plugins:install @salesforce/plugin-packaging@x.y.z
12
+ sf plugins:install @salesforce/plugin-packaging@x.y.z
13
13
  ```
14
14
 
15
15
  _NOTE: If you install a specific version of a bundled plugin you will not get an updated packaging plugin when the CLI updates. You must either update to the packaging plugin version you want manually, or uninstall the version of the plugin you have to go back to the CLI bundled version._
@@ -30,777 +30,2310 @@ See [DEVELOPING.md](DEVELOPING.md)
30
30
 
31
31
  <!-- commands -->
32
32
 
33
- - [`sfdx force:package1:beta:version:create -i <id> -n <string> [-d <string>] [-v <string>] [-m] [-r <url>] [-p <url>] [-k <string>] [-w <minutes>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcepackage1betaversioncreate--i-id--n-string--d-string--v-string--m--r-url--p-url--k-string--w-minutes--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
34
- - [`sfdx force:package1:beta:version:create:get -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcepackage1betaversioncreateget--i-id--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
35
- - [`sfdx force:package1:beta:version:display -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcepackage1betaversiondisplay--i-id--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
36
- - [`sfdx force:package1:beta:version:list [-i <id>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcepackage1betaversionlist--i-id--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
37
- - [`sfdx force:package:beta:create -n <string> -t Managed|Unlocked -r <directory> [-d <string>] [-e] [--orgdependent] [-o <string>] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcepackagebetacreate--n-string--t-managedunlocked--r-directory--d-string--e---orgdependent--o-string--v-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
38
- - [`sfdx force:package:beta:delete -p <string> [-n] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcepackagebetadelete--p-string--n--v-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
39
- - [`sfdx force:package:beta:install -p <string> [-w <minutes>] [-k <string>] [-b <minutes>] [-r] [-a all|package] [-s AllUsers|AdminsOnly] [-t DeprecateOnly|Mixed|Delete] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcepackagebetainstall--p-string--w-minutes--k-string--b-minutes--r--a-allpackage--s-allusersadminsonly--t-deprecateonlymixeddelete--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
40
- - [`sfdx force:package:beta:install:report -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcepackagebetainstallreport--i-id--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
41
- - [`sfdx force:package:beta:installed:list [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcepackagebetainstalledlist--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
42
- - [`sfdx force:package:beta:list [-v <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcepackagebetalist--v-string---apiversion-string---verbose---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
43
- - [`sfdx force:package:beta:uninstall [-w <minutes>] [-p <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcepackagebetauninstall--w-minutes--p-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
44
- - [`sfdx force:package:beta:uninstall:report -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcepackagebetauninstallreport--i-id--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
45
- - [`sfdx force:package:beta:update -p <string> [-n <string>] [-d <string>] [-o <string>] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcepackagebetaupdate--p-string--n-string--d-string--o-string--v-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
46
- - [`sfdx force:package:beta:version:create [-p <string>] [-d <directory>] [-f <filepath>] [-b <string>] [-t <string>] [-k <string>] [-x] [-w <minutes>] [-a <string>] [-n <string>] [-e <string>] [-c] [--releasenotesurl <url>] [--postinstallurl <url>] [--postinstallscript <string>] [--uninstallscript <string>] [--skipvalidation] [--skipancestorcheck] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcepackagebetaversioncreate--p-string--d-directory--f-filepath--b-string--t-string--k-string--x--w-minutes--a-string--n-string--e-string--c---releasenotesurl-url---postinstallurl-url---postinstallscript-string---uninstallscript-string---skipvalidation---skipancestorcheck--v-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
47
- - [`sfdx force:package:beta:version:create:list [-c <number>] [-s Queued|InProgress|Success|Error] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcepackagebetaversioncreatelist--c-number--s-queuedinprogresssuccesserror--v-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
48
- - [`sfdx force:package:beta:version:create:report -i <id> [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcepackagebetaversioncreatereport--i-id--v-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
49
- - [`sfdx force:package:beta:version:delete -p <string> [-n] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcepackagebetaversiondelete--p-string--n--v-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
50
- - [`sfdx force:package:beta:version:displayancestry -p <string> [--dotcode] [-v <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcepackagebetaversiondisplayancestry--p-string---dotcode--v-string---apiversion-string---verbose---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
51
- - [`sfdx force:package:beta:version:list [-c <number>] [-m <number>] [-p <array>] [-r] [-o <array>] [-v <string>] [--apiversion <string>] [--concise] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcepackagebetaversionlist--c-number--m-number--p-array--r--o-array--v-string---apiversion-string---concise---verbose---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
52
- - [`sfdx force:package:beta:version:promote -p <string> [-n] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcepackagebetaversionpromote--p-string--n--v-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
53
- - [`sfdx force:package:beta:version:report -p <string> [-v <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcepackagebetaversionreport--p-string--v-string---apiversion-string---verbose---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
54
- - [`sfdx force:package:beta:version:update -p <string> [-a <string>] [-e <string>] [-b <string>] [-t <string>] [-k <string>] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcepackagebetaversionupdate--p-string--a-string--e-string--b-string--t-string--k-string--v-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
55
- - [`sfdx version`](#sfdx-version)
56
-
57
- ## `sfdx force:package1:beta:version:create -i <id> -n <string> [-d <string>] [-v <string>] [-m] [-r <url>] [-p <url>] [-k <string>] [-w <minutes>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
58
-
59
- create a first-generation package version in the release org
60
-
61
- ```
62
- USAGE
63
- $ sfdx force:package1:beta:version:create -i <id> -n <string> [-d <string>] [-v <string>] [-m] [-r <url>] [-p <url>] [-k <string>] [-w
64
- <minutes>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
65
- trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
66
-
67
- FLAGS
68
- -d, --description=<value> package version description
69
- -i, --packageid=<value> (required) ID of the metadata
70
- package (starts with 033) of which
71
- you’re creating a new version
72
- -k, --installationkey=<value> installation key for key-protected
73
- package (default: null)
74
- -m, --managedreleased create a managed package version
75
- -n, --name=<value> (required) package version name
76
- -p, --postinstallurl=<value> post install URL
77
- -r, --releasenotesurl=<value> release notes URL
78
- -u, --targetusername=<value> username or alias for the target
79
- org; overrides default target org
80
- -v, --version=<value> package version in major.minor
81
- format, for example, 3.2
82
- -w, --wait=<value> minutes to wait for the package
83
- version to be created (default: 2
84
- minutes)
85
- --apiversion=<value> override the api version used for
86
- api requests made by this command
87
- --json format output as json
88
- --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
89
- this command invocation
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
+ - [`sf package1:version:create`](#sf-package1versioncreate)
56
+ - [`sf package1:version:create:get`](#sf-package1versioncreateget)
57
+ - [`sf package1:version:display`](#sf-package1versiondisplay)
58
+ - [`sf package1:version:list`](#sf-package1versionlist)
59
+ - [`sf package:create`](#sf-packagecreate)
60
+ - [`sf package:delete`](#sf-packagedelete)
61
+ - [`sf package:install`](#sf-packageinstall)
62
+ - [`sf package:install:report`](#sf-packageinstallreport)
63
+ - [`sf package:installed:list`](#sf-packageinstalledlist)
64
+ - [`sf package:list`](#sf-packagelist)
65
+ - [`sf package:uninstall`](#sf-packageuninstall)
66
+ - [`sf package:uninstall:report`](#sf-packageuninstallreport)
67
+ - [`sf package:update`](#sf-packageupdate)
68
+ - [`sf package:version:create`](#sf-packageversioncreate)
69
+ - [`sf package:version:create:list`](#sf-packageversioncreatelist)
70
+ - [`sf package:version:create:report`](#sf-packageversioncreatereport)
71
+ - [`sf package:version:delete`](#sf-packageversiondelete)
72
+ - [`sf package:version:displayancestry`](#sf-packageversiondisplayancestry)
73
+ - [`sf package:version:list`](#sf-packageversionlist)
74
+ - [`sf package:version:promote`](#sf-packageversionpromote)
75
+ - [`sf package:version:report`](#sf-packageversionreport)
76
+ - [`sf package:version:update`](#sf-packageversionupdate)
77
+
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
+ ## `sf package1:version:create`
1189
+
1190
+ Create a first-generation package version in the release org.
1191
+
1192
+ ```
1193
+ USAGE
1194
+ $ sf package1:version:create -o <value> -i <value> -n <value> [--json] [--api-version <value>] [-d <value>] [-v <value>]
1195
+ [-m] [-r <value>] [-p <value>] [-k <value>] [-w <value>]
1196
+
1197
+ FLAGS
1198
+ -d, --description=<value> Package version description.
1199
+ -i, --package-id=<value> (required) ID of the metadata package (starts with 033) of which you’re creating a
1200
+ new version.
1201
+ -k, --installation-key=<value> Installation key for key-protected package (default: null).
1202
+ -m, --managed-released Create a managed package version.
1203
+ -n, --name=<value> (required) Package version name.
1204
+ -o, --target-org=<value> (required) Username or alias of the target org.
1205
+ -p, --post-install-url=<value> Post install URL.
1206
+ -r, --release-notes-url=<value> Release notes URL.
1207
+ -v, --version=<value> Package version in major.minor format, for example, 3.2.
1208
+ -w, --wait=<value> Minutes to wait for the package version to be created (default: 2 minutes).
1209
+ --api-version=<value> Override the api version used for api requests made by this command
1210
+
1211
+ GLOBAL FLAGS
1212
+ --json Format output as json.
90
1213
 
91
1214
  DESCRIPTION
92
- create a first-generation package version in the release org
1215
+ Create a first-generation package version in the release org.
1216
+
1217
+ The package version is based on the contents of the specified metadata package. Omit --managed-released if you want to
1218
+ create an unmanaged package version.
1219
+
1220
+ ALIASES
1221
+ $ sf force:package1:version:create
1222
+
1223
+ EXAMPLES
1224
+ Create a first-generation package version from the package with the specified ID and name the package version
1225
+ "example"; use your default org:
1226
+
1227
+ $ sf package1:version:create --package-id 033... --name example
1228
+
1229
+ Same as previous example, but provide a description and wait for 30 minutes for the package version to be created;
1230
+ use the specified org:
1231
+
1232
+ $ sf package1:version:create --package-id 033... --name example --description "example description" --wait 30 \
1233
+ --target-org myorg@example.com
1234
+
1235
+ FLAG DESCRIPTIONS
1236
+ -m, --managed-released Create a managed package version.
1237
+
1238
+ To create a beta version, don’t include this parameter.
1239
+
1240
+ -p, --post-install-url=<value> Post install URL.
1241
+
1242
+ The contents of the post-installation instructions URL are displayed in the UI after installation of the package
1243
+ version.
1244
+
1245
+ -r, --release-notes-url=<value> Release notes URL.
1246
+
1247
+ This link is displayed in the package installation UI to provide release notes for this package version to
1248
+ subscribers.
1249
+ ```
1250
+
1251
+ _See code: [src/commands/package1/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.21.4/src/commands/package1/version/create.ts)_
1252
+
1253
+ ## `sf package1:version:create:get`
1254
+
1255
+ Retrieve the status of a package version creation request.
1256
+
1257
+ ```
1258
+ USAGE
1259
+ $ sf package1:version:create:get -o <value> -i <value> [--json] [--api-version <value>]
1260
+
1261
+ FLAGS
1262
+ -i, --request-id=<value> (required) ID of the PackageUploadRequest (starts with 0HD).
1263
+ -o, --target-org=<value> (required) Username or alias of the target org.
1264
+ --api-version=<value> Override the api version used for api requests made by this command
1265
+
1266
+ GLOBAL FLAGS
1267
+ --json Format output as json.
1268
+
1269
+ ALIASES
1270
+ $ sf force:package1:version:create:get
1271
+
1272
+ EXAMPLES
1273
+ Get the status of the creation request for the package version with the specified ID in your default org:
1274
+
1275
+ $ sf package1:version:create:get --request-id 0HD...
1276
+
1277
+ Same as previous example, but use the specified org:
1278
+
1279
+ $ sf package1:version:create:get --request-id 0HD... --target-org myorg@example.com
1280
+ ```
1281
+
1282
+ _See code: [src/commands/package1/version/create/get.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.21.4/src/commands/package1/version/create/get.ts)_
1283
+
1284
+ ## `sf package1:version:display`
1285
+
1286
+ Display details about a first-generation package version.
1287
+
1288
+ ```
1289
+ USAGE
1290
+ $ sf package1:version:display -o <value> -i <value> [--json] [--api-version <value>]
1291
+
1292
+ FLAGS
1293
+ -i, --package-version-id=<value> (required) ID (starts with 04t) of the metadata package version whose details you
1294
+ want to display.
1295
+ -o, --target-org=<value> (required) Username or alias of the target org.
1296
+ --api-version=<value> Override the api version used for api requests made by this command
1297
+
1298
+ GLOBAL FLAGS
1299
+ --json Format output as json.
1300
+
1301
+ ALIASES
1302
+ $ sf force:package1:version:display
1303
+
1304
+ EXAMPLES
1305
+ Display details about the first-generation package version with the specified ID in your default org:
1306
+
1307
+ $ sf package1:version:display --package-version-id 04t...
1308
+
1309
+ Same as previous example, but use the specified org:
1310
+
1311
+ $ sf package1:version:display --package-version-id 04t... --target-org myorg@example.com
1312
+ ```
1313
+
1314
+ _See code: [src/commands/package1/version/display.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.21.4/src/commands/package1/version/display.ts)_
1315
+
1316
+ ## `sf package1:version:list`
1317
+
1318
+ List package versions for the specified first-generation package or for the org.
1319
+
1320
+ ```
1321
+ USAGE
1322
+ $ sf package1:version:list -o <value> [--json] [--api-version <value>] [-i <value>]
1323
+
1324
+ FLAGS
1325
+ -i, --package-id=<value> Metadata package ID (starts with 033) whose package versions you want to list.
1326
+ -o, --target-org=<value> (required) Username or alias of the target org.
1327
+ --api-version=<value> Override the api version used for api requests made by this command
1328
+
1329
+ GLOBAL FLAGS
1330
+ --json Format output as json.
1331
+
1332
+ ALIASES
1333
+ $ sf force:package1:version:list
1334
+
1335
+ EXAMPLES
1336
+ List all first-generation package versions in your default org:
1337
+
1338
+ $ sf package1:version:list
1339
+
1340
+ List package versions for the specified first-generation package in the specifief org:
1341
+
1342
+ $ sf package1:version:list --package-id 033... --target-org myorg@example.com
1343
+
1344
+ FLAG DESCRIPTIONS
1345
+ -i, --package-id=<value> Metadata package ID (starts with 033) whose package versions you want to list.
1346
+
1347
+ If not specified, shows all versions for all packages (managed and unmanaged) in the org.
93
1348
  ```
94
1349
 
95
- _See code: [src/commands/force/package1/beta/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/v0.0.1/src/commands/force/package1/beta/version/create.ts)_
1350
+ _See code: [src/commands/package1/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.21.4/src/commands/package1/version/list.ts)_
96
1351
 
97
- ## `sfdx force:package1:beta:version:create:get -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
1352
+ ## `sf package:create`
98
1353
 
99
- retrieve the status of a package version creation request
1354
+ Create a package.
100
1355
 
101
1356
  ```
102
1357
  USAGE
103
- $ sfdx force:package1:beta:version:create:get -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel
104
- trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
1358
+ $ sf package:create -v <value> -n <value> -t Managed|Unlocked -r <value> [--json] [--api-version <value>] [-d
1359
+ <value>] [-e] [--org-dependent] [-o <value>]
105
1360
 
106
1361
  FLAGS
107
- -i, --requestid=<value> (required) PackageUploadRequest ID
108
- -u, --targetusername=<value> username or alias for the target
109
- org; overrides default target org
110
- --apiversion=<value> override the api version used for
111
- api requests made by this command
112
- --json format output as json
113
- --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
114
- this command invocation
1362
+ -d, --description=<value> Description of the package.
1363
+ -e, --no-namespace Create the package with no namespace; available only for unlocked packages.
1364
+ -n, --name=<value> (required) Name of the package to create.
1365
+ -o, --error-notification-username=<value> Active Dev Hub user designated to receive email notifications for package
1366
+ errors.
1367
+ -r, --path=<value> (required) Path to directory that contains the contents of the package.
1368
+ -t, --package-type=<option> (required) Type of package.
1369
+ <options: Managed|Unlocked>
1370
+ -v, --target-dev-hub=<value> (required) [default: william.ruemmele@brave-bear-5fmf7j.com] Username or
1371
+ alias of the Dev Hub org.
1372
+ --api-version=<value> Override the api version used for api requests made by this command
1373
+ --org-dependent Depends on unpackaged metadata in the installation org; applies to unlocked
1374
+ packages only.
1375
+
1376
+ GLOBAL FLAGS
1377
+ --json Format output as json.
115
1378
 
116
1379
  DESCRIPTION
117
- retrieve the status of a package version creation request
1380
+ Create a package.
1381
+
1382
+ First, use this command to create a package. Then create a package version.
1383
+
1384
+ If you don’t have a namespace defined in your sfdx-project.json file, use --no-namespace.
1385
+
1386
+ Your --name value must be unique within your namespace.
1387
+
1388
+ Run 'sf package list to list all packages in the Dev Hub org.
1389
+
1390
+ ALIASES
1391
+ $ sf force:package:create
118
1392
 
119
1393
  EXAMPLES
120
- Examples:
1394
+ Create an unlocked package from the files in the "force-app" directory; uses your default Dev Hub org:
121
1395
 
122
- $ sfdx force:package1:version:create:get -i 0HD...
1396
+ $ sf package:create --name MyUnlockedPackage --package-type Unlocked --path force-app
123
1397
 
124
- $ sfdx force:package1:version:create:get -i 0HD... -u devhub@example.com
125
- ```
1398
+ Create a managed packaged from the "force-app" directory files, give the package a description, and use the
1399
+ specified Dev Hub org:
126
1400
 
127
- _See code: [src/commands/force/package1/beta/version/create/get.ts](https://github.com/salesforcecli/plugin-packaging/blob/v0.0.1/src/commands/force/package1/beta/version/create/get.ts)_
1401
+ $ sf package:create --name MyManagedPackage --description "Your Package Descripton" --package-type Managed \
1402
+ --path force-app --target-dev-hub devhub@example.com
128
1403
 
129
- ## `sfdx force:package1:beta:version:display -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
1404
+ FLAG DESCRIPTIONS
1405
+ -e, --no-namespace Create the package with no namespace; available only for unlocked packages.
130
1406
 
131
- display details about a first-generation package version
1407
+ This flag is useful when you’re migrating an existing org to packages. But use a namespaced package for new
1408
+ metadata.
132
1409
 
133
- ```
134
- USAGE
135
- $ sfdx force:package1:beta:version:display -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel
136
- trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
1410
+ -o, --error-notification-username=<value>
137
1411
 
138
- FLAGS
139
- -i, --packageversionid=<value> (required) metadata package version
140
- ID (starts with 04t)
141
- -u, --targetusername=<value> username or alias for the target
142
- org; overrides default target org
143
- --apiversion=<value> override the api version used for
144
- api requests made by this command
145
- --json format output as json
146
- --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
147
- this command invocation
1412
+ Active Dev Hub user designated to receive email notifications for package errors.
148
1413
 
149
- DESCRIPTION
150
- display details about a first-generation package version
1414
+ Email notifications include information about unhandled Apex exceptions, and install, upgrade, or uninstall failures
1415
+ associated with your package.
1416
+
1417
+ -t, --package-type=Managed|Unlocked Type of package.
1418
+
1419
+ The options for package type are Managed and Unlocked (Managed=DeveloperManagedSubscriberManaged,
1420
+ Unlocked=DeveloperControlledSubscriberEditable). These options determine upgrade and editability rules.
1421
+
1422
+ --org-dependent Depends on unpackaged metadata in the installation org; applies to unlocked packages only.
1423
+
1424
+ Use Source Tracking in Sandboxes to develop your org-dependent unlocked package. For more information, see "Create
1425
+ Org-Dependent Unlocked Packages" in the Salesforce DX Developer Guide.
151
1426
  ```
152
1427
 
153
- _See code: [src/commands/force/package1/beta/version/display.ts](https://github.com/salesforcecli/plugin-packaging/blob/v0.0.1/src/commands/force/package1/beta/version/display.ts)_
1428
+ _See code: [src/commands/package/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.21.4/src/commands/package/create.ts)_
154
1429
 
155
- ## `sfdx force:package1:beta:version:list [-i <id>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
1430
+ ## `sf package:delete`
156
1431
 
157
- list package versions for the specified first-generation package or for the org
1432
+ Delete a package.
158
1433
 
159
1434
  ```
160
1435
  USAGE
161
- $ sfdx force:package1:beta:version:list [-i <id>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
162
- trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
1436
+ $ sf package:delete -v <value> -p <value> [--json] [--api-version <value>] [-n]
163
1437
 
164
1438
  FLAGS
165
- -i, --packageid=<value> metadata package ID (starts with
166
- 033)
167
- -u, --targetusername=<value> username or alias for the target
168
- org; overrides default target org
169
- --apiversion=<value> override the api version used for
170
- api requests made by this command
171
- --json format output as json
172
- --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
173
- this command invocation
1439
+ -n, --no-prompt Don’t prompt before deleting the package.
1440
+ -p, --package=<value> (required) ID (starts with 0Ho) or alias of the package to delete.
1441
+ -v, --target-dev-hub=<value> (required) [default: william.ruemmele@brave-bear-5fmf7j.com] Username or alias of the
1442
+ Dev Hub org.
1443
+ --api-version=<value> Override the api version used for api requests made by this command
1444
+
1445
+ GLOBAL FLAGS
1446
+ --json Format output as json.
174
1447
 
175
1448
  DESCRIPTION
176
- list package versions for the specified first-generation package or for the org
177
- ```
1449
+ Delete a package.
178
1450
 
179
- _See code: [src/commands/force/package1/beta/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/v0.0.1/src/commands/force/package1/beta/version/list.ts)_
1451
+ Specify the ID or alias of the package you want to delete.
180
1452
 
181
- ## `sfdx force:package:beta:create -n <string> -t Managed|Unlocked -r <directory> [-d <string>] [-e] [--orgdependent] [-o <string>] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
1453
+ Delete unlocked and second-generation managed packages. Before you delete a package, first delete all associated
1454
+ package versions.
182
1455
 
183
- create a package
1456
+ ALIASES
1457
+ $ sf force:package:delete
184
1458
 
185
- ```
186
- USAGE
187
- $ sfdx force:package:beta:create -n <string> -t Managed|Unlocked -r <directory> [-d <string>] [-e] [--orgdependent] [-o
188
- <string>] [-v <string>] [--apiversion <string>] [--json] [--loglevel
189
- trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
1459
+ EXAMPLES
1460
+ Delete a package using its alias from your default Dev Hub org:
190
1461
 
191
- FLAGS
192
- -d, --description=<value> package description
193
- -e, --nonamespace creates the package with no
194
- namespace; available only for
195
- unlocked packages.
196
- -n, --name=<value> (required) package name
197
- -o, --errornotificationusername=<value> active Dev Hub user designated to
198
- receive email notifications for
199
- package errors
200
- -r, --path=<value> (required) path to directory that
201
- contains the contents of the package
202
- -t, --packagetype=(Managed|Unlocked) (required) package type
203
- -v, --targetdevhubusername=<value> username or alias for the dev hub
204
- org; overrides default dev hub org
205
- --apiversion=<value> override the api version used for
206
- api requests made by this command
207
- --json format output as json
208
- --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
209
- this command invocation
210
- --orgdependent depends on unpackaged metadata in
211
- the installation org. Applies to
212
- unlocked packages only.
1462
+ $ sf package:delete --package "Your Package Alias"
213
1463
 
214
- DESCRIPTION
215
- create a package
1464
+ Delete a package using its ID from the specified Dev Hub org:
1465
+
1466
+ $ sf package:delete --package 0Ho... --target-dev-hub devhub@example.com
216
1467
  ```
217
1468
 
218
- _See code: [src/commands/force/package/beta/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/v0.0.1/src/commands/force/package/beta/create.ts)_
1469
+ _See code: [src/commands/package/delete.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.21.4/src/commands/package/delete.ts)_
219
1470
 
220
- ## `sfdx force:package:beta:delete -p <string> [-n] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
1471
+ ## `sf package:install`
221
1472
 
222
- delete a package
1473
+ Install a version of a package in the target org.
223
1474
 
224
1475
  ```
225
1476
  USAGE
226
- $ sfdx force:package:beta:delete -p <string> [-n] [-v <string>] [--apiversion <string>] [--json] [--loglevel
227
- trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
1477
+ $ sf package:install -o <value> -p <value> [--json] [--api-version <value>] [-w <value>] [-k <value>] [-b <value>]
1478
+ [-r] [-a all|package] [-s AllUsers|AdminsOnly] [-t DeprecateOnly|Mixed|Delete]
228
1479
 
229
1480
  FLAGS
230
- -n, --noprompt don’t prompt before deleting the
231
- package
232
- -p, --package=<value> (required) ID (starts with 0Ho) or
233
- alias of the package to delete
234
- -v, --targetdevhubusername=<value> username or alias for the dev hub
235
- org; overrides default dev hub org
236
- --apiversion=<value> override the api version used for
237
- api requests made by this command
238
- --json format output as json
239
- --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
240
- this command invocation
1481
+ -a, --apex-compile=<option> [default: all] Compile all Apex in the org and package, or only Apex in the package;
1482
+ unlocked packages only.
1483
+ <options: all|package>
1484
+ -b, --publish-wait=<value> [default: 0 minutes] Maximum number of minutes to wait for the Subscriber Package
1485
+ Version ID to become available in the target org before canceling the install request.
1486
+ -k, --installation-key=<value> Installation key for key-protected package (default: null).
1487
+ -o, --target-org=<value> (required) Username or alias of the target org.
1488
+ -p, --package=<value> (required) ID (starts with 04t) or alias of the package version to install.
1489
+ -r, --no-prompt Don't prompt for confirmation.
1490
+ -s, --security-type=<option> [default: AdminsOnly] Security access type for the installed package. (deprecation
1491
+ notice: The default --security-type value will change from AllUsers to AdminsOnly in
1492
+ v47.0 or later.)
1493
+ <options: AllUsers|AdminsOnly>
1494
+ -t, --upgrade-type=<option> [default: Mixed] Upgrade type for the package installation; available only for
1495
+ unlocked packages.
1496
+ <options: DeprecateOnly|Mixed|Delete>
1497
+ -w, --wait=<value> [default: 0 minutes] Number of minutes to wait for installation status.
1498
+ --api-version=<value> Override the api version used for api requests made by this command
1499
+
1500
+ GLOBAL FLAGS
1501
+ --json Format output as json.
241
1502
 
242
1503
  DESCRIPTION
243
- delete a package
244
- ```
1504
+ Install a version of a package in the target org.
245
1505
 
246
- _See code: [src/commands/force/package/beta/delete.ts](https://github.com/salesforcecli/plugin-packaging/blob/v0.0.1/src/commands/force/package/beta/delete.ts)_
1506
+ To install a package, specify a specific version of the package using the 04t package ID. The package and the version
1507
+ you specified installs in your default target org unless you supply the username for a different target org.
247
1508
 
248
- ## `sfdx force:package:beta:install -p <string> [-w <minutes>] [-k <string>] [-b <minutes>] [-r] [-a all|package] [-s AllUsers|AdminsOnly] [-t DeprecateOnly|Mixed|Delete] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
1509
+ For package upgrades, to specify options for component deprecation or deletion of removed components, include an
1510
+ --upgrade-type value. To delete components that can be safely deleted and deprecate the others, specify --upgrade-type
1511
+ Mixed (the default). To deprecate all removed components, specify --upgrade-type DeprecateOnly. To delete all removed
1512
+ components, except for custom objects and custom fields, that don't have dependencies, specify --upgrade-type Delete.
1513
+ (Note: This option can result in the loss of data that is associated with the deleted components.) The default is
1514
+ Mixed.
249
1515
 
250
- install a package in the target org
1516
+ ALIASES
1517
+ $ sf force:package:install
251
1518
 
252
- ```
253
- USAGE
254
- $ sfdx force:package:beta:install -p <string> [-w <minutes>] [-k <string>] [-b <minutes>] [-r] [-a all|package] [-s
255
- AllUsers|AdminsOnly] [-t DeprecateOnly|Mixed|Delete] [-u <string>] [--apiversion <string>] [--json] [--loglevel
256
- trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
1519
+ EXAMPLES
1520
+ Install a package version with the specified ID in the org with username "me@example.com":
257
1521
 
258
- FLAGS
259
- -a, --apexcompile=(all|package)
260
- [default: all] compile all Apex in the org and package, or only Apex in the package; unlocked packages only
1522
+ $ sf package:install --package 04t... --target-org me@example.com
261
1523
 
262
- -b, --publishwait=<value>
263
- number of minutes to wait for subscriber package version ID to become available in the target org
1524
+ Install a package version with the specified alias into your default org:
264
1525
 
265
- -k, --installationkey=<value>
266
- installation key for key-protected package (default: null)
1526
+ $ sf package:install --package awesome_package_alias
267
1527
 
268
- -p, --package=<value>
269
- (required) ID (starts with 04t) or alias of the package version to install
1528
+ Install a package version with an alias that includes spaces into your default org:
1529
+
1530
+ $ sf package:install --package "Awesome Package Alias"
270
1531
 
271
- -r, --noprompt
272
- do not prompt for confirmation
1532
+ Install an unlocked package version with the specified ID and deprecate all removed components:
273
1533
 
274
- -s, --securitytype=(AllUsers|AdminsOnly)
275
- [default: AdminsOnly] security access type for the installed package (deprecation notice: The default --securitytype
276
- value will change from AllUsers to AdminsOnly in v47.0 or later.)
1534
+ $ sf package:install --package 04t... --upgrade-type DeprecateOnly
277
1535
 
278
- -t, --upgradetype=(DeprecateOnly|Mixed|Delete)
279
- [default: Mixed] the upgrade type for the package installation; available only for unlocked packages
1536
+ FLAG DESCRIPTIONS
1537
+ -a, --apex-compile=all|package
280
1538
 
281
- -u, --targetusername=<value>
282
- username or alias for the target org; overrides default target org
1539
+ Compile all Apex in the org and package, or only Apex in the package; unlocked packages only.
283
1540
 
284
- -w, --wait=<value>
285
- number of minutes to wait for installation status
1541
+ Applies to unlocked packages only. Specifies whether to compile all Apex in the org and package, or only the Apex in
1542
+ the package.
286
1543
 
287
- --apiversion=<value>
288
- override the api version used for api requests made by this command
1544
+ For package installs into production orgs, or any org that has Apex Compile on Deploy enabled, the platform compiles
1545
+ all Apex in the org after the package install or upgrade operation completes.
289
1546
 
290
- --json
291
- format output as json
1547
+ This approach assures that package installs and upgrades don’t impact the performance of an org, and is done even if
1548
+ --apex-compile package is specified.
292
1549
 
293
- --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)
294
- [default: warn] logging level for this command invocation
1550
+ -r, --no-prompt Don't prompt for confirmation.
295
1551
 
296
- DESCRIPTION
297
- install a package in the target org
1552
+ Allows the following without an explicit confirmation response: 1) Remote Site Settings and Content Security Policy
1553
+ websites to send or receive data, and 2) --upgrade-type Delete to proceed.
1554
+
1555
+ -t, --upgrade-type=DeprecateOnly|Mixed|Delete
1556
+
1557
+ Upgrade type for the package installation; available only for unlocked packages.
1558
+
1559
+ For package upgrades, specifies whether to mark all removed components as deprecated (DeprecateOnly), to delete
1560
+ removed components that can be safely deleted and deprecate the others (Mixed), or to delete all removed components,
1561
+ except for custom objects and custom fields, that don't have dependencies (Delete). The default is Mixed. Can
1562
+ specify DeprecateOnly or Delete only for unlocked package upgrades.
298
1563
  ```
299
1564
 
300
- _See code: [src/commands/force/package/beta/install.ts](https://github.com/salesforcecli/plugin-packaging/blob/v0.0.1/src/commands/force/package/beta/install.ts)_
1565
+ _See code: [src/commands/package/install.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.21.4/src/commands/package/install.ts)_
301
1566
 
302
- ## `sfdx force:package:beta:install:report -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
1567
+ ## `sf package:install:report`
303
1568
 
304
- retrieve the status of a package installation request
1569
+ Retrieve the status of a package installation request.
305
1570
 
306
1571
  ```
307
1572
  USAGE
308
- $ sfdx force:package:beta:install:report -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel
309
- trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
1573
+ $ sf package:install:report -o <value> -i <value> [--json] [--api-version <value>]
310
1574
 
311
1575
  FLAGS
312
- -i, --requestid=<value> (required) ID of the package install
313
- request you want to check
314
- -u, --targetusername=<value> username or alias for the target
315
- org; overrides default target org
316
- --apiversion=<value> override the api version used for
317
- api requests made by this command
318
- --json format output as json
319
- --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
320
- this command invocation
1576
+ -i, --request-id=<value> (required) ID of the package install request you want to check; starts with 0Hf.
1577
+ -o, --target-org=<value> (required) Username or alias of the target org.
1578
+ --api-version=<value> Override the api version used for api requests made by this command
321
1579
 
322
- DESCRIPTION
323
- retrieve the status of a package installation request
1580
+ GLOBAL FLAGS
1581
+ --json Format output as json.
1582
+
1583
+ ALIASES
1584
+ $ sf force:package:install:report
1585
+
1586
+ EXAMPLES
1587
+ Retrieve the status of a package installation request with the specified ID on your default org:
1588
+
1589
+ $ sf package:install:report --request-id 0Hf...
1590
+
1591
+ Similar to previous example, except use the org with username me@example.com:
1592
+
1593
+ $ sf package:install:report --request-id 0Hf... --target-org me@example.com
324
1594
  ```
325
1595
 
326
- _See code: [src/commands/force/package/beta/install/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/v0.0.1/src/commands/force/package/beta/install/report.ts)_
1596
+ _See code: [src/commands/package/install/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.21.4/src/commands/package/install/report.ts)_
327
1597
 
328
- ## `sfdx force:package:beta:installed:list [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
1598
+ ## `sf package:installed:list`
329
1599
 
330
- list the org’s installed packages
1600
+ List the org’s installed packages.
331
1601
 
332
1602
  ```
333
1603
  USAGE
334
- $ sfdx force:package:beta:installed:list [-u <string>] [--apiversion <string>] [--json] [--loglevel
335
- trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
1604
+ $ sf package:installed:list -o <value> [--json] [--api-version <value>]
336
1605
 
337
1606
  FLAGS
338
- -u, --targetusername=<value> username or alias for the target
339
- org; overrides default target org
340
- --apiversion=<value> override the api version used for
341
- api requests made by this command
342
- --json format output as json
343
- --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
344
- this command invocation
1607
+ -o, --target-org=<value> (required) Username or alias of the target org.
1608
+ --api-version=<value> Override the api version used for api requests made by this command
345
1609
 
346
- DESCRIPTION
347
- list the org’s installed packages
1610
+ GLOBAL FLAGS
1611
+ --json Format output as json.
1612
+
1613
+ ALIASES
1614
+ $ sf force:package:installed:list
348
1615
 
349
1616
  EXAMPLES
350
- $ sfdx force:package:installed:list
1617
+ List the installed packages in your default org:
351
1618
 
352
- $ sfdx force:package:installed:list -u me@example.com
1619
+ $ sf package:installed:list
1620
+
1621
+ List the installed packages in the org with username me@example.com:
1622
+
1623
+ $ sf package:installed:list --target-org me@example.com
353
1624
  ```
354
1625
 
355
- _See code: [src/commands/force/package/beta/installed/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/v0.0.1/src/commands/force/package/beta/installed/list.ts)_
1626
+ _See code: [src/commands/package/installed/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.21.4/src/commands/package/installed/list.ts)_
356
1627
 
357
- ## `sfdx force:package:beta:list [-v <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
1628
+ ## `sf package:list`
358
1629
 
359
- list all packages in the Dev Hub org
1630
+ List all packages in the Dev Hub org.
360
1631
 
361
1632
  ```
362
1633
  USAGE
363
- $ sfdx force:package:beta:list [-v <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel
364
- trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
1634
+ $ sf package:list -v <value> [--json] [--api-version <value>] [--verbose]
365
1635
 
366
1636
  FLAGS
367
- -v, --targetdevhubusername=<value> username or alias for the dev hub
368
- org; overrides default dev hub org
369
- --apiversion=<value> override the api version used for
370
- api requests made by this command
371
- --json format output as json
372
- --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
373
- this command invocation
374
- --verbose display extended package detail
1637
+ -v, --target-dev-hub=<value> (required) [default: william.ruemmele@brave-bear-5fmf7j.com] Username or alias of the
1638
+ Dev Hub org.
1639
+ --api-version=<value> Override the api version used for api requests made by this command
1640
+ --verbose Display extended package detail.
1641
+
1642
+ GLOBAL FLAGS
1643
+ --json Format output as json.
375
1644
 
376
1645
  DESCRIPTION
377
- list all packages in the Dev Hub org
1646
+ List all packages in the Dev Hub org.
1647
+
1648
+ Description
1649
+
1650
+ ALIASES
1651
+ $ sf force:package:list
1652
+
1653
+ EXAMPLES
1654
+ List all packages in the specified Dev Hub org:
1655
+
1656
+ $ sf package:list --target-dev-hub devhub@example.com
1657
+
1658
+ List all packages details in the specified Dev Hub org, and show extended details about each package:
1659
+
1660
+ $ sf package:list --target-dev-hub devhub@example.com --verbose
378
1661
  ```
379
1662
 
380
- _See code: [src/commands/force/package/beta/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/v0.0.1/src/commands/force/package/beta/list.ts)_
1663
+ _See code: [src/commands/package/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.21.4/src/commands/package/list.ts)_
381
1664
 
382
- ## `sfdx force:package:beta:uninstall [-w <minutes>] [-p <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
1665
+ ## `sf package:uninstall`
383
1666
 
384
- uninstall a second-generation package from the target org
1667
+ Uninstall a second-generation package from the target org.
385
1668
 
386
1669
  ```
387
1670
  USAGE
388
- $ sfdx force:package:beta:uninstall [-w <minutes>] [-p <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
389
- trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
1671
+ $ sf package:uninstall -o <value> -p <value> [--json] [--api-version <value>] [-w <value>]
390
1672
 
391
1673
  FLAGS
392
- -p, --package=<value> ID (starts with 04t) or alias of the
393
- package version to uninstall
394
- -u, --targetusername=<value> username or alias for the target
395
- org; overrides default target org
396
- -w, --wait=<value> [default: 0 minutes] number of
397
- minutes to wait for uninstall status
398
- --apiversion=<value> override the api version used for
399
- api requests made by this command
400
- --json format output as json
401
- --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
402
- this command invocation
1674
+ -o, --target-org=<value> (required) Username or alias of the target org.
1675
+ -p, --package=<value> (required) ID (starts with 04t) or alias of the package version to uninstall.
1676
+ -w, --wait=<value> [default: 0 minutes] Number of minutes to wait for uninstall status.
1677
+ --api-version=<value> Override the api version used for api requests made by this command
1678
+
1679
+ GLOBAL FLAGS
1680
+ --json Format output as json.
403
1681
 
404
1682
  DESCRIPTION
405
- uninstall a second-generation package from the target org
1683
+ Uninstall a second-generation package from the target org.
1684
+
1685
+ Specify the package ID for a second-generation package.
1686
+
1687
+ To list the org’s installed packages, run "sf package installed list".
1688
+
1689
+ To uninstall a first-generation package, from Setup, enter Installed Packages in the Quick Find box, then select
1690
+ Installed Packages.
1691
+
1692
+ ALIASES
1693
+ $ sf force:package:uninstall
1694
+
1695
+ EXAMPLES
1696
+ Uninstall a package with specified ID from an org with username me@example.com:
1697
+
1698
+ $ sf package:uninstall --package 04t... --target-org me@example.com
1699
+
1700
+ Uninstall a package with the specified alias from your default org:
1701
+
1702
+ $ sf package:uninstall --package undesirable_package_alias
1703
+
1704
+ Uninstall a package with an alias that contains spaces from your default org:
1705
+
1706
+ $ sf package:uninstall --package "Undesirable Package Alias"
406
1707
  ```
407
1708
 
408
- _See code: [src/commands/force/package/beta/uninstall.ts](https://github.com/salesforcecli/plugin-packaging/blob/v0.0.1/src/commands/force/package/beta/uninstall.ts)_
1709
+ _See code: [src/commands/package/uninstall.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.21.4/src/commands/package/uninstall.ts)_
409
1710
 
410
- ## `sfdx force:package:beta:uninstall:report -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
1711
+ ## `sf package:uninstall:report`
411
1712
 
412
- retrieve status of package uninstall request
1713
+ Retrieve the status of a package uninstall request.
413
1714
 
414
1715
  ```
415
1716
  USAGE
416
- $ sfdx force:package:beta:uninstall:report -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel
417
- trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
1717
+ $ sf package:uninstall:report -o <value> -i <value> [--json] [--api-version <value>]
418
1718
 
419
1719
  FLAGS
420
- -i, --requestid=<value> (required) ID of the package
421
- uninstall request you want to check
422
- -u, --targetusername=<value> username or alias for the target
423
- org; overrides default target org
424
- --apiversion=<value> override the api version used for
425
- api requests made by this command
426
- --json format output as json
427
- --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
428
- this command invocation
1720
+ -i, --request-id=<value> (required) ID of the package uninstall request you want to check; starts with 06y.
1721
+ -o, --target-org=<value> (required) Username or alias of the target org.
1722
+ --api-version=<value> Override the api version used for api requests made by this command
429
1723
 
430
- DESCRIPTION
431
- retrieve status of package uninstall request
1724
+ GLOBAL FLAGS
1725
+ --json Format output as json.
1726
+
1727
+ ALIASES
1728
+ $ sf force:package:uninstall:report
1729
+
1730
+ EXAMPLES
1731
+ Retrieve the status of a package uninstall in your default org using the specified request ID:
1732
+
1733
+ $ sf package:uninstall:report --request-id 06y...
1734
+
1735
+ Similar to previous example, but use the org with username me@example.com:
1736
+
1737
+ $ sf package:uninstall:report --request-id 06y... --target-org me@example.com
432
1738
  ```
433
1739
 
434
- _See code: [src/commands/force/package/beta/uninstall/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/v0.0.1/src/commands/force/package/beta/uninstall/report.ts)_
1740
+ _See code: [src/commands/package/uninstall/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.21.4/src/commands/package/uninstall/report.ts)_
435
1741
 
436
- ## `sfdx force:package:beta:update -p <string> [-n <string>] [-d <string>] [-o <string>] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
1742
+ ## `sf package:update`
437
1743
 
438
- update package details
1744
+ Update package details.
439
1745
 
440
1746
  ```
441
1747
  USAGE
442
- $ sfdx force:package:beta:update -p <string> [-n <string>] [-d <string>] [-o <string>] [-v <string>] [--apiversion <string>]
443
- [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
1748
+ $ sf package:update -v <value> -p <value> [--json] [--api-version <value>] [-n <value>] [-d <value>] [-o <value>]
444
1749
 
445
1750
  FLAGS
446
- -d, --description=<value> new package description
447
- -n, --name=<value> new package name
448
- -o, --errornotificationusername=<value> active Dev Hub user designated to
449
- receive email notifications for
450
- package errors
451
- -p, --package=<value> (required) ID (starts with 0Ho) or
452
- alias of the package to update
453
- -v, --targetdevhubusername=<value> username or alias for the dev hub
454
- org; overrides default dev hub org
455
- --apiversion=<value> override the api version used for
456
- api requests made by this command
457
- --json format output as json
458
- --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
459
- this command invocation
1751
+ -d, --description=<value> New description of the package.
1752
+ -n, --name=<value> New name of the package.
1753
+ -o, --error-notification-username=<value> Active Dev Hub user designated to receive email notifications for package
1754
+ errors.
1755
+ -p, --package=<value> (required) ID (starts with 0Ho) or alias of the package to update.
1756
+ -v, --target-dev-hub=<value> (required) [default: william.ruemmele@brave-bear-5fmf7j.com] Username or
1757
+ alias of the Dev Hub org.
1758
+ --api-version=<value> Override the api version used for api requests made by this command
460
1759
 
461
- DESCRIPTION
462
- update package details
463
- ```
464
-
465
- _See code: [src/commands/force/package/beta/update.ts](https://github.com/salesforcecli/plugin-packaging/blob/v0.0.1/src/commands/force/package/beta/update.ts)_
466
-
467
- ## `sfdx force:package:beta:version:create [-p <string>] [-d <directory>] [-f <filepath>] [-b <string>] [-t <string>] [-k <string>] [-x] [-w <minutes>] [-a <string>] [-n <string>] [-e <string>] [-c] [--releasenotesurl <url>] [--postinstallurl <url>] [--postinstallscript <string>] [--uninstallscript <string>] [--skipvalidation] [--skipancestorcheck] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
468
-
469
- create a package version
470
-
471
- ```
472
- USAGE
473
- $ sfdx force:package:beta:version:create [-p <string>] [-d <directory>] [-f <filepath>] [-b <string>] [-t <string>] [-k <string>]
474
- [-x] [-w <minutes>] [-a <string>] [-n <string>] [-e <string>] [-c] [--releasenotesurl <url>] [--postinstallurl
475
- <url>] [--postinstallscript <string>] [--uninstallscript <string>] [--skipvalidation] [--skipancestorcheck] [-v
476
- <string>] [--apiversion <string>] [--json] [--loglevel
477
- trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
478
-
479
- FLAGS
480
- -a, --versionname=<value> the name of the package version to
481
- be created
482
- -b, --branch=<value> the package version’s branch
483
- -c, --codecoverage calculate the code coverage by
484
- running the packaged Apex tests
485
- -d, --path=<value> path to directory that contains the
486
- contents of the package
487
- -e, --versiondescription=<value> the description of the package
488
- version to be created
489
- -f, --definitionfile=<value> path to a definition file similar to
490
- scratch org definition file that
491
- contains the list of features and
492
- org preferences that the metadata of
493
- the package version depends on
494
- -k, --installationkey=<value> installation key for key-protected
495
- package (either --installationkey or
496
- --installationkeybypass is required)
497
- -n, --versionnumber=<value> the version number of the package
498
- version to be created
499
- -p, --package=<value> ID (starts with 0Ho) or alias of the
500
- package to create a version of
501
- -t, --tag=<value> the package version’s tag
502
- -v, --targetdevhubusername=<value> username or alias for the dev hub
503
- org; overrides default dev hub org
504
- -w, --wait=<value> [default: 0 minutes] minutes to wait
505
- for the package version to be
506
- created
507
- -x, --installationkeybypass bypass the installation key
508
- requirement (either
509
- --installationkey or
510
- --installationkeybypass is required)
511
- --apiversion=<value> override the api version used for
512
- api requests made by this command
513
- --json format output as json
514
- --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
515
- this command invocation
516
- --postinstallscript=<value> post-install script name; managed
517
- packages only
518
- --postinstallurl=<value> post-install URL
519
- --releasenotesurl=<value> release notes URL
520
- --skipancestorcheck Overrides ancestry requirements.
521
- --skipvalidation skip validation during package
522
- version creation; you can’t promote
523
- unvalidated package versions
524
- --uninstallscript=<value> uninstall script name; managed
525
- packages only
1760
+ GLOBAL FLAGS
1761
+ --json Format output as json.
526
1762
 
527
1763
  DESCRIPTION
528
- create a package version
1764
+ Update package details.
1765
+
1766
+ Specify a new value for each option you want to update.
1767
+
1768
+ Run "sf package list" to list all packages in the Dev Hub org.
1769
+
1770
+ ALIASES
1771
+ $ sf force:package:update
1772
+
1773
+ EXAMPLES
1774
+ Update the name of the package with the specified alias; uses your default Dev Hub org:
1775
+
1776
+ $ sf package:update --package "Your Package Alias" --name "New Package Name"
1777
+
1778
+ Update the description of the package with the specified ID; uses the specified Dev Hub org:
1779
+
1780
+ $ sf package:update --package 0Ho... --description "New Package Description" --target-dev-hub devhub@example.com
1781
+
1782
+ FLAG DESCRIPTIONS
1783
+ -o, --error-notification-username=<value>
1784
+
1785
+ Active Dev Hub user designated to receive email notifications for package errors.
1786
+
1787
+ Email notifications include information about unhandled Apex exceptions, and install, upgrade, or uninstall failures
1788
+ associated with your package.
529
1789
  ```
530
1790
 
531
- _See code: [src/commands/force/package/beta/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/v0.0.1/src/commands/force/package/beta/version/create.ts)_
1791
+ _See code: [src/commands/package/update.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.21.4/src/commands/package/update.ts)_
532
1792
 
533
- ## `sfdx force:package:beta:version:create:list [-c <number>] [-s Queued|InProgress|Success|Error] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
1793
+ ## `sf package:version:create`
534
1794
 
535
- list package version creation requests
1795
+ Create a package version in the Dev Hub org.
536
1796
 
537
1797
  ```
538
1798
  USAGE
539
- $ sfdx force:package:beta:version:create:list [-c <number>] [-s Queued|InProgress|Success|Error] [-v <string>] [--apiversion <string>]
540
- [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
1799
+ $ sf package:version:create -v <value> [--json] [--api-version <value>] [-b <value>] [-c | --skip-validation] [-f <value>]
1800
+ [-k <value>] [-x] [-p <value>] [-d <value>] [--post-install-script <value>] [--post-install-url <value>]
1801
+ [--releasenotes-url <value>] [--skip-ancestor-check] [-t <value>] [--uninstall-script <value>] [-e <value>] [-a
1802
+ <value>] [-n <value>] [-w <value>] [--language <value>] [--verbose]
541
1803
 
542
1804
  FLAGS
543
- -c, --createdlastdays=<value> created in the last specified number
544
- of days (starting at 00:00:00 of
545
- first day to now; 0 for today)
546
- -s, --status=(Queued|InProgress|Success|Error) filter the list by version creation
547
- request status
548
- -v, --targetdevhubusername=<value> username or alias for the dev hub
549
- org; overrides default dev hub org
550
- --apiversion=<value> override the api version used for
551
- api requests made by this command
552
- --json format output as json
553
- --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
554
- this command invocation
1805
+ -a, --version-name=<value> Name of the package version to be created; overrides the sfdx-project.json value.
1806
+ -b, --branch=<value> Name of the branch in your source control system that the package version is based
1807
+ on.
1808
+ -c, --code-coverage Calculate and store the code coverage percentage by running the packaged Apex tests
1809
+ included in this package version.
1810
+ -d, --path=<value> Path to the directory that contains the contents of the package.
1811
+ -e, --version-description=<value> Description of the package version to be created; overrides the sfdx-project.json
1812
+ value.
1813
+ -f, --definition-file=<value> Path to a definition file similar to scratch org definition file that contains the
1814
+ list of features and org preferences that the metadata of the package version
1815
+ depends on.
1816
+ -k, --installation-key=<value> Installation key for key-protected package. (either --installation-key or
1817
+ --installation-key-bypass is required)
1818
+ -n, --version-number=<value> Version number of the package version to be created; overrides the
1819
+ sfdx-project.json value.
1820
+ -p, --package=<value> ID (starts with 0Ho) or alias of the package to create a version of.
1821
+ -t, --tag=<value> Package version’s tag.
1822
+ -v, --target-dev-hub=<value> (required) [default: william.ruemmele@brave-bear-5fmf7j.com] Username or alias of
1823
+ the Dev Hub org.
1824
+ -w, --wait=<value> [default: 0 minutes] Number of minutes to wait for the package version to be
1825
+ created.
1826
+ -x, --installation-key-bypass Bypass the installation key requirement. (either --installation-key or
1827
+ --installation-key-bypass is required)
1828
+ --api-version=<value> Override the api version used for api requests made by this command
1829
+ --language=<value> Language for the package.
1830
+ --post-install-script=<value> Name of the post-install script; applies to managed packages only.
1831
+ --post-install-url=<value> Post-install instructions URL.
1832
+ --releasenotes-url=<value> Release notes URL.
1833
+ --skip-ancestor-check Overrides ancestry requirements, which allows you to specify a package ancestor
1834
+ that isn’t the highest released package version.
1835
+ --skip-validation Skip validation during package version creation; you can’t promote unvalidated
1836
+ package versions.
1837
+ --uninstall-script=<value> Uninstall script name; applies to managed packages only.
1838
+ --verbose Display verbose command output.
1839
+
1840
+ GLOBAL FLAGS
1841
+ --json Format output as json.
555
1842
 
556
1843
  DESCRIPTION
557
- list package version creation requests
1844
+ Create a package version in the Dev Hub org.
1845
+
1846
+ The package version is based on the package contents in the specified directory.
1847
+
1848
+ To retrieve details about a package version create request, including status and package version ID (04t), run "sf
1849
+ package version create report -i 08c...".
1850
+
1851
+ We recommend that you specify the --installation-key parameter to protect the contents of your package and to prevent
1852
+ unauthorized installation of your package.
1853
+
1854
+ To list package version creation requests in the org, run "sf package version create list".
1855
+ To promote a package version to released, you must use the --code-coverage parameter. The package must also meet the
1856
+ code coverage requirements. This requirement applies to both managed and unlocked packages.
1857
+
1858
+ We don’t calculate code coverage for org-dependent unlocked packages, or for package versions that specify
1859
+ --skip-validation.
1860
+
1861
+ ALIASES
1862
+ $ sf force:package:version:create
1863
+
1864
+ EXAMPLES
1865
+ Create a package version from the contents of the "common" directory and give it an installation key of
1866
+ "password123"; uses your default Dev Hub org:
1867
+
1868
+ $ sf package:version:create --path common --installation-key password123
1869
+
1870
+ Create a package version from a package with the specified alias; uses the Dev Hub org with username
1871
+ devhub@example.com:
1872
+
1873
+ $ sf package:version:create --package "Your Package Alias" --installation-key password123 --target-dev-hub \
1874
+ devhub@example.com
1875
+
1876
+ Create a package version from a package with the specified ID:
1877
+
1878
+ $ sf package:version:create --package 0Ho... --installation-key password123
1879
+
1880
+ Create a package version and skip the validation step:
1881
+
1882
+ $ sf package:version:create --path common --installation-key password123 --skip-validation
1883
+
1884
+ FLAG DESCRIPTIONS
1885
+ -c, --code-coverage
1886
+
1887
+ Calculate and store the code coverage percentage by running the packaged Apex tests included in this package
1888
+ version.
1889
+
1890
+ Before you can promote and release a managed or unlocked package version, the Apex code must meet a minimum 75% code
1891
+ coverage requirement. We don’t calculate code coverage for org-dependent unlocked packages or for package versions
1892
+ that specify --skip-validation.
1893
+
1894
+ -x, --installation-key-bypass
1895
+
1896
+ Bypass the installation key requirement. (either --installation-key or --installation-key-bypass is required)
1897
+
1898
+ If you bypass this requirement, anyone can install your package.
1899
+
1900
+ --language=<value> Language for the package.
1901
+
1902
+ Specify the language using a language code listed under "Supported Languages" in Salesforce Help. If no language is
1903
+ specified, the language defaults to the language of the Dev Hub user who created the package.
1904
+
1905
+ --post-install-script=<value> Name of the post-install script; applies to managed packages only.
1906
+
1907
+ The post-install script is an Apex class within this package that is run in the installing org after installations
1908
+ or upgrades of this package version.
1909
+
1910
+ --post-install-url=<value> Post-install instructions URL.
1911
+
1912
+ The contents of the post-installation instructions URL are displayed in the UI after installation of the package
1913
+ version.
1914
+
1915
+ --releasenotes-url=<value> Release notes URL.
1916
+
1917
+ This link is displayed in the package installation UI to provide release notes for this package version to
1918
+ subscribers.
1919
+
1920
+ --skip-validation Skip validation during package version creation; you can’t promote unvalidated package versions.
1921
+
1922
+ Skips validation of dependencies, package ancestors, and metadata during package version creation. Skipping
1923
+ validation reduces the time it takes to create a new package version, but you can promote only validated package
1924
+ versions. Skipping validation can suppress important errors that can surface at a later stage. You can specify skip
1925
+ validation or code coverage, but not both. Code coverage is calculated during validation.
1926
+
1927
+ --uninstall-script=<value> Uninstall script name; applies to managed packages only.
1928
+
1929
+ The uninstall script is an Apex class within this package that is run in the installing org after uninstallations of
1930
+ this package.
1931
+
1932
+ --verbose Display verbose command output.
1933
+
1934
+ Display verbose command output. When polling for the status of the creation, this will output status and timeout
1935
+ data on a separate line for each poll request, which is useful in CI systems where timeouts can occur with long
1936
+ periods of no output from commands.
558
1937
  ```
559
1938
 
560
- _See code: [src/commands/force/package/beta/version/create/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/v0.0.1/src/commands/force/package/beta/version/create/list.ts)_
1939
+ _See code: [src/commands/package/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.21.4/src/commands/package/version/create.ts)_
561
1940
 
562
- ## `sfdx force:package:beta:version:create:report -i <id> [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
1941
+ ## `sf package:version:create:list`
563
1942
 
564
- retrieve details about a package version creation request
1943
+ List package version creation requests.
565
1944
 
566
1945
  ```
567
1946
  USAGE
568
- $ sfdx force:package:beta:version:create:report -i <id> [-v <string>] [--apiversion <string>] [--json] [--loglevel
569
- trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
1947
+ $ sf package:version:create:list -v <value> [--json] [--api-version <value>] [-c <value>] [-s Queued|InProgress|Success|Error]
1948
+ [--verbose]
570
1949
 
571
1950
  FLAGS
572
- -i, --packagecreaterequestid=<value> (required) package version creation
573
- request ID (starts with 08c)
574
- -v, --targetdevhubusername=<value> username or alias for the dev hub
575
- org; overrides default dev hub org
576
- --apiversion=<value> override the api version used for
577
- api requests made by this command
578
- --json format output as json
579
- --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
580
- this command invocation
1951
+ -c, --created-last-days=<value> Number of days since the request was created, starting at 00:00:00 of first day to
1952
+ now. Use 0 for today.
1953
+ -s, --status=<option> Status of the version creation request, used to filter the list.
1954
+ <options: Queued|InProgress|Success|Error>
1955
+ -v, --target-dev-hub=<value> (required) [default: william.ruemmele@brave-bear-5fmf7j.com] Username or alias of the
1956
+ Dev Hub org.
1957
+ --api-version=<value> Override the api version used for api requests made by this command
1958
+ --verbose Displays additional information at a slight performance cost, such as the version
1959
+ name and number for each package version create request.
1960
+
1961
+ GLOBAL FLAGS
1962
+ --json Format output as json.
581
1963
 
582
1964
  DESCRIPTION
583
- retrieve details about a package version creation request
1965
+ List package version creation requests.
1966
+
1967
+ Shows the details of each request to create a package version in the Dev Hub org.
1968
+
1969
+ All filter parameters are applied using the AND logical operator (not OR).
1970
+
1971
+ To get information about a specific request, run "sf package version create report" and supply the request ID.
1972
+
1973
+ ALIASES
1974
+ $ sf force:package:version:create:list
1975
+
1976
+ EXAMPLES
1977
+ List all package version creation requests in your default Dev Hub org:
1978
+
1979
+ $ sf package:version:create:list
1980
+
1981
+ List package version creation requests from the last 3 days in the Dev Hub org with username devhub@example.com:
1982
+
1983
+ $ sf package:version:create:list --created-last-days 3 --target-dev-hub
1984
+
1985
+ List package version creation requests with status Error:
1986
+
1987
+ $ sf package:version:create:list --status Error
1988
+
1989
+ List package version creation requests with status InProgress:
1990
+
1991
+ $ sf package:version:create:list --status InProgress
1992
+
1993
+ List package version creation requests with status Success that were created today:
1994
+
1995
+ $ sf package:version:create:list --created-last-days 0 --status Success
584
1996
  ```
585
1997
 
586
- _See code: [src/commands/force/package/beta/version/create/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/v0.0.1/src/commands/force/package/beta/version/create/report.ts)_
1998
+ _See code: [src/commands/package/version/create/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.21.4/src/commands/package/version/create/list.ts)_
587
1999
 
588
- ## `sfdx force:package:beta:version:delete -p <string> [-n] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
2000
+ ## `sf package:version:create:report`
589
2001
 
590
- delete a package version
2002
+ Retrieve details about a package version creation request.
591
2003
 
592
2004
  ```
593
2005
  USAGE
594
- $ sfdx force:package:beta:version:delete -p <string> [-n] [-v <string>] [--apiversion <string>] [--json] [--loglevel
595
- trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
2006
+ $ sf package:version:create:report -v <value> -i <value> [--json] [--api-version <value>]
596
2007
 
597
2008
  FLAGS
598
- -n, --noprompt don’t prompt before deleting the
599
- package version
600
- -p, --package=<value> (required) ID (starts with 04t) or
601
- alias of the package to update a
602
- version of
603
- -v, --targetdevhubusername=<value> username or alias for the dev hub
604
- org; overrides default dev hub org
605
- --apiversion=<value> override the api version used for
606
- api requests made by this command
607
- --json format output as json
608
- --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
609
- this command invocation
2009
+ -i, --package-create-request-id=<value> (required) ID (starts with 08c) of the package version creation request you
2010
+ want to display.
2011
+ -v, --target-dev-hub=<value> (required) [default: william.ruemmele@brave-bear-5fmf7j.com] Username or
2012
+ alias of the Dev Hub org.
2013
+ --api-version=<value> Override the api version used for api requests made by this command
2014
+
2015
+ GLOBAL FLAGS
2016
+ --json Format output as json.
610
2017
 
611
2018
  DESCRIPTION
612
- delete a package version
2019
+ Retrieve details about a package version creation request.
2020
+
2021
+ Specify the request ID for which you want to view details. If applicable, the command displays errors related to the
2022
+ request.
2023
+
2024
+ To show all requests in the org, run "sf package version create list".
2025
+
2026
+ ALIASES
2027
+ $ sf force:package:version:create:report
2028
+
2029
+ EXAMPLES
2030
+ Retrieve details about the package version creation request with the specified ID; uses your default Dev Hub org:
2031
+
2032
+ $ sf package:version:create:report --package-create-request-id 08c...
2033
+
2034
+ Retrieve details about the specified package version creation request in the Dev Hub org with username
2035
+ devhub@example.com:
2036
+
2037
+ $ sf package:version:create:report --package-create-request-id 08c... --target-dev-hub devhub@example.com
613
2038
  ```
614
2039
 
615
- _See code: [src/commands/force/package/beta/version/delete.ts](https://github.com/salesforcecli/plugin-packaging/blob/v0.0.1/src/commands/force/package/beta/version/delete.ts)_
2040
+ _See code: [src/commands/package/version/create/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.21.4/src/commands/package/version/create/report.ts)_
616
2041
 
617
- ## `sfdx force:package:beta:version:displayancestry -p <string> [--dotcode] [-v <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
2042
+ ## `sf package:version:delete`
618
2043
 
619
- display the ancestry tree for a 2GP managed package version
2044
+ Delete a package version.
620
2045
 
621
2046
  ```
622
2047
  USAGE
623
- $ sfdx force:package:beta:version:displayancestry -p <string> [--dotcode] [-v <string>] [--apiversion <string>] [--verbose] [--json]
624
- [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
2048
+ $ sf package:version:delete -v <value> -p <value> [--json] [--api-version <value>] [-n]
625
2049
 
626
2050
  FLAGS
627
- -p, --package=<value> (required) ID or alias of the
628
- package (starts with 0Ho) or package
629
- version (starts with 04t) to display
630
- ancestry for
631
- -v, --targetdevhubusername=<value> username or alias for the dev hub
632
- org; overrides default dev hub org
633
- --apiversion=<value> override the api version used for
634
- api requests made by this command
635
- --dotcode display the ancestry tree in DOT
636
- code
637
- --json format output as json
638
- --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
639
- this command invocation
640
- --verbose display both the package version ID
641
- (starts with 04t) and the version
642
- number (major.minor.patch.build) in
643
- the ancestry tree
2051
+ -n, --no-prompt Don’t prompt before deleting the package version.
2052
+ -p, --package=<value> (required) ID (starts with 04t) or alias of the package version to delete.
2053
+ -v, --target-dev-hub=<value> (required) [default: william.ruemmele@brave-bear-5fmf7j.com] Username or alias of the
2054
+ Dev Hub org.
2055
+ --api-version=<value> Override the api version used for api requests made by this command
2056
+
2057
+ GLOBAL FLAGS
2058
+ --json Format output as json.
644
2059
 
645
2060
  DESCRIPTION
646
- display the ancestry tree for a 2GP managed package version
2061
+ Delete a package version.
2062
+
2063
+ Specify the ID or alias of the package version you want to delete.
2064
+
2065
+ ALIASES
2066
+ $ sf force:package:version:delete
2067
+
2068
+ EXAMPLES
2069
+ Delete a package version with the specified alias using your default Dev Hub org:
2070
+
2071
+ $ sf package:version:delete --package "Your Package Alias"
2072
+
2073
+ Delete a package version with the specified ID using the Dev Hub org with username "devhub@example.com":
2074
+
2075
+ $ sf package:version:delete --package 04t... --target-org devhub@example.com
647
2076
  ```
648
2077
 
649
- _See code: [src/commands/force/package/beta/version/displayancestry.ts](https://github.com/salesforcecli/plugin-packaging/blob/v0.0.1/src/commands/force/package/beta/version/displayancestry.ts)_
2078
+ _See code: [src/commands/package/version/delete.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.21.4/src/commands/package/version/delete.ts)_
650
2079
 
651
- ## `sfdx force:package:beta:version:list [-c <number>] [-m <number>] [-p <array>] [-r] [-o <array>] [-v <string>] [--apiversion <string>] [--concise] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
2080
+ ## `sf package:version:displayancestry`
652
2081
 
653
- list all package versions in the Dev Hub org
2082
+ Display the ancestry tree for a 2GP managed package version.
654
2083
 
655
2084
  ```
656
2085
  USAGE
657
- $ sfdx force:package:beta:version:list [-c <number>] [-m <number>] [-p <array>] [-r] [-o <array>] [-v <string>] [--apiversion
658
- <string>] [--concise] [--verbose] [--json] [--loglevel
659
- trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
2086
+ $ sf package:version:displayancestry -v <value> -p <value> [--json] [--api-version <value>] [--dot-code] [--verbose]
660
2087
 
661
2088
  FLAGS
662
- -c, --createdlastdays=<value> created in the last specified number
663
- of days (starting at 00:00:00 of
664
- first day to now; 0 for today)
665
- -m, --modifiedlastdays=<value> list items modified in the specified
666
- last number of days (starting at
667
- 00:00:00 of first day to now; 0 for
668
- today)
669
- -o, --orderby=<value> order by the specified package
670
- version fields
671
- -p, --packages=<value> filter results on specified
672
- comma-delimited packages (aliases or
673
- 0Ho IDs)
674
- -r, --released display released versions only
675
- -v, --targetdevhubusername=<value> username or alias for the dev hub
676
- org; overrides default dev hub org
677
- --apiversion=<value> override the api version used for
678
- api requests made by this command
679
- --concise display limited package version
680
- details
681
- --json format output as json
682
- --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
683
- this command invocation
684
- --verbose display extended package version
685
- details
2089
+ -p, --package=<value> (required) ID or alias of the package (starts with 0Ho) or package version (starts with
2090
+ 04t) to display ancestry for.
2091
+ -v, --target-dev-hub=<value> (required) [default: william.ruemmele@brave-bear-5fmf7j.com] Username or alias of the
2092
+ Dev Hub org.
2093
+ --api-version=<value> Override the api version used for api requests made by this command
2094
+ --dot-code Display the ancestry tree in DOT code.
2095
+ --verbose Display both the package version ID (starts with 04t) and the version number
2096
+ (major.minor.patch.build) in the ancestry tree.
686
2097
 
687
- DESCRIPTION
688
- list all package versions in the Dev Hub org
2098
+ GLOBAL FLAGS
2099
+ --json Format output as json.
2100
+
2101
+ ALIASES
2102
+ $ sf force:package:version:displayancestry
2103
+
2104
+ EXAMPLES
2105
+ Display the ancestry tree for a package version with the specified alias, using your default Dev Hub org:
2106
+
2107
+ $ sf package:version:displayancestry --package package_version_alias
2108
+
2109
+ Similar to previous example, but display the output in DOT code:
2110
+
2111
+ $ sf package:version:displayancestry --package package_version_alias --dot-code
2112
+
2113
+ Display the ancestry tree for a package with the specified ID, using the Dev Hub org with username
2114
+ devhub@example.com:
2115
+
2116
+ $ sf package:version:displayancestry --package OHo... --target-dev-hub devhub@example.com
2117
+
2118
+ Display the ancestry tree of a package version with the specified ID, using your default Dev Hub org:
2119
+
2120
+ $ sf package:version:displayancestry --package 04t...
2121
+
2122
+ FLAG DESCRIPTIONS
2123
+ -p, --package=<value>
2124
+
2125
+ ID or alias of the package (starts with 0Ho) or package version (starts with 04t) to display ancestry for.
2126
+
2127
+ If you specify a package ID (starts with 0Ho) or alias, the ancestor tree for every package version associated with
2128
+ the package ID is displayed. If you specify a package version (starts with 04t) or alias, the ancestry tree of the
2129
+ specified package version is displayed.
2130
+
2131
+ --dot-code Display the ancestry tree in DOT code.
2132
+
2133
+ You can use the DOT code output in graph visualization software to create tree visualizations.
689
2134
  ```
690
2135
 
691
- _See code: [src/commands/force/package/beta/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/v0.0.1/src/commands/force/package/beta/version/list.ts)_
2136
+ _See code: [src/commands/package/version/displayancestry.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.21.4/src/commands/package/version/displayancestry.ts)_
692
2137
 
693
- ## `sfdx force:package:beta:version:promote -p <string> [-n] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
2138
+ ## `sf package:version:list`
694
2139
 
695
- promote a package version to released
2140
+ List all package versions in the Dev Hub org.
696
2141
 
697
2142
  ```
698
2143
  USAGE
699
- $ sfdx force:package:beta:version:promote -p <string> [-n] [-v <string>] [--apiversion <string>] [--json] [--loglevel
700
- trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
2144
+ $ sf package:version:list -v <value> [--json] [--api-version <value>] [-c <value>] [--concise] [-m <value>] [-p <value>]
2145
+ [-r] [-o <value>] [--verbose]
701
2146
 
702
2147
  FLAGS
703
- -n, --noprompt no prompt to confirm setting the
704
- package version as released
705
- -p, --package=<value> (required) ID (starts with 04t) or
706
- alias of the package version to
707
- promote
708
- -v, --targetdevhubusername=<value> username or alias for the dev hub
709
- org; overrides default dev hub org
710
- --apiversion=<value> override the api version used for
711
- api requests made by this command
712
- --json format output as json
713
- --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
714
- this command invocation
2148
+ -c, --created-last-days=<value> Number of days since the request was created, starting at 00:00:00 of first day to
2149
+ now. Use 0 for today.
2150
+ -m, --modified-last-days=<value> Number of days since the items were modified, starting at 00:00:00 of first day to
2151
+ now. Use 0 for today.
2152
+ -o, --order-by=<value> Package version fields used to order the list.
2153
+ -p, --packages=<value> Comma-delimited list of packages (aliases or 0Ho IDs) to list.
2154
+ -r, --released Display released versions only (IsReleased=true).
2155
+ -v, --target-dev-hub=<value> (required) [default: william.ruemmele@brave-bear-5fmf7j.com] Username or alias of
2156
+ the Dev Hub org.
2157
+ --api-version=<value> Override the api version used for api requests made by this command
2158
+ --concise Display limited package version details.
2159
+ --verbose Display extended package version details.
2160
+
2161
+ GLOBAL FLAGS
2162
+ --json Format output as json.
715
2163
 
716
2164
  DESCRIPTION
717
- promote a package version to released
2165
+ List all package versions in the Dev Hub org.
2166
+
2167
+ Description
2168
+
2169
+ ALIASES
2170
+ $ sf force:package:version:list
2171
+
2172
+ EXAMPLES
2173
+ List package versions in your default Dev Hub org that were created in the last 3 days; show only the released
2174
+ versions and order the list using the PatchVersion field. Display extended details about each package version:
2175
+
2176
+ $ sf package:version:list --verbose --created-last-days 3 --released --order-by PatchVersion
2177
+
2178
+ List the released package versions for the two specified packages that were modified today; use the Dev Hub org with
2179
+ username devhub@example.com:
2180
+
2181
+ $ sf package:version:list --packages 0Ho000000000000,0Ho000000000001 --released --modified-last-days 0 \
2182
+ --target-dev-hub devhub@example.com
2183
+
2184
+ List all released package versions in your default Dev Hub org:
2185
+
2186
+ $ sf package:version:list --released
2187
+
2188
+ List package versions that were modified today in your default Dev Hub org; show limited details about each one:
2189
+
2190
+ $ sf package:version:list --concise --modified-last-days 0
2191
+
2192
+ List released package versions that were created in the last 3 days in your default Dev Hub org; show limited
2193
+ details:
2194
+
2195
+ $ sf package:version:list --concise --created-last-days 3 --released
2196
+
2197
+ List released package versions that were modified today for the two packages with specified aliases in your default
2198
+ Dev Hub org:
2199
+
2200
+ $ sf package:version:list --packages exp-mgr,exp-mgr-util --released --modified-last-days 0
718
2201
  ```
719
2202
 
720
- _See code: [src/commands/force/package/beta/version/promote.ts](https://github.com/salesforcecli/plugin-packaging/blob/v0.0.1/src/commands/force/package/beta/version/promote.ts)_
2203
+ _See code: [src/commands/package/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.21.4/src/commands/package/version/list.ts)_
721
2204
 
722
- ## `sfdx force:package:beta:version:report -p <string> [-v <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
2205
+ ## `sf package:version:promote`
723
2206
 
724
- retrieve details about a package version in the Dev Hub org
2207
+ Promote a package version to released.
725
2208
 
726
2209
  ```
727
2210
  USAGE
728
- $ sfdx force:package:beta:version:report -p <string> [-v <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel
729
- trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
2211
+ $ sf package:version:promote -v <value> -p <value> [--json] [--api-version <value>] [-n]
730
2212
 
731
2213
  FLAGS
732
- -p, --package=<value> (required) ID (starts with 04t) or
733
- alias of the package to retrieve
734
- details for
735
- -v, --targetdevhubusername=<value> username or alias for the dev hub
736
- org; overrides default dev hub org
737
- --apiversion=<value> override the api version used for
738
- api requests made by this command
739
- --json format output as json
740
- --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
741
- this command invocation
742
- --verbose displays extended package version
743
- details
2214
+ -n, --no-prompt Don't prompt to confirm setting the package version as released.
2215
+ -p, --package=<value> (required) ID (starts with 04t) or alias of the package version to promote.
2216
+ -v, --target-dev-hub=<value> (required) [default: william.ruemmele@brave-bear-5fmf7j.com] Username or alias of the
2217
+ Dev Hub org.
2218
+ --api-version=<value> Override the api version used for api requests made by this command
2219
+
2220
+ GLOBAL FLAGS
2221
+ --json Format output as json.
744
2222
 
745
2223
  DESCRIPTION
746
- retrieve details about a package version in the Dev Hub org
2224
+ Promote a package version to released.
2225
+
2226
+ Supply the ID or alias of the package version you want to promote. Promotes the package version to released status.
2227
+
2228
+ ALIASES
2229
+ $ sf force:package:version:promote
2230
+
2231
+ EXAMPLES
2232
+ Promote the package version with the specified ID to released; uses your default Dev Hub org:
2233
+
2234
+ $ sf package:version:promote --package 04t...
2235
+
2236
+ Promote the package version with the specified alias to released; uses the Dev Hub org with username
2237
+ devhub@example.com:
2238
+
2239
+ $ sf package:version:promote --package awesome_package_alias --target-dev-hub devhub@example.com
2240
+
2241
+ Promote the package version with an alias that has spaces to released:
2242
+
2243
+ $ sf package:version:promote --package "Awesome Package Alias"
747
2244
  ```
748
2245
 
749
- _See code: [src/commands/force/package/beta/version/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/v0.0.1/src/commands/force/package/beta/version/report.ts)_
2246
+ _See code: [src/commands/package/version/promote.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.21.4/src/commands/package/version/promote.ts)_
750
2247
 
751
- ## `sfdx force:package:beta:version:update -p <string> [-a <string>] [-e <string>] [-b <string>] [-t <string>] [-k <string>] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
2248
+ ## `sf package:version:report`
752
2249
 
753
- update a package version
2250
+ Retrieve details about a package version in the Dev Hub org.
754
2251
 
755
2252
  ```
756
2253
  USAGE
757
- $ sfdx force:package:beta:version:update -p <string> [-a <string>] [-e <string>] [-b <string>] [-t <string>] [-k <string>] [-v
758
- <string>] [--apiversion <string>] [--json] [--loglevel
759
- trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
2254
+ $ sf package:version:report -v <value> -p <value> [--json] [--api-version <value>] [--verbose]
760
2255
 
761
2256
  FLAGS
762
- -a, --versionname=<value> new package version name
763
- -b, --branch=<value> new package version branch
764
- -e, --versiondescription=<value> new package version description
765
- -k, --installationkey=<value> new installation key for
766
- key-protected package (default:
767
- null)
768
- -p, --package=<value> (required) ID (starts with 04t) or
769
- alias of the package to update a
770
- version of
771
- -t, --tag=<value> new package version tag
772
- -v, --targetdevhubusername=<value> username or alias for the dev hub
773
- org; overrides default dev hub org
774
- --apiversion=<value> override the api version used for
775
- api requests made by this command
776
- --json format output as json
777
- --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
778
- this command invocation
2257
+ -p, --package=<value> (required) ID (starts with 04t) or alias of the package to retrieve details for.
2258
+ -v, --target-dev-hub=<value> (required) [default: william.ruemmele@brave-bear-5fmf7j.com] Username or alias of the
2259
+ Dev Hub org.
2260
+ --api-version=<value> Override the api version used for api requests made by this command
2261
+ --verbose Display extended package version details.
2262
+
2263
+ GLOBAL FLAGS
2264
+ --json Format output as json.
779
2265
 
780
2266
  DESCRIPTION
781
- update a package version
2267
+ Retrieve details about a package version in the Dev Hub org.
2268
+
2269
+ To update package version values, run "sf package version update".
2270
+
2271
+ ALIASES
2272
+ $ sf force:package:version:report
2273
+
2274
+ EXAMPLES
2275
+ Retrieve details about the package version with the specified ID from your default Dev Hub org:
2276
+
2277
+ $ sf package:version:report --package 04t...
2278
+
2279
+ Retrieve details about the package version with the specified alias (that contains spaces) from the Dev Hub org with
2280
+ username devhub@example.com:
2281
+
2282
+ $ sf package:version:report --package "Your Package Alias" --target-dev-hub devhub@example.com
782
2283
  ```
783
2284
 
784
- _See code: [src/commands/force/package/beta/version/update.ts](https://github.com/salesforcecli/plugin-packaging/blob/v0.0.1/src/commands/force/package/beta/version/update.ts)_
2285
+ _See code: [src/commands/package/version/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.21.4/src/commands/package/version/report.ts)_
785
2286
 
786
- ## `sfdx version`
2287
+ ## `sf package:version:update`
2288
+
2289
+ Update a package version.
787
2290
 
788
2291
  ```
789
2292
  USAGE
790
- $ sfdx version [--json] [--verbose]
2293
+ $ sf package:version:update -v <value> -p <value> [--json] [--api-version <value>] [-a <value>] [-e <value>] [-b <value>]
2294
+ [-t <value>] [-k <value>]
791
2295
 
792
2296
  FLAGS
793
- --verbose Show additional information about the CLI.
2297
+ -a, --version-name=<value> New package version name.
2298
+ -b, --branch=<value> New package version branch.
2299
+ -e, --version-description=<value> New package version description.
2300
+ -k, --installation-key=<value> New installation key for key-protected package (default: null)
2301
+ -p, --package=<value> (required) ID (starts with 04t) or alias of the package to update a version of.
2302
+ -t, --tag=<value> New package version tag.
2303
+ -v, --target-dev-hub=<value> (required) [default: william.ruemmele@brave-bear-5fmf7j.com] Username or alias of
2304
+ the Dev Hub org.
2305
+ --api-version=<value> Override the api version used for api requests made by this command
794
2306
 
795
2307
  GLOBAL FLAGS
796
2308
  --json Format output as json.
797
2309
 
798
- FLAG DESCRIPTIONS
799
- --verbose Show additional information about the CLI.
2310
+ DESCRIPTION
2311
+ Update a package version.
2312
+
2313
+ Specify a new value for each option you want to update.
2314
+
2315
+ To display details about a package version, run "sf package version display".
2316
+
2317
+ ALIASES
2318
+ $ sf force:package:version:update
2319
+
2320
+ EXAMPLES
2321
+ Update the package version that has the specified alias (that contains spaces) with a new installation key
2322
+ "password123"; uses your default Dev Hub org:
2323
+
2324
+ $ sf package:version:update --package "Your Package Alias" --installation-key password123
2325
+
2326
+ Update the package version that has the specified ID with a new branch and tag; use the Dev Hub org with username
2327
+ devhub@example.com:
2328
+
2329
+ $ sf package:version:update --package 04t... --branch main --tag 'Release 1.0.7' --target-dev-hub \
2330
+ devhub@example.com
2331
+
2332
+ Update the package version that has the specified ID with a new description:
800
2333
 
801
- Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.
2334
+ $ sf package:version:update --package 04t... --version-description "New Package Version Description"
802
2335
  ```
803
2336
 
804
- _See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/v1.1.2/src/commands/version.ts)_
2337
+ _See code: [src/commands/package/version/update.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.21.4/src/commands/package/version/update.ts)_
805
2338
 
806
2339
  <!-- commandsstop -->