@salesforce/cli 2.43.1 → 2.43.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +295 -245
- package/npm-shrinkwrap.json +1327 -1706
- package/oclif.lock +1130 -1249
- package/oclif.manifest.json +1 -1
- package/package.json +14 -14
package/README.md
CHANGED
|
@@ -24,7 +24,7 @@ $ npm install -g @salesforce/cli
|
|
|
24
24
|
$ sf COMMAND
|
|
25
25
|
running command...
|
|
26
26
|
$ sf (--version|-v)
|
|
27
|
-
@salesforce/cli/2.43.
|
|
27
|
+
@salesforce/cli/2.43.3 linux-x64 node-v20.13.1
|
|
28
28
|
$ sf --help [COMMAND]
|
|
29
29
|
USAGE
|
|
30
30
|
$ sf COMMAND
|
|
@@ -59,6 +59,7 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI.
|
|
|
59
59
|
- [`sf config list`](#sf-config-list)
|
|
60
60
|
- [`sf config set`](#sf-config-set)
|
|
61
61
|
- [`sf config unset`](#sf-config-unset)
|
|
62
|
+
- [`sf data create file`](#sf-data-create-file)
|
|
62
63
|
- [`sf data create record`](#sf-data-create-record)
|
|
63
64
|
- [`sf data delete bulk`](#sf-data-delete-bulk)
|
|
64
65
|
- [`sf data delete record`](#sf-data-delete-record)
|
|
@@ -114,10 +115,6 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI.
|
|
|
114
115
|
- [`sf org refresh sandbox`](#sf-org-refresh-sandbox)
|
|
115
116
|
- [`sf org resume sandbox`](#sf-org-resume-sandbox)
|
|
116
117
|
- [`sf org resume scratch`](#sf-org-resume-scratch)
|
|
117
|
-
- [`sf package1 version create`](#sf-package1-version-create)
|
|
118
|
-
- [`sf package1 version create get`](#sf-package1-version-create-get)
|
|
119
|
-
- [`sf package1 version display`](#sf-package1-version-display)
|
|
120
|
-
- [`sf package1 version list`](#sf-package1-version-list)
|
|
121
118
|
- [`sf package create`](#sf-package-create)
|
|
122
119
|
- [`sf package delete`](#sf-package-delete)
|
|
123
120
|
- [`sf package install`](#sf-package-install)
|
|
@@ -136,6 +133,10 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI.
|
|
|
136
133
|
- [`sf package version promote`](#sf-package-version-promote)
|
|
137
134
|
- [`sf package version report`](#sf-package-version-report)
|
|
138
135
|
- [`sf package version update`](#sf-package-version-update)
|
|
136
|
+
- [`sf package1 version create`](#sf-package1-version-create)
|
|
137
|
+
- [`sf package1 version create get`](#sf-package1-version-create-get)
|
|
138
|
+
- [`sf package1 version display`](#sf-package1-version-display)
|
|
139
|
+
- [`sf package1 version list`](#sf-package1-version-list)
|
|
139
140
|
- [`sf plugins`](#sf-plugins)
|
|
140
141
|
- [`sf plugins discover`](#sf-plugins-discover)
|
|
141
142
|
- [`sf plugins:inspect PLUGIN...`](#sf-pluginsinspect-plugin)
|
|
@@ -1083,6 +1084,55 @@ CONFIGURATION VARIABLES
|
|
|
1083
1084
|
|
|
1084
1085
|
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.2.6/src/commands/config/unset.ts)_
|
|
1085
1086
|
|
|
1087
|
+
## `sf data create file`
|
|
1088
|
+
|
|
1089
|
+
Upload a local file to an org.
|
|
1090
|
+
|
|
1091
|
+
```
|
|
1092
|
+
USAGE
|
|
1093
|
+
$ sf data create file -o <value> -f <value> [--json] [--flags-dir <value>] [--api-version <value>] [-t <value>] [-i
|
|
1094
|
+
<value>]
|
|
1095
|
+
|
|
1096
|
+
FLAGS
|
|
1097
|
+
-f, --file=<value> (required) Path of file to upload.
|
|
1098
|
+
-i, --parent-id=<value> ID of the record to attach the file to.
|
|
1099
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
1100
|
+
configuration variable is already set.
|
|
1101
|
+
-t, --title=<value> New title given to the file (ContentDocument) after it's uploaded.
|
|
1102
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
1103
|
+
|
|
1104
|
+
GLOBAL FLAGS
|
|
1105
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1106
|
+
--json Format output as json.
|
|
1107
|
+
|
|
1108
|
+
DESCRIPTION
|
|
1109
|
+
Upload a local file to an org.
|
|
1110
|
+
|
|
1111
|
+
This command always creates a new file in the org; you can't update an existing file. After a successful upload, the
|
|
1112
|
+
command displays the ID of the new ContentDocument record which represents the uploaded file.
|
|
1113
|
+
|
|
1114
|
+
By default, the uploaded file isn't attached to a record; in the Salesforce UI the file shows up in the Files tab. You
|
|
1115
|
+
can optionally attach the file to an existing record, such as an account, as long as you know its record ID.
|
|
1116
|
+
|
|
1117
|
+
You can also give the file a new name after it's been uploaded; by default its name in the org is the same as the
|
|
1118
|
+
local file name.
|
|
1119
|
+
|
|
1120
|
+
EXAMPLES
|
|
1121
|
+
Upload the local file "resources/astro.png" to your default org:
|
|
1122
|
+
|
|
1123
|
+
$ sf data create file --file resources/astro.png
|
|
1124
|
+
|
|
1125
|
+
Give the file a different filename after it's uploaded to the org with alias "my-scratch":
|
|
1126
|
+
|
|
1127
|
+
$ sf data create file --file resources/astro.png --title AstroOnABoat.png --target-org my-scratch
|
|
1128
|
+
|
|
1129
|
+
Attach the file to a record in the org:
|
|
1130
|
+
|
|
1131
|
+
$ sf data create file --file path/to/astro.png --parent-id a03fakeLoJWPIA3
|
|
1132
|
+
```
|
|
1133
|
+
|
|
1134
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.0/src/commands/data/create/file.ts)_
|
|
1135
|
+
|
|
1086
1136
|
## `sf data create record`
|
|
1087
1137
|
|
|
1088
1138
|
Create and insert a record into a Salesforce or Tooling API object.
|
|
@@ -1137,7 +1187,7 @@ EXAMPLES
|
|
|
1137
1187
|
TracedEntityId=01p17000000R6bLAAS"
|
|
1138
1188
|
```
|
|
1139
1189
|
|
|
1140
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.
|
|
1190
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.0/src/commands/data/create/record.ts)_
|
|
1141
1191
|
|
|
1142
1192
|
## `sf data delete bulk`
|
|
1143
1193
|
|
|
@@ -1184,7 +1234,7 @@ EXAMPLES
|
|
|
1184
1234
|
$ sf data delete bulk --sobject MyObject__c --file files/delete.csv --wait 5 --target-org my-scratch
|
|
1185
1235
|
```
|
|
1186
1236
|
|
|
1187
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.
|
|
1237
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.0/src/commands/data/delete/bulk.ts)_
|
|
1188
1238
|
|
|
1189
1239
|
## `sf data delete record`
|
|
1190
1240
|
|
|
@@ -1245,7 +1295,7 @@ EXAMPLES
|
|
|
1245
1295
|
$ sf data delete record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
|
|
1246
1296
|
```
|
|
1247
1297
|
|
|
1248
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.
|
|
1298
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.0/src/commands/data/delete/record.ts)_
|
|
1249
1299
|
|
|
1250
1300
|
## `sf data delete resume`
|
|
1251
1301
|
|
|
@@ -1284,7 +1334,7 @@ EXAMPLES
|
|
|
1284
1334
|
$ sf data delete resume --use-most-recent --target-org my-scratch
|
|
1285
1335
|
```
|
|
1286
1336
|
|
|
1287
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.
|
|
1337
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.0/src/commands/data/delete/resume.ts)_
|
|
1288
1338
|
|
|
1289
1339
|
## `sf data export beta tree`
|
|
1290
1340
|
|
|
@@ -1342,7 +1392,7 @@ EXAMPLES
|
|
|
1342
1392
|
my-scratch
|
|
1343
1393
|
```
|
|
1344
1394
|
|
|
1345
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.
|
|
1395
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.0/src/commands/data/export/beta/tree.ts)_
|
|
1346
1396
|
|
|
1347
1397
|
## `sf data export tree`
|
|
1348
1398
|
|
|
@@ -1402,7 +1452,7 @@ EXAMPLES
|
|
|
1402
1452
|
my-scratch
|
|
1403
1453
|
```
|
|
1404
1454
|
|
|
1405
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.
|
|
1455
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.0/src/commands/data/export/tree.ts)_
|
|
1406
1456
|
|
|
1407
1457
|
## `sf data get record`
|
|
1408
1458
|
|
|
@@ -1466,7 +1516,7 @@ EXAMPLES
|
|
|
1466
1516
|
$ sf data get record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
|
|
1467
1517
|
```
|
|
1468
1518
|
|
|
1469
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.
|
|
1519
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.0/src/commands/data/get/record.ts)_
|
|
1470
1520
|
|
|
1471
1521
|
## `sf data import beta tree`
|
|
1472
1522
|
|
|
@@ -1509,7 +1559,7 @@ EXAMPLES
|
|
|
1509
1559
|
$ sf data import beta tree --plan Account-Contact-plan.json
|
|
1510
1560
|
```
|
|
1511
1561
|
|
|
1512
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.
|
|
1562
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.0/src/commands/data/import/beta/tree.ts)_
|
|
1513
1563
|
|
|
1514
1564
|
## `sf data import tree`
|
|
1515
1565
|
|
|
@@ -1559,7 +1609,7 @@ EXAMPLES
|
|
|
1559
1609
|
$ sf data import tree --plan Account-Contact-plan.json
|
|
1560
1610
|
```
|
|
1561
1611
|
|
|
1562
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.
|
|
1612
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.0/src/commands/data/import/tree.ts)_
|
|
1563
1613
|
|
|
1564
1614
|
## `sf data query`
|
|
1565
1615
|
|
|
@@ -1623,7 +1673,7 @@ EXAMPLES
|
|
|
1623
1673
|
$ sf data query --query "SELECT Id FROM Contact" --bulk --wait 0
|
|
1624
1674
|
```
|
|
1625
1675
|
|
|
1626
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.
|
|
1676
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.0/src/commands/data/query.ts)_
|
|
1627
1677
|
|
|
1628
1678
|
## `sf data query resume`
|
|
1629
1679
|
|
|
@@ -1661,7 +1711,7 @@ EXAMPLES
|
|
|
1661
1711
|
$ sf data query resume --bulk-query-id 7500x000005BdFzXXX
|
|
1662
1712
|
```
|
|
1663
1713
|
|
|
1664
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.
|
|
1714
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.0/src/commands/data/query/resume.ts)_
|
|
1665
1715
|
|
|
1666
1716
|
## `sf data resume`
|
|
1667
1717
|
|
|
@@ -1698,7 +1748,7 @@ EXAMPLES
|
|
|
1698
1748
|
$ sf data resume --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA
|
|
1699
1749
|
```
|
|
1700
1750
|
|
|
1701
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.
|
|
1751
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.0/src/commands/data/resume.ts)_
|
|
1702
1752
|
|
|
1703
1753
|
## `sf data update record`
|
|
1704
1754
|
|
|
@@ -1760,7 +1810,7 @@ EXAMPLES
|
|
|
1760
1810
|
"ExpirationDate=2017-12-01T00:58:04.000+0000"
|
|
1761
1811
|
```
|
|
1762
1812
|
|
|
1763
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.
|
|
1813
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.0/src/commands/data/update/record.ts)_
|
|
1764
1814
|
|
|
1765
1815
|
## `sf data upsert bulk`
|
|
1766
1816
|
|
|
@@ -1813,7 +1863,7 @@ EXAMPLES
|
|
|
1813
1863
|
my-scratch
|
|
1814
1864
|
```
|
|
1815
1865
|
|
|
1816
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.
|
|
1866
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.0/src/commands/data/upsert/bulk.ts)_
|
|
1817
1867
|
|
|
1818
1868
|
## `sf data upsert resume`
|
|
1819
1869
|
|
|
@@ -1852,7 +1902,7 @@ EXAMPLES
|
|
|
1852
1902
|
$ sf data upsert resume --use-most-recent --target-org my-scratch
|
|
1853
1903
|
```
|
|
1854
1904
|
|
|
1855
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.
|
|
1905
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.0/src/commands/data/upsert/resume.ts)_
|
|
1856
1906
|
|
|
1857
1907
|
## `sf doctor`
|
|
1858
1908
|
|
|
@@ -1947,7 +1997,7 @@ EXAMPLES
|
|
|
1947
1997
|
$ sf force data bulk delete --sobject MyObject__c --file files/delete.csv --wait 5 --target-org my-scratch
|
|
1948
1998
|
```
|
|
1949
1999
|
|
|
1950
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.
|
|
2000
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.0/src/commands/force/data/bulk/delete.ts)_
|
|
1951
2001
|
|
|
1952
2002
|
## `sf force data bulk status`
|
|
1953
2003
|
|
|
@@ -1984,7 +2034,7 @@ EXAMPLES
|
|
|
1984
2034
|
$ sf force data bulk status --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA --target-org my-scratch
|
|
1985
2035
|
```
|
|
1986
2036
|
|
|
1987
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.
|
|
2037
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.0/src/commands/force/data/bulk/status.ts)_
|
|
1988
2038
|
|
|
1989
2039
|
## `sf force data bulk upsert`
|
|
1990
2040
|
|
|
@@ -2042,7 +2092,7 @@ EXAMPLES
|
|
|
2042
2092
|
--target-org my-scratch
|
|
2043
2093
|
```
|
|
2044
2094
|
|
|
2045
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.
|
|
2095
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.0/src/commands/force/data/bulk/upsert.ts)_
|
|
2046
2096
|
|
|
2047
2097
|
## `sf help [COMMAND]`
|
|
2048
2098
|
|
|
@@ -3251,7 +3301,7 @@ EXAMPLES
|
|
|
3251
3301
|
$ sf org list auth
|
|
3252
3302
|
```
|
|
3253
3303
|
|
|
3254
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.
|
|
3304
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.12/src/commands/org/list/auth.ts)_
|
|
3255
3305
|
|
|
3256
3306
|
## `sf org list limits`
|
|
3257
3307
|
|
|
@@ -3551,7 +3601,7 @@ FLAG DESCRIPTIONS
|
|
|
3551
3601
|
To specify a sandbox, set --instance-url to "https://<MyDomainName>--<SandboxName>.sandbox.my.salesforce.com".
|
|
3552
3602
|
```
|
|
3553
3603
|
|
|
3554
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.
|
|
3604
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.12/src/commands/org/login/access-token.ts)_
|
|
3555
3605
|
|
|
3556
3606
|
## `sf org login device`
|
|
3557
3607
|
|
|
@@ -3611,7 +3661,7 @@ FLAG DESCRIPTIONS
|
|
|
3611
3661
|
To specify a sandbox, set --instance-url to "https://<MyDomainName>--<SandboxName>.sandbox.my.salesforce.com".
|
|
3612
3662
|
```
|
|
3613
3663
|
|
|
3614
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.
|
|
3664
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.12/src/commands/org/login/device.ts)_
|
|
3615
3665
|
|
|
3616
3666
|
## `sf org login jwt`
|
|
3617
3667
|
|
|
@@ -3702,7 +3752,7 @@ FLAG DESCRIPTIONS
|
|
|
3702
3752
|
To specify a sandbox, set --instance-url to "https://<MyDomainName>--<SandboxName>.sandbox.my.salesforce.com".
|
|
3703
3753
|
```
|
|
3704
3754
|
|
|
3705
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.
|
|
3755
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.12/src/commands/org/login/jwt.ts)_
|
|
3706
3756
|
|
|
3707
3757
|
## `sf org login sfdx-url`
|
|
3708
3758
|
|
|
@@ -3767,7 +3817,7 @@ EXAMPLES
|
|
|
3767
3817
|
$ echo url | sf org login sfdx-url --sfdx-url-stdin
|
|
3768
3818
|
```
|
|
3769
3819
|
|
|
3770
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.
|
|
3820
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.12/src/commands/org/login/sfdx-url.ts)_
|
|
3771
3821
|
|
|
3772
3822
|
## `sf org login web`
|
|
3773
3823
|
|
|
@@ -3854,7 +3904,7 @@ FLAG DESCRIPTIONS
|
|
|
3854
3904
|
To specify a sandbox, set --instance-url to "https://<MyDomainName>--<SandboxName>.sandbox.my.salesforce.com".
|
|
3855
3905
|
```
|
|
3856
3906
|
|
|
3857
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.
|
|
3907
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.12/src/commands/org/login/web.ts)_
|
|
3858
3908
|
|
|
3859
3909
|
## `sf org logout`
|
|
3860
3910
|
|
|
@@ -3915,7 +3965,7 @@ FLAG DESCRIPTIONS
|
|
|
3915
3965
|
All orgs includes Dev Hubs, sandboxes, DE orgs, and expired, deleted, and unknown-status scratch orgs.
|
|
3916
3966
|
```
|
|
3917
3967
|
|
|
3918
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.
|
|
3968
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.12/src/commands/org/logout.ts)_
|
|
3919
3969
|
|
|
3920
3970
|
## `sf org open`
|
|
3921
3971
|
|
|
@@ -4176,178 +4226,6 @@ FLAG DESCRIPTIONS
|
|
|
4176
4226
|
|
|
4177
4227
|
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.1.10/src/commands/org/resume/scratch.ts)_
|
|
4178
4228
|
|
|
4179
|
-
## `sf package1 version create`
|
|
4180
|
-
|
|
4181
|
-
Create a first-generation package version in the release org.
|
|
4182
|
-
|
|
4183
|
-
```
|
|
4184
|
-
USAGE
|
|
4185
|
-
$ sf package1 version create -o <value> -i <value> -n <value> [--json] [--flags-dir <value>] [--api-version <value>] [-d
|
|
4186
|
-
<value>] [-v <value>] [-m] [-r <value>] [-p <value>] [-k <value>] [-w <value>]
|
|
4187
|
-
|
|
4188
|
-
FLAGS
|
|
4189
|
-
-d, --description=<value> Package version description.
|
|
4190
|
-
-i, --package-id=<value> (required) ID of the metadata package (starts with 033) of which you’re creating a
|
|
4191
|
-
new version.
|
|
4192
|
-
-k, --installation-key=<value> Installation key for key-protected package (default: null).
|
|
4193
|
-
-m, --managed-released Create a managed package version.
|
|
4194
|
-
-n, --name=<value> (required) Package version name.
|
|
4195
|
-
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
4196
|
-
configuration variable is already set.
|
|
4197
|
-
-p, --post-install-url=<value> Post install URL.
|
|
4198
|
-
-r, --release-notes-url=<value> Release notes URL.
|
|
4199
|
-
-v, --version=<value> Package version in major.minor format, for example, 3.2.
|
|
4200
|
-
-w, --wait=<value> Minutes to wait for the package version to be created (default: 2 minutes).
|
|
4201
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
4202
|
-
|
|
4203
|
-
GLOBAL FLAGS
|
|
4204
|
-
--flags-dir=<value> Import flag values from a directory.
|
|
4205
|
-
--json Format output as json.
|
|
4206
|
-
|
|
4207
|
-
DESCRIPTION
|
|
4208
|
-
Create a first-generation package version in the release org.
|
|
4209
|
-
|
|
4210
|
-
The package version is based on the contents of the specified metadata package. Omit --managed-released if you want to
|
|
4211
|
-
create an unmanaged package version.
|
|
4212
|
-
|
|
4213
|
-
ALIASES
|
|
4214
|
-
$ sf force package1 version create
|
|
4215
|
-
|
|
4216
|
-
EXAMPLES
|
|
4217
|
-
Create a first-generation package version from the package with the specified ID and name the package version
|
|
4218
|
-
"example"; use your default org:
|
|
4219
|
-
|
|
4220
|
-
$ sf package1 version create --package-id 033... --name example
|
|
4221
|
-
|
|
4222
|
-
Same as previous example, but provide a description and wait for 30 minutes for the package version to be created;
|
|
4223
|
-
use the specified org:
|
|
4224
|
-
|
|
4225
|
-
$ sf package1 version create --package-id 033... --name example --description "example description" --wait 30 \
|
|
4226
|
-
--target-org myorg@example.com
|
|
4227
|
-
|
|
4228
|
-
FLAG DESCRIPTIONS
|
|
4229
|
-
-m, --managed-released Create a managed package version.
|
|
4230
|
-
|
|
4231
|
-
To create a beta version, don’t include this parameter.
|
|
4232
|
-
|
|
4233
|
-
-p, --post-install-url=<value> Post install URL.
|
|
4234
|
-
|
|
4235
|
-
The contents of the post-installation instructions URL are displayed in the UI after installation of the package
|
|
4236
|
-
version.
|
|
4237
|
-
|
|
4238
|
-
-r, --release-notes-url=<value> Release notes URL.
|
|
4239
|
-
|
|
4240
|
-
This link is displayed in the package installation UI to provide release notes for this package version to
|
|
4241
|
-
subscribers.
|
|
4242
|
-
```
|
|
4243
|
-
|
|
4244
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.4/src/commands/package1/version/create.ts)_
|
|
4245
|
-
|
|
4246
|
-
## `sf package1 version create get`
|
|
4247
|
-
|
|
4248
|
-
Retrieve the status of a package version creation request.
|
|
4249
|
-
|
|
4250
|
-
```
|
|
4251
|
-
USAGE
|
|
4252
|
-
$ sf package1 version create get -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
4253
|
-
|
|
4254
|
-
FLAGS
|
|
4255
|
-
-i, --request-id=<value> (required) ID of the PackageUploadRequest (starts with 0HD).
|
|
4256
|
-
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
4257
|
-
configuration variable is already set.
|
|
4258
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
4259
|
-
|
|
4260
|
-
GLOBAL FLAGS
|
|
4261
|
-
--flags-dir=<value> Import flag values from a directory.
|
|
4262
|
-
--json Format output as json.
|
|
4263
|
-
|
|
4264
|
-
ALIASES
|
|
4265
|
-
$ sf force package1 version create get
|
|
4266
|
-
|
|
4267
|
-
EXAMPLES
|
|
4268
|
-
Get the status of the creation request for the package version with the specified ID in your default org:
|
|
4269
|
-
|
|
4270
|
-
$ sf package1 version create get --request-id 0HD...
|
|
4271
|
-
|
|
4272
|
-
Same as previous example, but use the specified org:
|
|
4273
|
-
|
|
4274
|
-
$ sf package1 version create get --request-id 0HD... --target-org myorg@example.com
|
|
4275
|
-
```
|
|
4276
|
-
|
|
4277
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.4/src/commands/package1/version/create/get.ts)_
|
|
4278
|
-
|
|
4279
|
-
## `sf package1 version display`
|
|
4280
|
-
|
|
4281
|
-
Display details about a first-generation package version.
|
|
4282
|
-
|
|
4283
|
-
```
|
|
4284
|
-
USAGE
|
|
4285
|
-
$ sf package1 version display -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
4286
|
-
|
|
4287
|
-
FLAGS
|
|
4288
|
-
-i, --package-version-id=<value> (required) ID (starts with 04t) of the metadata package version whose details you
|
|
4289
|
-
want to display.
|
|
4290
|
-
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
4291
|
-
configuration variable is already set.
|
|
4292
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
4293
|
-
|
|
4294
|
-
GLOBAL FLAGS
|
|
4295
|
-
--flags-dir=<value> Import flag values from a directory.
|
|
4296
|
-
--json Format output as json.
|
|
4297
|
-
|
|
4298
|
-
ALIASES
|
|
4299
|
-
$ sf force package1 version display
|
|
4300
|
-
|
|
4301
|
-
EXAMPLES
|
|
4302
|
-
Display details about the first-generation package version with the specified ID in your default org:
|
|
4303
|
-
|
|
4304
|
-
$ sf package1 version display --package-version-id 04t...
|
|
4305
|
-
|
|
4306
|
-
Same as previous example, but use the specified org:
|
|
4307
|
-
|
|
4308
|
-
$ sf package1 version display --package-version-id 04t... --target-org myorg@example.com
|
|
4309
|
-
```
|
|
4310
|
-
|
|
4311
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.4/src/commands/package1/version/display.ts)_
|
|
4312
|
-
|
|
4313
|
-
## `sf package1 version list`
|
|
4314
|
-
|
|
4315
|
-
List package versions for the specified first-generation package or for the org.
|
|
4316
|
-
|
|
4317
|
-
```
|
|
4318
|
-
USAGE
|
|
4319
|
-
$ sf package1 version list -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-i <value>]
|
|
4320
|
-
|
|
4321
|
-
FLAGS
|
|
4322
|
-
-i, --package-id=<value> Metadata package ID (starts with 033) whose package versions you want to list.
|
|
4323
|
-
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
4324
|
-
configuration variable is already set.
|
|
4325
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
4326
|
-
|
|
4327
|
-
GLOBAL FLAGS
|
|
4328
|
-
--flags-dir=<value> Import flag values from a directory.
|
|
4329
|
-
--json Format output as json.
|
|
4330
|
-
|
|
4331
|
-
ALIASES
|
|
4332
|
-
$ sf force package1 version list
|
|
4333
|
-
|
|
4334
|
-
EXAMPLES
|
|
4335
|
-
List all first-generation package versions in your default org:
|
|
4336
|
-
|
|
4337
|
-
$ sf package1 version list
|
|
4338
|
-
|
|
4339
|
-
List package versions for the specified first-generation package in the specifief org:
|
|
4340
|
-
|
|
4341
|
-
$ sf package1 version list --package-id 033... --target-org myorg@example.com
|
|
4342
|
-
|
|
4343
|
-
FLAG DESCRIPTIONS
|
|
4344
|
-
-i, --package-id=<value> Metadata package ID (starts with 033) whose package versions you want to list.
|
|
4345
|
-
|
|
4346
|
-
If not specified, shows all versions for all packages (managed and unmanaged) in the org.
|
|
4347
|
-
```
|
|
4348
|
-
|
|
4349
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.4/src/commands/package1/version/list.ts)_
|
|
4350
|
-
|
|
4351
4229
|
## `sf package create`
|
|
4352
4230
|
|
|
4353
4231
|
Create a package.
|
|
@@ -4425,7 +4303,7 @@ FLAG DESCRIPTIONS
|
|
|
4425
4303
|
Org-Dependent Unlocked Packages" in the Salesforce DX Developer Guide.
|
|
4426
4304
|
```
|
|
4427
4305
|
|
|
4428
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
4306
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package/create.ts)_
|
|
4429
4307
|
|
|
4430
4308
|
## `sf package delete`
|
|
4431
4309
|
|
|
@@ -4467,7 +4345,7 @@ EXAMPLES
|
|
|
4467
4345
|
$ sf package delete --package 0Ho... --target-dev-hub devhub@example.com
|
|
4468
4346
|
```
|
|
4469
4347
|
|
|
4470
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
4348
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package/delete.ts)_
|
|
4471
4349
|
|
|
4472
4350
|
## `sf package install`
|
|
4473
4351
|
|
|
@@ -4565,7 +4443,7 @@ FLAG DESCRIPTIONS
|
|
|
4565
4443
|
specify DeprecateOnly or Delete only for unlocked package upgrades.
|
|
4566
4444
|
```
|
|
4567
4445
|
|
|
4568
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
4446
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package/install.ts)_
|
|
4569
4447
|
|
|
4570
4448
|
## `sf package install report`
|
|
4571
4449
|
|
|
@@ -4598,7 +4476,7 @@ EXAMPLES
|
|
|
4598
4476
|
$ sf package install report --request-id 0Hf... --target-org me@example.com
|
|
4599
4477
|
```
|
|
4600
4478
|
|
|
4601
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
4479
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package/install/report.ts)_
|
|
4602
4480
|
|
|
4603
4481
|
## `sf package installed list`
|
|
4604
4482
|
|
|
@@ -4630,7 +4508,7 @@ EXAMPLES
|
|
|
4630
4508
|
$ sf package installed list --target-org me@example.com
|
|
4631
4509
|
```
|
|
4632
4510
|
|
|
4633
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
4511
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package/installed/list.ts)_
|
|
4634
4512
|
|
|
4635
4513
|
## `sf package list`
|
|
4636
4514
|
|
|
@@ -4668,7 +4546,7 @@ EXAMPLES
|
|
|
4668
4546
|
$ sf package list --target-dev-hub devhub@example.com --verbose
|
|
4669
4547
|
```
|
|
4670
4548
|
|
|
4671
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
4549
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package/list.ts)_
|
|
4672
4550
|
|
|
4673
4551
|
## `sf package uninstall`
|
|
4674
4552
|
|
|
@@ -4716,7 +4594,7 @@ EXAMPLES
|
|
|
4716
4594
|
$ sf package uninstall --package "Undesirable Package Alias"
|
|
4717
4595
|
```
|
|
4718
4596
|
|
|
4719
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
4597
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package/uninstall.ts)_
|
|
4720
4598
|
|
|
4721
4599
|
## `sf package uninstall report`
|
|
4722
4600
|
|
|
@@ -4749,7 +4627,7 @@ EXAMPLES
|
|
|
4749
4627
|
$ sf package uninstall report --request-id 06y... --target-org me@example.com
|
|
4750
4628
|
```
|
|
4751
4629
|
|
|
4752
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
4630
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package/uninstall/report.ts)_
|
|
4753
4631
|
|
|
4754
4632
|
## `sf package update`
|
|
4755
4633
|
|
|
@@ -4804,7 +4682,7 @@ FLAG DESCRIPTIONS
|
|
|
4804
4682
|
associated with your package.
|
|
4805
4683
|
```
|
|
4806
4684
|
|
|
4807
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
4685
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package/update.ts)_
|
|
4808
4686
|
|
|
4809
4687
|
## `sf package version create`
|
|
4810
4688
|
|
|
@@ -4959,7 +4837,7 @@ FLAG DESCRIPTIONS
|
|
|
4959
4837
|
periods of no output from commands.
|
|
4960
4838
|
```
|
|
4961
4839
|
|
|
4962
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
4840
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package/version/create.ts)_
|
|
4963
4841
|
|
|
4964
4842
|
## `sf package version create list`
|
|
4965
4843
|
|
|
@@ -5020,7 +4898,7 @@ EXAMPLES
|
|
|
5020
4898
|
$ sf package version create list --created-last-days 0 --status Success
|
|
5021
4899
|
```
|
|
5022
4900
|
|
|
5023
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
4901
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package/version/create/list.ts)_
|
|
5024
4902
|
|
|
5025
4903
|
## `sf package version create report`
|
|
5026
4904
|
|
|
@@ -5063,7 +4941,7 @@ EXAMPLES
|
|
|
5063
4941
|
$ sf package version create report --package-create-request-id 08c... --target-dev-hub devhub@example.com
|
|
5064
4942
|
```
|
|
5065
4943
|
|
|
5066
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
4944
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package/version/create/report.ts)_
|
|
5067
4945
|
|
|
5068
4946
|
## `sf package version delete`
|
|
5069
4947
|
|
|
@@ -5102,7 +4980,7 @@ EXAMPLES
|
|
|
5102
4980
|
$ sf package version delete --package 04t... --target-org devhub@example.com
|
|
5103
4981
|
```
|
|
5104
4982
|
|
|
5105
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
4983
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package/version/delete.ts)_
|
|
5106
4984
|
|
|
5107
4985
|
## `sf package version displayancestry`
|
|
5108
4986
|
|
|
@@ -5162,7 +5040,7 @@ FLAG DESCRIPTIONS
|
|
|
5162
5040
|
You can use the DOT code output in graph visualization software to create tree visualizations.
|
|
5163
5041
|
```
|
|
5164
5042
|
|
|
5165
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
5043
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package/version/displayancestry.ts)_
|
|
5166
5044
|
|
|
5167
5045
|
## `sf package version list`
|
|
5168
5046
|
|
|
@@ -5231,7 +5109,7 @@ EXAMPLES
|
|
|
5231
5109
|
$ sf package version list --packages exp-mgr,exp-mgr-util --released --modified-last-days 0
|
|
5232
5110
|
```
|
|
5233
5111
|
|
|
5234
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
5112
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package/version/list.ts)_
|
|
5235
5113
|
|
|
5236
5114
|
## `sf package version promote`
|
|
5237
5115
|
|
|
@@ -5275,7 +5153,7 @@ EXAMPLES
|
|
|
5275
5153
|
$ sf package version promote --package "Awesome Package Alias"
|
|
5276
5154
|
```
|
|
5277
5155
|
|
|
5278
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
5156
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package/version/promote.ts)_
|
|
5279
5157
|
|
|
5280
5158
|
## `sf package version report`
|
|
5281
5159
|
|
|
@@ -5315,7 +5193,7 @@ EXAMPLES
|
|
|
5315
5193
|
$ sf package version report --package "Your Package Alias" --target-dev-hub devhub@example.com
|
|
5316
5194
|
```
|
|
5317
5195
|
|
|
5318
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
5196
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package/version/report.ts)_
|
|
5319
5197
|
|
|
5320
5198
|
## `sf package version update`
|
|
5321
5199
|
|
|
@@ -5368,7 +5246,179 @@ EXAMPLES
|
|
|
5368
5246
|
$ sf package version update --package 04t... --version-description "New Package Version Description"
|
|
5369
5247
|
```
|
|
5370
5248
|
|
|
5371
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
5249
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package/version/update.ts)_
|
|
5250
|
+
|
|
5251
|
+
## `sf package1 version create`
|
|
5252
|
+
|
|
5253
|
+
Create a first-generation package version in the release org.
|
|
5254
|
+
|
|
5255
|
+
```
|
|
5256
|
+
USAGE
|
|
5257
|
+
$ sf package1 version create -o <value> -i <value> -n <value> [--json] [--flags-dir <value>] [--api-version <value>] [-d
|
|
5258
|
+
<value>] [-v <value>] [-m] [-r <value>] [-p <value>] [-k <value>] [-w <value>]
|
|
5259
|
+
|
|
5260
|
+
FLAGS
|
|
5261
|
+
-d, --description=<value> Package version description.
|
|
5262
|
+
-i, --package-id=<value> (required) ID of the metadata package (starts with 033) of which you’re creating a
|
|
5263
|
+
new version.
|
|
5264
|
+
-k, --installation-key=<value> Installation key for key-protected package (default: null).
|
|
5265
|
+
-m, --managed-released Create a managed package version.
|
|
5266
|
+
-n, --name=<value> (required) Package version name.
|
|
5267
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
5268
|
+
configuration variable is already set.
|
|
5269
|
+
-p, --post-install-url=<value> Post install URL.
|
|
5270
|
+
-r, --release-notes-url=<value> Release notes URL.
|
|
5271
|
+
-v, --version=<value> Package version in major.minor format, for example, 3.2.
|
|
5272
|
+
-w, --wait=<value> Minutes to wait for the package version to be created (default: 2 minutes).
|
|
5273
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
5274
|
+
|
|
5275
|
+
GLOBAL FLAGS
|
|
5276
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
5277
|
+
--json Format output as json.
|
|
5278
|
+
|
|
5279
|
+
DESCRIPTION
|
|
5280
|
+
Create a first-generation package version in the release org.
|
|
5281
|
+
|
|
5282
|
+
The package version is based on the contents of the specified metadata package. Omit --managed-released if you want to
|
|
5283
|
+
create an unmanaged package version.
|
|
5284
|
+
|
|
5285
|
+
ALIASES
|
|
5286
|
+
$ sf force package1 version create
|
|
5287
|
+
|
|
5288
|
+
EXAMPLES
|
|
5289
|
+
Create a first-generation package version from the package with the specified ID and name the package version
|
|
5290
|
+
"example"; use your default org:
|
|
5291
|
+
|
|
5292
|
+
$ sf package1 version create --package-id 033... --name example
|
|
5293
|
+
|
|
5294
|
+
Same as previous example, but provide a description and wait for 30 minutes for the package version to be created;
|
|
5295
|
+
use the specified org:
|
|
5296
|
+
|
|
5297
|
+
$ sf package1 version create --package-id 033... --name example --description "example description" --wait 30 \
|
|
5298
|
+
--target-org myorg@example.com
|
|
5299
|
+
|
|
5300
|
+
FLAG DESCRIPTIONS
|
|
5301
|
+
-m, --managed-released Create a managed package version.
|
|
5302
|
+
|
|
5303
|
+
To create a beta version, don’t include this parameter.
|
|
5304
|
+
|
|
5305
|
+
-p, --post-install-url=<value> Post install URL.
|
|
5306
|
+
|
|
5307
|
+
The contents of the post-installation instructions URL are displayed in the UI after installation of the package
|
|
5308
|
+
version.
|
|
5309
|
+
|
|
5310
|
+
-r, --release-notes-url=<value> Release notes URL.
|
|
5311
|
+
|
|
5312
|
+
This link is displayed in the package installation UI to provide release notes for this package version to
|
|
5313
|
+
subscribers.
|
|
5314
|
+
```
|
|
5315
|
+
|
|
5316
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package1/version/create.ts)_
|
|
5317
|
+
|
|
5318
|
+
## `sf package1 version create get`
|
|
5319
|
+
|
|
5320
|
+
Retrieve the status of a package version creation request.
|
|
5321
|
+
|
|
5322
|
+
```
|
|
5323
|
+
USAGE
|
|
5324
|
+
$ sf package1 version create get -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
5325
|
+
|
|
5326
|
+
FLAGS
|
|
5327
|
+
-i, --request-id=<value> (required) ID of the PackageUploadRequest (starts with 0HD).
|
|
5328
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
5329
|
+
configuration variable is already set.
|
|
5330
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
5331
|
+
|
|
5332
|
+
GLOBAL FLAGS
|
|
5333
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
5334
|
+
--json Format output as json.
|
|
5335
|
+
|
|
5336
|
+
ALIASES
|
|
5337
|
+
$ sf force package1 version create get
|
|
5338
|
+
|
|
5339
|
+
EXAMPLES
|
|
5340
|
+
Get the status of the creation request for the package version with the specified ID in your default org:
|
|
5341
|
+
|
|
5342
|
+
$ sf package1 version create get --request-id 0HD...
|
|
5343
|
+
|
|
5344
|
+
Same as previous example, but use the specified org:
|
|
5345
|
+
|
|
5346
|
+
$ sf package1 version create get --request-id 0HD... --target-org myorg@example.com
|
|
5347
|
+
```
|
|
5348
|
+
|
|
5349
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package1/version/create/get.ts)_
|
|
5350
|
+
|
|
5351
|
+
## `sf package1 version display`
|
|
5352
|
+
|
|
5353
|
+
Display details about a first-generation package version.
|
|
5354
|
+
|
|
5355
|
+
```
|
|
5356
|
+
USAGE
|
|
5357
|
+
$ sf package1 version display -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
5358
|
+
|
|
5359
|
+
FLAGS
|
|
5360
|
+
-i, --package-version-id=<value> (required) ID (starts with 04t) of the metadata package version whose details you
|
|
5361
|
+
want to display.
|
|
5362
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
5363
|
+
configuration variable is already set.
|
|
5364
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
5365
|
+
|
|
5366
|
+
GLOBAL FLAGS
|
|
5367
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
5368
|
+
--json Format output as json.
|
|
5369
|
+
|
|
5370
|
+
ALIASES
|
|
5371
|
+
$ sf force package1 version display
|
|
5372
|
+
|
|
5373
|
+
EXAMPLES
|
|
5374
|
+
Display details about the first-generation package version with the specified ID in your default org:
|
|
5375
|
+
|
|
5376
|
+
$ sf package1 version display --package-version-id 04t...
|
|
5377
|
+
|
|
5378
|
+
Same as previous example, but use the specified org:
|
|
5379
|
+
|
|
5380
|
+
$ sf package1 version display --package-version-id 04t... --target-org myorg@example.com
|
|
5381
|
+
```
|
|
5382
|
+
|
|
5383
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package1/version/display.ts)_
|
|
5384
|
+
|
|
5385
|
+
## `sf package1 version list`
|
|
5386
|
+
|
|
5387
|
+
List package versions for the specified first-generation package or for the org.
|
|
5388
|
+
|
|
5389
|
+
```
|
|
5390
|
+
USAGE
|
|
5391
|
+
$ sf package1 version list -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-i <value>]
|
|
5392
|
+
|
|
5393
|
+
FLAGS
|
|
5394
|
+
-i, --package-id=<value> Metadata package ID (starts with 033) whose package versions you want to list.
|
|
5395
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
5396
|
+
configuration variable is already set.
|
|
5397
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
5398
|
+
|
|
5399
|
+
GLOBAL FLAGS
|
|
5400
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
5401
|
+
--json Format output as json.
|
|
5402
|
+
|
|
5403
|
+
ALIASES
|
|
5404
|
+
$ sf force package1 version list
|
|
5405
|
+
|
|
5406
|
+
EXAMPLES
|
|
5407
|
+
List all first-generation package versions in your default org:
|
|
5408
|
+
|
|
5409
|
+
$ sf package1 version list
|
|
5410
|
+
|
|
5411
|
+
List package versions for the specified first-generation package in the specifief org:
|
|
5412
|
+
|
|
5413
|
+
$ sf package1 version list --package-id 033... --target-org myorg@example.com
|
|
5414
|
+
|
|
5415
|
+
FLAG DESCRIPTIONS
|
|
5416
|
+
-i, --package-id=<value> Metadata package ID (starts with 033) whose package versions you want to list.
|
|
5417
|
+
|
|
5418
|
+
If not specified, shows all versions for all packages (managed and unmanaged) in the org.
|
|
5419
|
+
```
|
|
5420
|
+
|
|
5421
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package1/version/list.ts)_
|
|
5372
5422
|
|
|
5373
5423
|
## `sf plugins`
|
|
5374
5424
|
|
|
@@ -5391,7 +5441,7 @@ EXAMPLES
|
|
|
5391
5441
|
$ sf plugins
|
|
5392
5442
|
```
|
|
5393
5443
|
|
|
5394
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.
|
|
5444
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.1.2/src/commands/plugins/index.ts)_
|
|
5395
5445
|
|
|
5396
5446
|
## `sf plugins discover`
|
|
5397
5447
|
|
|
@@ -5436,7 +5486,7 @@ EXAMPLES
|
|
|
5436
5486
|
$ sf plugins inspect @salesforce/plugin-packaging
|
|
5437
5487
|
```
|
|
5438
5488
|
|
|
5439
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.
|
|
5489
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.1.2/src/commands/plugins/inspect.ts)_
|
|
5440
5490
|
|
|
5441
5491
|
## `sf plugins install PLUGIN`
|
|
5442
5492
|
|
|
@@ -5485,7 +5535,7 @@ EXAMPLES
|
|
|
5485
5535
|
$ sf plugins install someuser/someplugin
|
|
5486
5536
|
```
|
|
5487
5537
|
|
|
5488
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.
|
|
5538
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.1.2/src/commands/plugins/install.ts)_
|
|
5489
5539
|
|
|
5490
5540
|
## `sf plugins link PATH`
|
|
5491
5541
|
|
|
@@ -5515,7 +5565,7 @@ EXAMPLES
|
|
|
5515
5565
|
$ sf plugins link @salesforce/plugin-packaging
|
|
5516
5566
|
```
|
|
5517
5567
|
|
|
5518
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.
|
|
5568
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.1.2/src/commands/plugins/link.ts)_
|
|
5519
5569
|
|
|
5520
5570
|
## `sf plugins reset`
|
|
5521
5571
|
|
|
@@ -5530,7 +5580,7 @@ FLAGS
|
|
|
5530
5580
|
--reinstall Reinstall all plugins after uninstalling.
|
|
5531
5581
|
```
|
|
5532
5582
|
|
|
5533
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.
|
|
5583
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.1.2/src/commands/plugins/reset.ts)_
|
|
5534
5584
|
|
|
5535
5585
|
## `sf plugins trust verify`
|
|
5536
5586
|
|
|
@@ -5559,7 +5609,7 @@ EXAMPLES
|
|
|
5559
5609
|
$ sf plugins trust verify --npm @scope/npmName
|
|
5560
5610
|
```
|
|
5561
5611
|
|
|
5562
|
-
_See code: [@salesforce/plugin-trust](https://github.com/salesforcecli/plugin-trust/blob/3.6.
|
|
5612
|
+
_See code: [@salesforce/plugin-trust](https://github.com/salesforcecli/plugin-trust/blob/3.6.12/src/commands/plugins/trust/verify.ts)_
|
|
5563
5613
|
|
|
5564
5614
|
## `sf plugins uninstall [PLUGIN]`
|
|
5565
5615
|
|
|
@@ -5587,7 +5637,7 @@ EXAMPLES
|
|
|
5587
5637
|
$ sf plugins uninstall @salesforce/plugin-packaging
|
|
5588
5638
|
```
|
|
5589
5639
|
|
|
5590
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.
|
|
5640
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.1.2/src/commands/plugins/uninstall.ts)_
|
|
5591
5641
|
|
|
5592
5642
|
## `sf plugins update`
|
|
5593
5643
|
|
|
@@ -5605,7 +5655,7 @@ DESCRIPTION
|
|
|
5605
5655
|
Update installed plugins.
|
|
5606
5656
|
```
|
|
5607
5657
|
|
|
5608
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.
|
|
5658
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.1.2/src/commands/plugins/update.ts)_
|
|
5609
5659
|
|
|
5610
5660
|
## `sf project convert mdapi`
|
|
5611
5661
|
|
|
@@ -5668,7 +5718,7 @@ FLAG DESCRIPTIONS
|
|
|
5668
5718
|
If you specify this parameter, don’t specify --metadata or --source-dir.
|
|
5669
5719
|
```
|
|
5670
5720
|
|
|
5671
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.
|
|
5721
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.2/src/commands/project/convert/mdapi.ts)_
|
|
5672
5722
|
|
|
5673
5723
|
## `sf project convert source`
|
|
5674
5724
|
|
|
@@ -5680,7 +5730,7 @@ USAGE
|
|
|
5680
5730
|
[-p <value> | -x <value> | -m <value>]
|
|
5681
5731
|
|
|
5682
5732
|
FLAGS
|
|
5683
|
-
-d, --output-dir=<value> [default:
|
|
5733
|
+
-d, --output-dir=<value> [default: metadataPackage_1716032858127] Output directory to store the Metadata
|
|
5684
5734
|
API–formatted files in.
|
|
5685
5735
|
-m, --metadata=<value>... Metadata component names to convert.
|
|
5686
5736
|
-n, --package-name=<value> Name of the package to associate with the metadata-formatted files.
|
|
@@ -5741,7 +5791,7 @@ FLAG DESCRIPTIONS
|
|
|
5741
5791
|
Override the api version used for api requests made by this command
|
|
5742
5792
|
```
|
|
5743
5793
|
|
|
5744
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.
|
|
5794
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.2/src/commands/project/convert/source.ts)_
|
|
5745
5795
|
|
|
5746
5796
|
## `sf project delete source`
|
|
5747
5797
|
|
|
@@ -5881,7 +5931,7 @@ FLAG DESCRIPTIONS
|
|
|
5881
5931
|
- Separate the test names with spaces: --tests Test1 Test2 "Test With Space"
|
|
5882
5932
|
```
|
|
5883
5933
|
|
|
5884
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.
|
|
5934
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.2/src/commands/project/delete/source.ts)_
|
|
5885
5935
|
|
|
5886
5936
|
## `sf project delete tracking`
|
|
5887
5937
|
|
|
@@ -5918,7 +5968,7 @@ EXAMPLES
|
|
|
5918
5968
|
$ sf project delete tracking --target-org my-scratch
|
|
5919
5969
|
```
|
|
5920
5970
|
|
|
5921
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.
|
|
5971
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.2/src/commands/project/delete/tracking.ts)_
|
|
5922
5972
|
|
|
5923
5973
|
## `sf project deploy cancel`
|
|
5924
5974
|
|
|
@@ -5994,7 +6044,7 @@ FLAG DESCRIPTIONS
|
|
|
5994
6044
|
project deploy report".
|
|
5995
6045
|
```
|
|
5996
6046
|
|
|
5997
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.
|
|
6047
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.2/src/commands/project/deploy/cancel.ts)_
|
|
5998
6048
|
|
|
5999
6049
|
## `sf project deploy preview`
|
|
6000
6050
|
|
|
@@ -6080,7 +6130,7 @@ FLAG DESCRIPTIONS
|
|
|
6080
6130
|
All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.
|
|
6081
6131
|
```
|
|
6082
6132
|
|
|
6083
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.
|
|
6133
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.2/src/commands/project/deploy/preview.ts)_
|
|
6084
6134
|
|
|
6085
6135
|
## `sf project deploy quick`
|
|
6086
6136
|
|
|
@@ -6177,7 +6227,7 @@ ERROR CODES
|
|
|
6177
6227
|
Canceling (69) The deploy is being canceled.
|
|
6178
6228
|
```
|
|
6179
6229
|
|
|
6180
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.
|
|
6230
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.2/src/commands/project/deploy/quick.ts)_
|
|
6181
6231
|
|
|
6182
6232
|
## `sf project deploy report`
|
|
6183
6233
|
|
|
@@ -6273,7 +6323,7 @@ FLAG DESCRIPTIONS
|
|
|
6273
6323
|
--coverage-formatters lcov --coverage-formatters clover
|
|
6274
6324
|
```
|
|
6275
6325
|
|
|
6276
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.
|
|
6326
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.2/src/commands/project/deploy/report.ts)_
|
|
6277
6327
|
|
|
6278
6328
|
## `sf project deploy resume`
|
|
6279
6329
|
|
|
@@ -6370,7 +6420,7 @@ ERROR CODES
|
|
|
6370
6420
|
Canceling (69) The deploy is being canceled.
|
|
6371
6421
|
```
|
|
6372
6422
|
|
|
6373
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.
|
|
6423
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.2/src/commands/project/deploy/resume.ts)_
|
|
6374
6424
|
|
|
6375
6425
|
## `sf project deploy start`
|
|
6376
6426
|
|
|
@@ -6608,7 +6658,7 @@ ERROR CODES
|
|
|
6608
6658
|
Canceling (69) The deploy is being canceled.
|
|
6609
6659
|
```
|
|
6610
6660
|
|
|
6611
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.
|
|
6661
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.2/src/commands/project/deploy/start.ts)_
|
|
6612
6662
|
|
|
6613
6663
|
## `sf project deploy validate`
|
|
6614
6664
|
|
|
@@ -6800,7 +6850,7 @@ ERROR CODES
|
|
|
6800
6850
|
Canceling (69) The deploy is being canceled.
|
|
6801
6851
|
```
|
|
6802
6852
|
|
|
6803
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.
|
|
6853
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.2/src/commands/project/deploy/validate.ts)_
|
|
6804
6854
|
|
|
6805
6855
|
## `sf project generate`
|
|
6806
6856
|
|
|
@@ -6982,7 +7032,7 @@ EXAMPLES
|
|
|
6982
7032
|
$ sf project generate manifest --from-org test@myorg.com --include-packages unlocked
|
|
6983
7033
|
```
|
|
6984
7034
|
|
|
6985
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.
|
|
7035
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.2/src/commands/project/generate/manifest.ts)_
|
|
6986
7036
|
|
|
6987
7037
|
## `sf project list ignored`
|
|
6988
7038
|
|
|
@@ -7024,7 +7074,7 @@ EXAMPLES
|
|
|
7024
7074
|
$ sf project list ignored --source-dir package.xml
|
|
7025
7075
|
```
|
|
7026
7076
|
|
|
7027
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.
|
|
7077
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.2/src/commands/project/list/ignored.ts)_
|
|
7028
7078
|
|
|
7029
7079
|
## `sf project reset tracking`
|
|
7030
7080
|
|
|
@@ -7073,7 +7123,7 @@ EXAMPLES
|
|
|
7073
7123
|
$ sf project reset tracking --revision 30
|
|
7074
7124
|
```
|
|
7075
7125
|
|
|
7076
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.
|
|
7126
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.2/src/commands/project/reset/tracking.ts)_
|
|
7077
7127
|
|
|
7078
7128
|
## `sf project retrieve preview`
|
|
7079
7129
|
|
|
@@ -7130,7 +7180,7 @@ FLAG DESCRIPTIONS
|
|
|
7130
7180
|
Overrides your default org.
|
|
7131
7181
|
```
|
|
7132
7182
|
|
|
7133
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.
|
|
7183
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.2/src/commands/project/retrieve/preview.ts)_
|
|
7134
7184
|
|
|
7135
7185
|
## `sf project retrieve start`
|
|
7136
7186
|
|
|
@@ -7289,7 +7339,7 @@ ENVIRONMENT VARIABLES
|
|
|
7289
7339
|
SF_USE_PROGRESS_BAR Set to false to disable the progress bar when running the metadata deploy command.
|
|
7290
7340
|
```
|
|
7291
7341
|
|
|
7292
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.
|
|
7342
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.2/src/commands/project/retrieve/start.ts)_
|
|
7293
7343
|
|
|
7294
7344
|
## `sf schema generate field`
|
|
7295
7345
|
|