@salesforce/plugin-packaging 0.0.1 → 1.2.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.
- package/CHANGELOG.md +31 -1
- package/README.md +732 -14
- package/lib/commands/force/package/beta/convert.d.ts +13 -0
- package/lib/commands/force/package/beta/convert.js +61 -0
- package/lib/commands/force/package/beta/convert.js.map +1 -0
- package/lib/commands/force/package/beta/create.d.ts +15 -0
- package/lib/commands/force/package/beta/create.js +87 -0
- package/lib/commands/force/package/beta/create.js.map +1 -0
- package/lib/commands/force/package/beta/delete.d.ts +14 -0
- package/lib/commands/force/package/beta/delete.js +61 -0
- package/lib/commands/force/package/beta/delete.js.map +1 -0
- package/lib/commands/force/package/beta/install/report.d.ts +15 -0
- package/lib/commands/force/package/beta/install/report.js +66 -0
- package/lib/commands/force/package/beta/install/report.js.map +1 -0
- package/lib/commands/force/package/beta/install.d.ts +22 -0
- package/lib/commands/force/package/beta/install.js +228 -0
- package/lib/commands/force/package/beta/install.js.map +1 -0
- package/lib/commands/force/package/beta/installed/list.d.ts +17 -0
- package/lib/commands/force/package/beta/installed/list.js +46 -0
- package/lib/commands/force/package/beta/installed/list.js.map +1 -0
- package/lib/commands/force/package/beta/list.d.ts +21 -0
- package/lib/commands/force/package/beta/list.js +90 -0
- package/lib/commands/force/package/beta/list.js.map +1 -0
- package/lib/commands/force/package/beta/uninstall/report.d.ts +10 -0
- package/lib/commands/force/package/beta/uninstall/report.js +33 -0
- package/lib/commands/force/package/beta/uninstall/report.js.map +1 -0
- package/lib/commands/force/package/beta/uninstall.d.ts +12 -0
- package/lib/commands/force/package/beta/uninstall.js +52 -0
- package/lib/commands/force/package/beta/uninstall.js.map +1 -0
- package/lib/commands/force/package/beta/update.d.ts +12 -0
- package/lib/commands/force/package/beta/update.js +51 -0
- package/lib/commands/force/package/beta/update.js.map +1 -0
- package/lib/commands/force/package/beta/version/create/list.d.ts +12 -0
- package/lib/commands/force/package/beta/version/create/list.js +40 -0
- package/lib/commands/force/package/beta/version/create/list.js.map +1 -0
- package/lib/commands/force/package/beta/version/create/report.d.ts +12 -0
- package/lib/commands/force/package/beta/version/create/report.js +87 -0
- package/lib/commands/force/package/beta/version/create/report.js.map +1 -0
- package/lib/commands/force/package/beta/version/create.d.ts +12 -0
- package/lib/commands/force/package/beta/version/create.js +136 -0
- package/lib/commands/force/package/beta/version/create.js.map +1 -0
- package/lib/commands/force/package/beta/version/delete.d.ts +15 -0
- package/lib/commands/force/package/beta/version/delete.js +64 -0
- package/lib/commands/force/package/beta/version/delete.js.map +1 -0
- package/lib/commands/force/package/beta/version/displayancestry.d.ts +13 -0
- package/lib/commands/force/package/beta/version/displayancestry.js +46 -0
- package/lib/commands/force/package/beta/version/displayancestry.js.map +1 -0
- package/lib/commands/force/package/beta/version/list.d.ts +12 -0
- package/lib/commands/force/package/beta/version/list.js +62 -0
- package/lib/commands/force/package/beta/version/list.js.map +1 -0
- package/lib/commands/force/package/beta/version/promote.d.ts +12 -0
- package/lib/commands/force/package/beta/version/promote.js +40 -0
- package/lib/commands/force/package/beta/version/promote.js.map +1 -0
- package/lib/commands/force/package/beta/version/report.d.ts +24 -0
- package/lib/commands/force/package/beta/version/report.js +209 -0
- package/lib/commands/force/package/beta/version/report.js.map +1 -0
- package/lib/commands/force/package/beta/version/update.d.ts +12 -0
- package/lib/commands/force/package/beta/version/update.js +60 -0
- package/lib/commands/force/package/beta/version/update.js.map +1 -0
- package/lib/commands/force/package1/beta/version/create/get.d.ts +9 -0
- package/lib/commands/force/package1/beta/version/create/get.js +48 -0
- package/lib/commands/force/package1/beta/version/create/get.js.map +1 -0
- package/lib/commands/force/package1/beta/version/create.d.ts +14 -0
- package/lib/commands/force/package1/beta/version/create.js +116 -0
- package/lib/commands/force/package1/beta/version/create.js.map +1 -0
- package/lib/commands/force/package1/beta/version/display.d.ts +9 -0
- package/lib/commands/force/package1/beta/version/display.js +55 -0
- package/lib/commands/force/package1/beta/version/display.js.map +1 -0
- package/lib/commands/force/package1/beta/version/list.d.ts +10 -0
- package/lib/commands/force/package1/beta/version/list.js +54 -0
- package/lib/commands/force/package1/beta/version/list.js.map +1 -0
- package/messages/default.md +1127 -0
- package/messages/package1_version_create.md +128 -0
- package/messages/package1_version_create_get.md +31 -0
- package/messages/package1_version_display.md +19 -0
- package/messages/package1_version_list.md +31 -0
- package/messages/package2.md +87 -0
- package/messages/package2_create.md +56 -0
- package/messages/package2_list.md +35 -0
- package/messages/package2_update.md +45 -0
- package/messages/package2_version_create.md +149 -0
- package/messages/package2_version_create_get.md +34 -0
- package/messages/package2_version_create_list.md +62 -0
- package/messages/package2_version_get.md +14 -0
- package/messages/package2_version_list.md +98 -0
- package/messages/package2_version_update.md +89 -0
- package/messages/package_convert.md +72 -0
- package/messages/package_create.md +90 -0
- package/messages/package_delete.md +63 -0
- package/messages/package_displayancestry.md +64 -0
- package/messages/package_install.md +178 -0
- package/messages/package_install_get.md +34 -0
- package/messages/package_install_report.md +34 -0
- package/messages/package_install_request.md +34 -0
- package/messages/package_installed_list.md +16 -0
- package/messages/package_list.md +67 -0
- package/messages/package_uninstall.md +73 -0
- package/messages/package_uninstall_get.md +34 -0
- package/messages/package_uninstall_report.md +34 -0
- package/messages/package_update.md +45 -0
- package/messages/package_version_create.md +301 -0
- package/messages/package_version_create_list.md +62 -0
- package/messages/package_version_create_report.md +35 -0
- package/messages/package_version_delete.md +63 -0
- package/messages/package_version_list.md +135 -0
- package/messages/package_version_promote.md +50 -0
- package/messages/package_version_report.md +51 -0
- package/messages/package_version_update.md +74 -0
- package/messages/packaging.md +157 -0
- package/oclif.manifest.json +1 -1
- package/package.json +68 -15
- package/lib/commands/force/package/placeholder.d.ts +0 -6
- package/lib/commands/force/package/placeholder.js +0 -18
- package/lib/commands/force/package/placeholder.js.map +0 -1
package/README.md
CHANGED
|
@@ -1,13 +1,11 @@
|
|
|
1
1
|
# plugin-packaging;
|
|
2
2
|
|
|
3
|
-
> :warning: **This
|
|
3
|
+
> :warning: **This plugin is currently in beta. We appreciate any feedback via https://github.com/forcedotcom/cli/issues**
|
|
4
4
|
|
|
5
5
|
[](https://www.npmjs.com/package/@salesforce/plugin-packaging) [](https://circleci.com/gh/salesforcecli/plugin-packaging/tree/main) [](https://npmjs.org/package/@salesforce/plugin-packaging) [](https://raw.githubusercontent.com/salesforcecli/plugin-packaging/main/LICENSE.txt)
|
|
6
6
|
|
|
7
7
|
## This plugin provides the sfdx cli commands that support Salesforce Packaging Platform
|
|
8
8
|
|
|
9
|
-
## Learn about the plugin-packaging
|
|
10
|
-
|
|
11
9
|
## Install
|
|
12
10
|
|
|
13
11
|
```bash
|
|
@@ -70,36 +68,756 @@ sfdx plugins
|
|
|
70
68
|
|
|
71
69
|
<!-- commands -->
|
|
72
70
|
|
|
73
|
-
- [`sfdx force:
|
|
74
|
-
- [`sfdx version`](#sfdx-
|
|
71
|
+
- [`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)
|
|
72
|
+
- [`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)
|
|
73
|
+
- [`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)
|
|
74
|
+
- [`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)
|
|
75
|
+
- [`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)
|
|
76
|
+
- [`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)
|
|
77
|
+
- [`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)
|
|
78
|
+
- [`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)
|
|
79
|
+
- [`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)
|
|
80
|
+
- [`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)
|
|
81
|
+
- [`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)
|
|
82
|
+
- [`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)
|
|
83
|
+
- [`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)
|
|
84
|
+
- [`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)
|
|
85
|
+
- [`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)
|
|
86
|
+
- [`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)
|
|
87
|
+
- [`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)
|
|
88
|
+
- [`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)
|
|
89
|
+
- [`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)
|
|
90
|
+
- [`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)
|
|
91
|
+
- [`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)
|
|
92
|
+
- [`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)
|
|
93
|
+
|
|
94
|
+
## `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]`
|
|
95
|
+
|
|
96
|
+
create a first-generation package version in the release org
|
|
97
|
+
|
|
98
|
+
```
|
|
99
|
+
USAGE
|
|
100
|
+
$ sfdx force:package1:beta:version:create -i <id> -n <string> [-d <string>] [-v <string>] [-m] [-r <url>] [-p <url>] [-k <string>] [-w
|
|
101
|
+
<minutes>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
|
|
102
|
+
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
|
|
103
|
+
|
|
104
|
+
FLAGS
|
|
105
|
+
-d, --description=<value> package version description
|
|
106
|
+
-i, --packageid=<value> (required) ID of the metadata
|
|
107
|
+
package (starts with 033) of which
|
|
108
|
+
you’re creating a new version
|
|
109
|
+
-k, --installationkey=<value> installation key for key-protected
|
|
110
|
+
package (default: null)
|
|
111
|
+
-m, --managedreleased create a managed package version
|
|
112
|
+
-n, --name=<value> (required) package version name
|
|
113
|
+
-p, --postinstallurl=<value> post install URL
|
|
114
|
+
-r, --releasenotesurl=<value> release notes URL
|
|
115
|
+
-u, --targetusername=<value> username or alias for the target
|
|
116
|
+
org; overrides default target org
|
|
117
|
+
-v, --version=<value> package version in major.minor
|
|
118
|
+
format, for example, 3.2
|
|
119
|
+
-w, --wait=<value> minutes to wait for the package
|
|
120
|
+
version to be created (default: 2
|
|
121
|
+
minutes)
|
|
122
|
+
--apiversion=<value> override the api version used for
|
|
123
|
+
api requests made by this command
|
|
124
|
+
--json format output as json
|
|
125
|
+
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
|
|
126
|
+
this command invocation
|
|
127
|
+
|
|
128
|
+
DESCRIPTION
|
|
129
|
+
create a first-generation package version in the release org
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
_See code: [src/commands/force/package1/beta/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.1.1/src/commands/force/package1/beta/version/create.ts)_
|
|
133
|
+
|
|
134
|
+
## `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]`
|
|
135
|
+
|
|
136
|
+
retrieve the status of a package version creation request
|
|
137
|
+
|
|
138
|
+
```
|
|
139
|
+
USAGE
|
|
140
|
+
$ sfdx force:package1:beta:version:create:get -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel
|
|
141
|
+
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
|
|
142
|
+
|
|
143
|
+
FLAGS
|
|
144
|
+
-i, --requestid=<value> (required) PackageUploadRequest ID
|
|
145
|
+
-u, --targetusername=<value> username or alias for the target
|
|
146
|
+
org; overrides default target org
|
|
147
|
+
--apiversion=<value> override the api version used for
|
|
148
|
+
api requests made by this command
|
|
149
|
+
--json format output as json
|
|
150
|
+
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
|
|
151
|
+
this command invocation
|
|
152
|
+
|
|
153
|
+
DESCRIPTION
|
|
154
|
+
retrieve the status of a package version creation request
|
|
155
|
+
|
|
156
|
+
EXAMPLES
|
|
157
|
+
Examples:
|
|
158
|
+
|
|
159
|
+
$ sfdx force:package1:version:create:get -i 0HD...
|
|
160
|
+
|
|
161
|
+
$ sfdx force:package1:version:create:get -i 0HD... -u devhub@example.com
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
_See code: [src/commands/force/package1/beta/version/create/get.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.1.1/src/commands/force/package1/beta/version/create/get.ts)_
|
|
165
|
+
|
|
166
|
+
## `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]`
|
|
167
|
+
|
|
168
|
+
display details about a first-generation package version
|
|
169
|
+
|
|
170
|
+
```
|
|
171
|
+
USAGE
|
|
172
|
+
$ sfdx force:package1:beta:version:display -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel
|
|
173
|
+
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
|
|
174
|
+
|
|
175
|
+
FLAGS
|
|
176
|
+
-i, --packageversionid=<value> (required) metadata package version
|
|
177
|
+
ID (starts with 04t)
|
|
178
|
+
-u, --targetusername=<value> username or alias for the target
|
|
179
|
+
org; overrides default target org
|
|
180
|
+
--apiversion=<value> override the api version used for
|
|
181
|
+
api requests made by this command
|
|
182
|
+
--json format output as json
|
|
183
|
+
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
|
|
184
|
+
this command invocation
|
|
185
|
+
|
|
186
|
+
DESCRIPTION
|
|
187
|
+
display details about a first-generation package version
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
_See code: [src/commands/force/package1/beta/version/display.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.1.1/src/commands/force/package1/beta/version/display.ts)_
|
|
191
|
+
|
|
192
|
+
## `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]`
|
|
193
|
+
|
|
194
|
+
list package versions for the specified first-generation package or for the org
|
|
195
|
+
|
|
196
|
+
```
|
|
197
|
+
USAGE
|
|
198
|
+
$ sfdx force:package1:beta:version:list [-i <id>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
|
|
199
|
+
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
|
|
200
|
+
|
|
201
|
+
FLAGS
|
|
202
|
+
-i, --packageid=<value> metadata package ID (starts with
|
|
203
|
+
033)
|
|
204
|
+
-u, --targetusername=<value> username or alias for the target
|
|
205
|
+
org; overrides default target org
|
|
206
|
+
--apiversion=<value> override the api version used for
|
|
207
|
+
api requests made by this command
|
|
208
|
+
--json format output as json
|
|
209
|
+
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
|
|
210
|
+
this command invocation
|
|
211
|
+
|
|
212
|
+
DESCRIPTION
|
|
213
|
+
list package versions for the specified first-generation package or for the org
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
_See code: [src/commands/force/package1/beta/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.1.1/src/commands/force/package1/beta/version/list.ts)_
|
|
217
|
+
|
|
218
|
+
## `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]`
|
|
219
|
+
|
|
220
|
+
create a package
|
|
221
|
+
|
|
222
|
+
```
|
|
223
|
+
USAGE
|
|
224
|
+
$ sfdx force:package:beta:create -n <string> -t Managed|Unlocked -r <directory> [-d <string>] [-e] [--orgdependent] [-o
|
|
225
|
+
<string>] [-v <string>] [--apiversion <string>] [--json] [--loglevel
|
|
226
|
+
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
|
|
227
|
+
|
|
228
|
+
FLAGS
|
|
229
|
+
-d, --description=<value> package description
|
|
230
|
+
-e, --nonamespace creates the package with no
|
|
231
|
+
namespace; available only for
|
|
232
|
+
unlocked packages.
|
|
233
|
+
-n, --name=<value> (required) package name
|
|
234
|
+
-o, --errornotificationusername=<value> active Dev Hub user designated to
|
|
235
|
+
receive email notifications for
|
|
236
|
+
package errors
|
|
237
|
+
-r, --path=<value> (required) path to directory that
|
|
238
|
+
contains the contents of the package
|
|
239
|
+
-t, --packagetype=(Managed|Unlocked) (required) package type
|
|
240
|
+
-v, --targetdevhubusername=<value> username or alias for the dev hub
|
|
241
|
+
org; overrides default dev hub org
|
|
242
|
+
--apiversion=<value> override the api version used for
|
|
243
|
+
api requests made by this command
|
|
244
|
+
--json format output as json
|
|
245
|
+
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
|
|
246
|
+
this command invocation
|
|
247
|
+
--orgdependent depends on unpackaged metadata in
|
|
248
|
+
the installation org. Applies to
|
|
249
|
+
unlocked packages only.
|
|
250
|
+
|
|
251
|
+
DESCRIPTION
|
|
252
|
+
create a package
|
|
253
|
+
```
|
|
254
|
+
|
|
255
|
+
_See code: [src/commands/force/package/beta/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.1.1/src/commands/force/package/beta/create.ts)_
|
|
256
|
+
|
|
257
|
+
## `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]`
|
|
258
|
+
|
|
259
|
+
delete a package
|
|
260
|
+
|
|
261
|
+
```
|
|
262
|
+
USAGE
|
|
263
|
+
$ sfdx force:package:beta:delete -p <string> [-n] [-v <string>] [--apiversion <string>] [--json] [--loglevel
|
|
264
|
+
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
|
|
265
|
+
|
|
266
|
+
FLAGS
|
|
267
|
+
-n, --noprompt don’t prompt before deleting the
|
|
268
|
+
package
|
|
269
|
+
-p, --package=<value> (required) ID (starts with 0Ho) or
|
|
270
|
+
alias of the package to delete
|
|
271
|
+
-v, --targetdevhubusername=<value> username or alias for the dev hub
|
|
272
|
+
org; overrides default dev hub org
|
|
273
|
+
--apiversion=<value> override the api version used for
|
|
274
|
+
api requests made by this command
|
|
275
|
+
--json format output as json
|
|
276
|
+
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
|
|
277
|
+
this command invocation
|
|
278
|
+
|
|
279
|
+
DESCRIPTION
|
|
280
|
+
delete a package
|
|
281
|
+
```
|
|
282
|
+
|
|
283
|
+
_See code: [src/commands/force/package/beta/delete.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.1.1/src/commands/force/package/beta/delete.ts)_
|
|
284
|
+
|
|
285
|
+
## `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]`
|
|
286
|
+
|
|
287
|
+
install a package in the target org
|
|
288
|
+
|
|
289
|
+
```
|
|
290
|
+
USAGE
|
|
291
|
+
$ sfdx force:package:beta:install -p <string> [-w <minutes>] [-k <string>] [-b <minutes>] [-r] [-a all|package] [-s
|
|
292
|
+
AllUsers|AdminsOnly] [-t DeprecateOnly|Mixed|Delete] [-u <string>] [--apiversion <string>] [--json] [--loglevel
|
|
293
|
+
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
|
|
294
|
+
|
|
295
|
+
FLAGS
|
|
296
|
+
-a, --apexcompile=(all|package)
|
|
297
|
+
[default: all] compile all Apex in the org and package, or only Apex in the package; unlocked packages only
|
|
298
|
+
|
|
299
|
+
-b, --publishwait=<value>
|
|
300
|
+
number of minutes to wait for subscriber package version ID to become available in the target org
|
|
301
|
+
|
|
302
|
+
-k, --installationkey=<value>
|
|
303
|
+
installation key for key-protected package (default: null)
|
|
304
|
+
|
|
305
|
+
-p, --package=<value>
|
|
306
|
+
(required) ID (starts with 04t) or alias of the package version to install
|
|
307
|
+
|
|
308
|
+
-r, --noprompt
|
|
309
|
+
do not prompt for confirmation
|
|
310
|
+
|
|
311
|
+
-s, --securitytype=(AllUsers|AdminsOnly)
|
|
312
|
+
[default: AdminsOnly] security access type for the installed package (deprecation notice: The default --securitytype
|
|
313
|
+
value will change from AllUsers to AdminsOnly in v47.0 or later.)
|
|
314
|
+
|
|
315
|
+
-t, --upgradetype=(DeprecateOnly|Mixed|Delete)
|
|
316
|
+
[default: Mixed] the upgrade type for the package installation; available only for unlocked packages
|
|
317
|
+
|
|
318
|
+
-u, --targetusername=<value>
|
|
319
|
+
username or alias for the target org; overrides default target org
|
|
320
|
+
|
|
321
|
+
-w, --wait=<value>
|
|
322
|
+
number of minutes to wait for installation status
|
|
323
|
+
|
|
324
|
+
--apiversion=<value>
|
|
325
|
+
override the api version used for api requests made by this command
|
|
326
|
+
|
|
327
|
+
--json
|
|
328
|
+
format output as json
|
|
329
|
+
|
|
330
|
+
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)
|
|
331
|
+
[default: warn] logging level for this command invocation
|
|
332
|
+
|
|
333
|
+
DESCRIPTION
|
|
334
|
+
install a package in the target org
|
|
335
|
+
```
|
|
336
|
+
|
|
337
|
+
_See code: [src/commands/force/package/beta/install.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.1.1/src/commands/force/package/beta/install.ts)_
|
|
338
|
+
|
|
339
|
+
## `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]`
|
|
340
|
+
|
|
341
|
+
retrieve the status of a package installation request
|
|
342
|
+
|
|
343
|
+
```
|
|
344
|
+
USAGE
|
|
345
|
+
$ sfdx force:package:beta:install:report -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel
|
|
346
|
+
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
|
|
347
|
+
|
|
348
|
+
FLAGS
|
|
349
|
+
-i, --requestid=<value> (required) ID of the package install
|
|
350
|
+
request you want to check
|
|
351
|
+
-u, --targetusername=<value> username or alias for the target
|
|
352
|
+
org; overrides default target org
|
|
353
|
+
--apiversion=<value> override the api version used for
|
|
354
|
+
api requests made by this command
|
|
355
|
+
--json format output as json
|
|
356
|
+
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
|
|
357
|
+
this command invocation
|
|
358
|
+
|
|
359
|
+
DESCRIPTION
|
|
360
|
+
retrieve the status of a package installation request
|
|
361
|
+
```
|
|
362
|
+
|
|
363
|
+
_See code: [src/commands/force/package/beta/install/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.1.1/src/commands/force/package/beta/install/report.ts)_
|
|
364
|
+
|
|
365
|
+
## `sfdx force:package:beta:installed:list [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
|
|
366
|
+
|
|
367
|
+
list the org’s installed packages
|
|
368
|
+
|
|
369
|
+
```
|
|
370
|
+
USAGE
|
|
371
|
+
$ sfdx force:package:beta:installed:list [-u <string>] [--apiversion <string>] [--json] [--loglevel
|
|
372
|
+
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
|
|
373
|
+
|
|
374
|
+
FLAGS
|
|
375
|
+
-u, --targetusername=<value> username or alias for the target
|
|
376
|
+
org; overrides default target org
|
|
377
|
+
--apiversion=<value> override the api version used for
|
|
378
|
+
api requests made by this command
|
|
379
|
+
--json format output as json
|
|
380
|
+
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
|
|
381
|
+
this command invocation
|
|
382
|
+
|
|
383
|
+
DESCRIPTION
|
|
384
|
+
list the org’s installed packages
|
|
385
|
+
|
|
386
|
+
EXAMPLES
|
|
387
|
+
$ sfdx force:package:installed:list
|
|
388
|
+
|
|
389
|
+
$ sfdx force:package:installed:list -u me@example.com
|
|
390
|
+
```
|
|
391
|
+
|
|
392
|
+
_See code: [src/commands/force/package/beta/installed/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.1.1/src/commands/force/package/beta/installed/list.ts)_
|
|
393
|
+
|
|
394
|
+
## `sfdx force:package:beta:list [-v <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
|
|
395
|
+
|
|
396
|
+
list all packages in the Dev Hub org
|
|
397
|
+
|
|
398
|
+
```
|
|
399
|
+
USAGE
|
|
400
|
+
$ sfdx force:package:beta:list [-v <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel
|
|
401
|
+
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
|
|
402
|
+
|
|
403
|
+
FLAGS
|
|
404
|
+
-v, --targetdevhubusername=<value> username or alias for the dev hub
|
|
405
|
+
org; overrides default dev hub org
|
|
406
|
+
--apiversion=<value> override the api version used for
|
|
407
|
+
api requests made by this command
|
|
408
|
+
--json format output as json
|
|
409
|
+
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
|
|
410
|
+
this command invocation
|
|
411
|
+
--verbose display extended package detail
|
|
412
|
+
|
|
413
|
+
DESCRIPTION
|
|
414
|
+
list all packages in the Dev Hub org
|
|
415
|
+
```
|
|
416
|
+
|
|
417
|
+
_See code: [src/commands/force/package/beta/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.1.1/src/commands/force/package/beta/list.ts)_
|
|
418
|
+
|
|
419
|
+
## `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]`
|
|
420
|
+
|
|
421
|
+
uninstall a second-generation package from the target org
|
|
422
|
+
|
|
423
|
+
```
|
|
424
|
+
USAGE
|
|
425
|
+
$ sfdx force:package:beta:uninstall [-w <minutes>] [-p <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
|
|
426
|
+
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
|
|
427
|
+
|
|
428
|
+
FLAGS
|
|
429
|
+
-p, --package=<value> ID (starts with 04t) or alias of the
|
|
430
|
+
package version to uninstall
|
|
431
|
+
-u, --targetusername=<value> username or alias for the target
|
|
432
|
+
org; overrides default target org
|
|
433
|
+
-w, --wait=<value> [default: 0 minutes] number of
|
|
434
|
+
minutes to wait for uninstall status
|
|
435
|
+
--apiversion=<value> override the api version used for
|
|
436
|
+
api requests made by this command
|
|
437
|
+
--json format output as json
|
|
438
|
+
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
|
|
439
|
+
this command invocation
|
|
440
|
+
|
|
441
|
+
DESCRIPTION
|
|
442
|
+
uninstall a second-generation package from the target org
|
|
443
|
+
```
|
|
444
|
+
|
|
445
|
+
_See code: [src/commands/force/package/beta/uninstall.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.1.1/src/commands/force/package/beta/uninstall.ts)_
|
|
446
|
+
|
|
447
|
+
## `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]`
|
|
448
|
+
|
|
449
|
+
retrieve status of package uninstall request
|
|
450
|
+
|
|
451
|
+
```
|
|
452
|
+
USAGE
|
|
453
|
+
$ sfdx force:package:beta:uninstall:report -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel
|
|
454
|
+
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
|
|
455
|
+
|
|
456
|
+
FLAGS
|
|
457
|
+
-i, --requestid=<value> (required) ID of the package
|
|
458
|
+
uninstall request you want to check
|
|
459
|
+
-u, --targetusername=<value> username or alias for the target
|
|
460
|
+
org; overrides default target org
|
|
461
|
+
--apiversion=<value> override the api version used for
|
|
462
|
+
api requests made by this command
|
|
463
|
+
--json format output as json
|
|
464
|
+
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
|
|
465
|
+
this command invocation
|
|
466
|
+
|
|
467
|
+
DESCRIPTION
|
|
468
|
+
retrieve status of package uninstall request
|
|
469
|
+
```
|
|
470
|
+
|
|
471
|
+
_See code: [src/commands/force/package/beta/uninstall/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.1.1/src/commands/force/package/beta/uninstall/report.ts)_
|
|
472
|
+
|
|
473
|
+
## `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]`
|
|
474
|
+
|
|
475
|
+
update package details
|
|
476
|
+
|
|
477
|
+
```
|
|
478
|
+
USAGE
|
|
479
|
+
$ sfdx force:package:beta:update -p <string> [-n <string>] [-d <string>] [-o <string>] [-v <string>] [--apiversion <string>]
|
|
480
|
+
[--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
|
|
481
|
+
|
|
482
|
+
FLAGS
|
|
483
|
+
-d, --description=<value> new package description
|
|
484
|
+
-n, --name=<value> new package name
|
|
485
|
+
-o, --errornotificationusername=<value> active Dev Hub user designated to
|
|
486
|
+
receive email notifications for
|
|
487
|
+
package errors
|
|
488
|
+
-p, --package=<value> (required) ID (starts with 0Ho) or
|
|
489
|
+
alias of the package to update
|
|
490
|
+
-v, --targetdevhubusername=<value> username or alias for the dev hub
|
|
491
|
+
org; overrides default dev hub org
|
|
492
|
+
--apiversion=<value> override the api version used for
|
|
493
|
+
api requests made by this command
|
|
494
|
+
--json format output as json
|
|
495
|
+
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
|
|
496
|
+
this command invocation
|
|
497
|
+
|
|
498
|
+
DESCRIPTION
|
|
499
|
+
update package details
|
|
500
|
+
```
|
|
501
|
+
|
|
502
|
+
_See code: [src/commands/force/package/beta/update.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.1.1/src/commands/force/package/beta/update.ts)_
|
|
503
|
+
|
|
504
|
+
## `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]`
|
|
505
|
+
|
|
506
|
+
create a package version
|
|
507
|
+
|
|
508
|
+
```
|
|
509
|
+
USAGE
|
|
510
|
+
$ sfdx force:package:beta:version:create [-p <string>] [-d <directory>] [-f <filepath>] [-b <string>] [-t <string>] [-k <string>]
|
|
511
|
+
[-x] [-w <minutes>] [-a <string>] [-n <string>] [-e <string>] [-c] [--releasenotesurl <url>] [--postinstallurl
|
|
512
|
+
<url>] [--postinstallscript <string>] [--uninstallscript <string>] [--skipvalidation] [--skipancestorcheck] [-v
|
|
513
|
+
<string>] [--apiversion <string>] [--json] [--loglevel
|
|
514
|
+
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
|
|
515
|
+
|
|
516
|
+
FLAGS
|
|
517
|
+
-a, --versionname=<value> the name of the package version to
|
|
518
|
+
be created
|
|
519
|
+
-b, --branch=<value> the package version’s branch
|
|
520
|
+
-c, --codecoverage calculate the code coverage by
|
|
521
|
+
running the packaged Apex tests
|
|
522
|
+
-d, --path=<value> path to directory that contains the
|
|
523
|
+
contents of the package
|
|
524
|
+
-e, --versiondescription=<value> the description of the package
|
|
525
|
+
version to be created
|
|
526
|
+
-f, --definitionfile=<value> path to a definition file similar to
|
|
527
|
+
scratch org definition file that
|
|
528
|
+
contains the list of features and
|
|
529
|
+
org preferences that the metadata of
|
|
530
|
+
the package version depends on
|
|
531
|
+
-k, --installationkey=<value> installation key for key-protected
|
|
532
|
+
package (either --installationkey or
|
|
533
|
+
--installationkeybypass is required)
|
|
534
|
+
-n, --versionnumber=<value> the version number of the package
|
|
535
|
+
version to be created
|
|
536
|
+
-p, --package=<value> ID (starts with 0Ho) or alias of the
|
|
537
|
+
package to create a version of
|
|
538
|
+
-t, --tag=<value> the package version’s tag
|
|
539
|
+
-v, --targetdevhubusername=<value> username or alias for the dev hub
|
|
540
|
+
org; overrides default dev hub org
|
|
541
|
+
-w, --wait=<value> [default: 0 minutes] minutes to wait
|
|
542
|
+
for the package version to be
|
|
543
|
+
created
|
|
544
|
+
-x, --installationkeybypass bypass the installation key
|
|
545
|
+
requirement (either
|
|
546
|
+
--installationkey or
|
|
547
|
+
--installationkeybypass is required)
|
|
548
|
+
--apiversion=<value> override the api version used for
|
|
549
|
+
api requests made by this command
|
|
550
|
+
--json format output as json
|
|
551
|
+
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
|
|
552
|
+
this command invocation
|
|
553
|
+
--postinstallscript=<value> post-install script name; managed
|
|
554
|
+
packages only
|
|
555
|
+
--postinstallurl=<value> post-install URL
|
|
556
|
+
--releasenotesurl=<value> release notes URL
|
|
557
|
+
--skipancestorcheck Overrides ancestry requirements.
|
|
558
|
+
--skipvalidation skip validation during package
|
|
559
|
+
version creation; you can’t promote
|
|
560
|
+
unvalidated package versions
|
|
561
|
+
--uninstallscript=<value> uninstall script name; managed
|
|
562
|
+
packages only
|
|
563
|
+
|
|
564
|
+
DESCRIPTION
|
|
565
|
+
create a package version
|
|
566
|
+
```
|
|
567
|
+
|
|
568
|
+
_See code: [src/commands/force/package/beta/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.1.1/src/commands/force/package/beta/version/create.ts)_
|
|
569
|
+
|
|
570
|
+
## `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]`
|
|
571
|
+
|
|
572
|
+
list package version creation requests
|
|
573
|
+
|
|
574
|
+
```
|
|
575
|
+
USAGE
|
|
576
|
+
$ sfdx force:package:beta:version:create:list [-c <number>] [-s Queued|InProgress|Success|Error] [-v <string>] [--apiversion <string>]
|
|
577
|
+
[--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
|
|
578
|
+
|
|
579
|
+
FLAGS
|
|
580
|
+
-c, --createdlastdays=<value> created in the last specified number
|
|
581
|
+
of days (starting at 00:00:00 of
|
|
582
|
+
first day to now; 0 for today)
|
|
583
|
+
-s, --status=(Queued|InProgress|Success|Error) filter the list by version creation
|
|
584
|
+
request status
|
|
585
|
+
-v, --targetdevhubusername=<value> username or alias for the dev hub
|
|
586
|
+
org; overrides default dev hub org
|
|
587
|
+
--apiversion=<value> override the api version used for
|
|
588
|
+
api requests made by this command
|
|
589
|
+
--json format output as json
|
|
590
|
+
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
|
|
591
|
+
this command invocation
|
|
592
|
+
|
|
593
|
+
DESCRIPTION
|
|
594
|
+
list package version creation requests
|
|
595
|
+
```
|
|
596
|
+
|
|
597
|
+
_See code: [src/commands/force/package/beta/version/create/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.1.1/src/commands/force/package/beta/version/create/list.ts)_
|
|
598
|
+
|
|
599
|
+
## `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]`
|
|
600
|
+
|
|
601
|
+
retrieve details about a package version creation request
|
|
602
|
+
|
|
603
|
+
```
|
|
604
|
+
USAGE
|
|
605
|
+
$ sfdx force:package:beta:version:create:report -i <id> [-v <string>] [--apiversion <string>] [--json] [--loglevel
|
|
606
|
+
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
|
|
607
|
+
|
|
608
|
+
FLAGS
|
|
609
|
+
-i, --packagecreaterequestid=<value> (required) package version creation
|
|
610
|
+
request ID (starts with 08c)
|
|
611
|
+
-v, --targetdevhubusername=<value> username or alias for the dev hub
|
|
612
|
+
org; overrides default dev hub org
|
|
613
|
+
--apiversion=<value> override the api version used for
|
|
614
|
+
api requests made by this command
|
|
615
|
+
--json format output as json
|
|
616
|
+
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
|
|
617
|
+
this command invocation
|
|
618
|
+
|
|
619
|
+
DESCRIPTION
|
|
620
|
+
retrieve details about a package version creation request
|
|
621
|
+
```
|
|
622
|
+
|
|
623
|
+
_See code: [src/commands/force/package/beta/version/create/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.1.1/src/commands/force/package/beta/version/create/report.ts)_
|
|
624
|
+
|
|
625
|
+
## `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]`
|
|
626
|
+
|
|
627
|
+
delete a package version
|
|
628
|
+
|
|
629
|
+
```
|
|
630
|
+
USAGE
|
|
631
|
+
$ sfdx force:package:beta:version:delete -p <string> [-n] [-v <string>] [--apiversion <string>] [--json] [--loglevel
|
|
632
|
+
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
|
|
633
|
+
|
|
634
|
+
FLAGS
|
|
635
|
+
-n, --noprompt don’t prompt before deleting the
|
|
636
|
+
package version
|
|
637
|
+
-p, --package=<value> (required) ID (starts with 04t) or
|
|
638
|
+
alias of the package to update a
|
|
639
|
+
version of
|
|
640
|
+
-v, --targetdevhubusername=<value> username or alias for the dev hub
|
|
641
|
+
org; overrides default dev hub org
|
|
642
|
+
--apiversion=<value> override the api version used for
|
|
643
|
+
api requests made by this command
|
|
644
|
+
--json format output as json
|
|
645
|
+
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
|
|
646
|
+
this command invocation
|
|
647
|
+
|
|
648
|
+
DESCRIPTION
|
|
649
|
+
delete a package version
|
|
650
|
+
```
|
|
75
651
|
|
|
76
|
-
|
|
652
|
+
_See code: [src/commands/force/package/beta/version/delete.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.1.1/src/commands/force/package/beta/version/delete.ts)_
|
|
77
653
|
|
|
78
|
-
|
|
654
|
+
## `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]`
|
|
655
|
+
|
|
656
|
+
display the ancestry tree for a 2GP managed package version
|
|
79
657
|
|
|
80
658
|
```
|
|
81
659
|
USAGE
|
|
82
|
-
$ sfdx force:package:
|
|
83
|
-
|
|
660
|
+
$ sfdx force:package:beta:version:displayancestry -p <string> [--dotcode] [-v <string>] [--apiversion <string>] [--verbose] [--json]
|
|
661
|
+
[--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
|
|
84
662
|
|
|
85
663
|
FLAGS
|
|
664
|
+
-p, --package=<value> (required) ID or alias of the
|
|
665
|
+
package (starts with 0Ho) or package
|
|
666
|
+
version (starts with 04t) to display
|
|
667
|
+
ancestry for
|
|
668
|
+
-v, --targetdevhubusername=<value> username or alias for the dev hub
|
|
669
|
+
org; overrides default dev hub org
|
|
670
|
+
--apiversion=<value> override the api version used for
|
|
671
|
+
api requests made by this command
|
|
672
|
+
--dotcode display the ancestry tree in DOT
|
|
673
|
+
code
|
|
86
674
|
--json format output as json
|
|
87
675
|
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
|
|
88
676
|
this command invocation
|
|
677
|
+
--verbose display both the package version ID
|
|
678
|
+
(starts with 04t) and the version
|
|
679
|
+
number (major.minor.patch.build) in
|
|
680
|
+
the ancestry tree
|
|
89
681
|
|
|
90
682
|
DESCRIPTION
|
|
91
|
-
|
|
683
|
+
display the ancestry tree for a 2GP managed package version
|
|
92
684
|
```
|
|
93
685
|
|
|
94
|
-
_See code: [src/commands/force/package/
|
|
686
|
+
_See code: [src/commands/force/package/beta/version/displayancestry.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.1.1/src/commands/force/package/beta/version/displayancestry.ts)_
|
|
687
|
+
|
|
688
|
+
## `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]`
|
|
95
689
|
|
|
96
|
-
|
|
690
|
+
list all package versions in the Dev Hub org
|
|
97
691
|
|
|
98
692
|
```
|
|
99
693
|
USAGE
|
|
100
|
-
$ sfdx version
|
|
694
|
+
$ sfdx force:package:beta:version:list [-c <number>] [-m <number>] [-p <array>] [-r] [-o <array>] [-v <string>] [--apiversion
|
|
695
|
+
<string>] [--concise] [--verbose] [--json] [--loglevel
|
|
696
|
+
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
|
|
697
|
+
|
|
698
|
+
FLAGS
|
|
699
|
+
-c, --createdlastdays=<value> created in the last specified number
|
|
700
|
+
of days (starting at 00:00:00 of
|
|
701
|
+
first day to now; 0 for today)
|
|
702
|
+
-m, --modifiedlastdays=<value> list items modified in the specified
|
|
703
|
+
last number of days (starting at
|
|
704
|
+
00:00:00 of first day to now; 0 for
|
|
705
|
+
today)
|
|
706
|
+
-o, --orderby=<value> order by the specified package
|
|
707
|
+
version fields
|
|
708
|
+
-p, --packages=<value> filter results on specified
|
|
709
|
+
comma-delimited packages (aliases or
|
|
710
|
+
0Ho IDs)
|
|
711
|
+
-r, --released display released versions only
|
|
712
|
+
-v, --targetdevhubusername=<value> username or alias for the dev hub
|
|
713
|
+
org; overrides default dev hub org
|
|
714
|
+
--apiversion=<value> override the api version used for
|
|
715
|
+
api requests made by this command
|
|
716
|
+
--concise display limited package version
|
|
717
|
+
details
|
|
718
|
+
--json format output as json
|
|
719
|
+
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
|
|
720
|
+
this command invocation
|
|
721
|
+
--verbose display extended package version
|
|
722
|
+
details
|
|
723
|
+
|
|
724
|
+
DESCRIPTION
|
|
725
|
+
list all package versions in the Dev Hub org
|
|
726
|
+
```
|
|
727
|
+
|
|
728
|
+
_See code: [src/commands/force/package/beta/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.1.1/src/commands/force/package/beta/version/list.ts)_
|
|
729
|
+
|
|
730
|
+
## `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]`
|
|
731
|
+
|
|
732
|
+
promote a package version to released
|
|
733
|
+
|
|
734
|
+
```
|
|
735
|
+
USAGE
|
|
736
|
+
$ sfdx force:package:beta:version:promote -p <string> [-n] [-v <string>] [--apiversion <string>] [--json] [--loglevel
|
|
737
|
+
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
|
|
738
|
+
|
|
739
|
+
FLAGS
|
|
740
|
+
-n, --noprompt no prompt to confirm setting the
|
|
741
|
+
package version as released
|
|
742
|
+
-p, --package=<value> (required) ID (starts with 04t) or
|
|
743
|
+
alias of the package version to
|
|
744
|
+
promote
|
|
745
|
+
-v, --targetdevhubusername=<value> username or alias for the dev hub
|
|
746
|
+
org; overrides default dev hub org
|
|
747
|
+
--apiversion=<value> override the api version used for
|
|
748
|
+
api requests made by this command
|
|
749
|
+
--json format output as json
|
|
750
|
+
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
|
|
751
|
+
this command invocation
|
|
752
|
+
|
|
753
|
+
DESCRIPTION
|
|
754
|
+
promote a package version to released
|
|
755
|
+
```
|
|
756
|
+
|
|
757
|
+
_See code: [src/commands/force/package/beta/version/promote.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.1.1/src/commands/force/package/beta/version/promote.ts)_
|
|
758
|
+
|
|
759
|
+
## `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]`
|
|
760
|
+
|
|
761
|
+
retrieve details about a package version in the Dev Hub org
|
|
762
|
+
|
|
763
|
+
```
|
|
764
|
+
USAGE
|
|
765
|
+
$ sfdx force:package:beta:version:report -p <string> [-v <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel
|
|
766
|
+
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
|
|
767
|
+
|
|
768
|
+
FLAGS
|
|
769
|
+
-p, --package=<value> (required) ID (starts with 04t) or
|
|
770
|
+
alias of the package to retrieve
|
|
771
|
+
details for
|
|
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
|
|
779
|
+
--verbose displays extended package version
|
|
780
|
+
details
|
|
781
|
+
|
|
782
|
+
DESCRIPTION
|
|
783
|
+
retrieve details about a package version in the Dev Hub org
|
|
784
|
+
```
|
|
785
|
+
|
|
786
|
+
_See code: [src/commands/force/package/beta/version/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.1.1/src/commands/force/package/beta/version/report.ts)_
|
|
787
|
+
|
|
788
|
+
## `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]`
|
|
789
|
+
|
|
790
|
+
update a package version
|
|
791
|
+
|
|
792
|
+
```
|
|
793
|
+
USAGE
|
|
794
|
+
$ sfdx force:package:beta:version:update -p <string> [-a <string>] [-e <string>] [-b <string>] [-t <string>] [-k <string>] [-v
|
|
795
|
+
<string>] [--apiversion <string>] [--json] [--loglevel
|
|
796
|
+
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
|
|
797
|
+
|
|
798
|
+
FLAGS
|
|
799
|
+
-a, --versionname=<value> new package version name
|
|
800
|
+
-b, --branch=<value> new package version branch
|
|
801
|
+
-e, --versiondescription=<value> new package version description
|
|
802
|
+
-k, --installationkey=<value> new installation key for
|
|
803
|
+
key-protected package (default:
|
|
804
|
+
null)
|
|
805
|
+
-p, --package=<value> (required) ID (starts with 04t) or
|
|
806
|
+
alias of the package to update a
|
|
807
|
+
version of
|
|
808
|
+
-t, --tag=<value> new package version tag
|
|
809
|
+
-v, --targetdevhubusername=<value> username or alias for the dev hub
|
|
810
|
+
org; overrides default dev hub org
|
|
811
|
+
--apiversion=<value> override the api version used for
|
|
812
|
+
api requests made by this command
|
|
813
|
+
--json format output as json
|
|
814
|
+
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
|
|
815
|
+
this command invocation
|
|
816
|
+
|
|
817
|
+
DESCRIPTION
|
|
818
|
+
update a package version
|
|
101
819
|
```
|
|
102
820
|
|
|
103
|
-
_See code: [
|
|
821
|
+
_See code: [src/commands/force/package/beta/version/update.ts](https://github.com/salesforcecli/plugin-packaging/blob/v1.1.1/src/commands/force/package/beta/version/update.ts)_
|
|
104
822
|
|
|
105
823
|
<!-- commandsstop -->
|