@salesforce/cli 2.32.3 → 2.32.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md 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.32.3 linux-x64 node-v20.11.1
27
+ @salesforce/cli/2.32.5 linux-x64 node-v20.11.1
28
28
  $ sf --help [COMMAND]
29
29
  USAGE
30
30
  $ sf COMMAND
@@ -201,7 +201,7 @@ EXAMPLES
201
201
  $ sf alias list
202
202
  ```
203
203
 
204
- _See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.29/src/commands/alias/list.ts)_
204
+ _See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.31/src/commands/alias/list.ts)_
205
205
 
206
206
  ## `sf alias set`
207
207
 
@@ -249,7 +249,7 @@ EXAMPLES
249
249
  $ sf alias set my-scratch-org test-ss0xut7txzxf@example.com
250
250
  ```
251
251
 
252
- _See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.29/src/commands/alias/set.ts)_
252
+ _See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.31/src/commands/alias/set.ts)_
253
253
 
254
254
  ## `sf alias unset`
255
255
 
@@ -288,7 +288,7 @@ EXAMPLES
288
288
  $ sf alias unset --all [--no-prompt]
289
289
  ```
290
290
 
291
- _See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.29/src/commands/alias/unset.ts)_
291
+ _See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.31/src/commands/alias/unset.ts)_
292
292
 
293
293
  ## `sf analytics generate template`
294
294
 
@@ -329,7 +329,7 @@ FLAG DESCRIPTIONS
329
329
  directory.
330
330
  ```
331
331
 
332
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.19/src/commands/analytics/generate/template.ts)_
332
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.21/src/commands/analytics/generate/template.ts)_
333
333
 
334
334
  ## `sf apex generate class`
335
335
 
@@ -385,7 +385,7 @@ FLAG DESCRIPTIONS
385
385
  Supplied parameter values or default values are filled into a copy of the template.
386
386
  ```
387
387
 
388
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.19/src/commands/apex/generate/class.ts)_
388
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.21/src/commands/apex/generate/class.ts)_
389
389
 
390
390
  ## `sf apex generate trigger`
391
391
 
@@ -452,7 +452,7 @@ FLAG DESCRIPTIONS
452
452
  Supplied parameter values or default values are filled into a copy of the template.
453
453
  ```
454
454
 
455
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.19/src/commands/apex/generate/trigger.ts)_
455
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.21/src/commands/apex/generate/trigger.ts)_
456
456
 
457
457
  ## `sf apex get log`
458
458
 
@@ -903,7 +903,7 @@ CONFIGURATION VARIABLES
903
903
  org-capitalize-record-types Whether record types are capitalized on scratch org creation.
904
904
  ```
905
905
 
906
- _See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.29/src/commands/config/get.ts)_
906
+ _See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.31/src/commands/config/get.ts)_
907
907
 
908
908
  ## `sf config list`
909
909
 
@@ -942,7 +942,7 @@ EXAMPLES
942
942
  $ sf config list
943
943
  ```
944
944
 
945
- _See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.29/src/commands/config/list.ts)_
945
+ _See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.31/src/commands/config/list.ts)_
946
946
 
947
947
  ## `sf config set`
948
948
 
@@ -1010,7 +1010,7 @@ CONFIGURATION VARIABLES
1010
1010
  org-capitalize-record-types Whether record types are capitalized on scratch org creation.
1011
1011
  ```
1012
1012
 
1013
- _See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.29/src/commands/config/set.ts)_
1013
+ _See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.31/src/commands/config/set.ts)_
1014
1014
 
1015
1015
  ## `sf config unset`
1016
1016
 
@@ -1059,7 +1059,7 @@ CONFIGURATION VARIABLES
1059
1059
  org-capitalize-record-types Whether record types are capitalized on scratch org creation.
1060
1060
  ```
1061
1061
 
1062
- _See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.29/src/commands/config/unset.ts)_
1062
+ _See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.31/src/commands/config/unset.ts)_
1063
1063
 
1064
1064
  ## `sf data create record`
1065
1065
 
@@ -1114,7 +1114,7 @@ EXAMPLES
1114
1114
  TracedEntityId=01p17000000R6bLAAS"
1115
1115
  ```
1116
1116
 
1117
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.1.6/src/commands/data/create/record.ts)_
1117
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.1.7/src/commands/data/create/record.ts)_
1118
1118
 
1119
1119
  ## `sf data delete bulk`
1120
1120
 
@@ -1159,7 +1159,7 @@ EXAMPLES
1159
1159
  $ sf data delete bulk --sobject MyObject__c --file files/delete.csv --wait 5 --target-org my-scratch
1160
1160
  ```
1161
1161
 
1162
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.1.6/src/commands/data/delete/bulk.ts)_
1162
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.1.7/src/commands/data/delete/bulk.ts)_
1163
1163
 
1164
1164
  ## `sf data delete record`
1165
1165
 
@@ -1218,7 +1218,7 @@ EXAMPLES
1218
1218
  $ sf data delete record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
1219
1219
  ```
1220
1220
 
1221
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.1.6/src/commands/data/delete/record.ts)_
1221
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.1.7/src/commands/data/delete/record.ts)_
1222
1222
 
1223
1223
  ## `sf data delete resume`
1224
1224
 
@@ -1255,7 +1255,7 @@ EXAMPLES
1255
1255
  $ sf data delete resume --use-most-recent --target-org my-scratch
1256
1256
  ```
1257
1257
 
1258
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.1.6/src/commands/data/delete/resume.ts)_
1258
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.1.7/src/commands/data/delete/resume.ts)_
1259
1259
 
1260
1260
  ## `sf data export beta tree`
1261
1261
 
@@ -1311,7 +1311,7 @@ EXAMPLES
1311
1311
  my-scratch
1312
1312
  ```
1313
1313
 
1314
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.1.6/src/commands/data/export/beta/tree.ts)_
1314
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.1.7/src/commands/data/export/beta/tree.ts)_
1315
1315
 
1316
1316
  ## `sf data export tree`
1317
1317
 
@@ -1369,7 +1369,7 @@ EXAMPLES
1369
1369
  my-scratch
1370
1370
  ```
1371
1371
 
1372
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.1.6/src/commands/data/export/tree.ts)_
1372
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.1.7/src/commands/data/export/tree.ts)_
1373
1373
 
1374
1374
  ## `sf data get record`
1375
1375
 
@@ -1431,7 +1431,7 @@ EXAMPLES
1431
1431
  $ sf data get record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
1432
1432
  ```
1433
1433
 
1434
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.1.6/src/commands/data/get/record.ts)_
1434
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.1.7/src/commands/data/get/record.ts)_
1435
1435
 
1436
1436
  ## `sf data import beta tree`
1437
1437
 
@@ -1473,7 +1473,7 @@ EXAMPLES
1473
1473
  $ sf data import beta tree --plan Account-Contact-plan.json
1474
1474
  ```
1475
1475
 
1476
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.1.6/src/commands/data/import/beta/tree.ts)_
1476
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.1.7/src/commands/data/import/beta/tree.ts)_
1477
1477
 
1478
1478
  ## `sf data import tree`
1479
1479
 
@@ -1522,7 +1522,7 @@ EXAMPLES
1522
1522
  $ sf data import tree --plan Account-Contact-plan.json
1523
1523
  ```
1524
1524
 
1525
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.1.6/src/commands/data/import/tree.ts)_
1525
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.1.7/src/commands/data/import/tree.ts)_
1526
1526
 
1527
1527
  ## `sf data query`
1528
1528
 
@@ -1585,7 +1585,7 @@ EXAMPLES
1585
1585
  $ sf data query --query "SELECT Id FROM Contact" --bulk --wait 0
1586
1586
  ```
1587
1587
 
1588
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.1.6/src/commands/data/query.ts)_
1588
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.1.7/src/commands/data/query.ts)_
1589
1589
 
1590
1590
  ## `sf data query resume`
1591
1591
 
@@ -1621,7 +1621,7 @@ EXAMPLES
1621
1621
  $ sf data query resume --bulk-query-id 7500x000005BdFzXXX
1622
1622
  ```
1623
1623
 
1624
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.1.6/src/commands/data/query/resume.ts)_
1624
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.1.7/src/commands/data/query/resume.ts)_
1625
1625
 
1626
1626
  ## `sf data resume`
1627
1627
 
@@ -1657,7 +1657,7 @@ EXAMPLES
1657
1657
  $ sf data resume --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA
1658
1658
  ```
1659
1659
 
1660
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.1.6/src/commands/data/resume.ts)_
1660
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.1.7/src/commands/data/resume.ts)_
1661
1661
 
1662
1662
  ## `sf data update record`
1663
1663
 
@@ -1718,7 +1718,7 @@ EXAMPLES
1718
1718
  "ExpirationDate=2017-12-01T00:58:04.000+0000"
1719
1719
  ```
1720
1720
 
1721
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.1.6/src/commands/data/update/record.ts)_
1721
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.1.7/src/commands/data/update/record.ts)_
1722
1722
 
1723
1723
  ## `sf data upsert bulk`
1724
1724
 
@@ -1770,7 +1770,7 @@ EXAMPLES
1770
1770
  my-scratch
1771
1771
  ```
1772
1772
 
1773
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.1.6/src/commands/data/upsert/bulk.ts)_
1773
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.1.7/src/commands/data/upsert/bulk.ts)_
1774
1774
 
1775
1775
  ## `sf data upsert resume`
1776
1776
 
@@ -1807,7 +1807,7 @@ EXAMPLES
1807
1807
  $ sf data upsert resume --use-most-recent --target-org my-scratch
1808
1808
  ```
1809
1809
 
1810
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.1.6/src/commands/data/upsert/resume.ts)_
1810
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.1.7/src/commands/data/upsert/resume.ts)_
1811
1811
 
1812
1812
  ## `sf doctor`
1813
1813
 
@@ -1899,7 +1899,7 @@ EXAMPLES
1899
1899
  $ sf force data bulk delete --sobject MyObject__c --file files/delete.csv --wait 5 --target-org my-scratch
1900
1900
  ```
1901
1901
 
1902
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.1.6/src/commands/force/data/bulk/delete.ts)_
1902
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.1.7/src/commands/force/data/bulk/delete.ts)_
1903
1903
 
1904
1904
  ## `sf force data bulk status`
1905
1905
 
@@ -1935,7 +1935,7 @@ EXAMPLES
1935
1935
  $ sf force data bulk status --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA --target-org my-scratch
1936
1936
  ```
1937
1937
 
1938
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.1.6/src/commands/force/data/bulk/status.ts)_
1938
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.1.7/src/commands/force/data/bulk/status.ts)_
1939
1939
 
1940
1940
  ## `sf force data bulk upsert`
1941
1941
 
@@ -1992,7 +1992,7 @@ EXAMPLES
1992
1992
  --target-org my-scratch
1993
1993
  ```
1994
1994
 
1995
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.1.6/src/commands/force/data/bulk/upsert.ts)_
1995
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.1.7/src/commands/force/data/bulk/upsert.ts)_
1996
1996
 
1997
1997
  ## `sf help [COMMANDS]`
1998
1998
 
@@ -2012,7 +2012,7 @@ DESCRIPTION
2012
2012
  Display help for sf.
2013
2013
  ```
2014
2014
 
2015
- _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/6.0.14/src/commands/help.ts)_
2015
+ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/6.0.15/src/commands/help.ts)_
2016
2016
 
2017
2017
  ## `sf info releasenotes display`
2018
2018
 
@@ -2104,7 +2104,7 @@ FLAG DESCRIPTIONS
2104
2104
  Supplied parameter values or default values are filled into a copy of the template.
2105
2105
  ```
2106
2106
 
2107
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.19/src/commands/lightning/generate/app.ts)_
2107
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.21/src/commands/lightning/generate/app.ts)_
2108
2108
 
2109
2109
  ## `sf lightning generate component`
2110
2110
 
@@ -2172,7 +2172,7 @@ FLAG DESCRIPTIONS
2172
2172
  Supplied parameter values or default values are filled into a copy of the template.
2173
2173
  ```
2174
2174
 
2175
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.19/src/commands/lightning/generate/component.ts)_
2175
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.21/src/commands/lightning/generate/component.ts)_
2176
2176
 
2177
2177
  ## `sf lightning generate event`
2178
2178
 
@@ -2225,7 +2225,7 @@ FLAG DESCRIPTIONS
2225
2225
  Supplied parameter values or default values are filled into a copy of the template.
2226
2226
  ```
2227
2227
 
2228
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.19/src/commands/lightning/generate/event.ts)_
2228
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.21/src/commands/lightning/generate/event.ts)_
2229
2229
 
2230
2230
  ## `sf lightning generate interface`
2231
2231
 
@@ -2278,7 +2278,7 @@ FLAG DESCRIPTIONS
2278
2278
  Supplied parameter values or default values are filled into a copy of the template.
2279
2279
  ```
2280
2280
 
2281
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.19/src/commands/lightning/generate/interface.ts)_
2281
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.21/src/commands/lightning/generate/interface.ts)_
2282
2282
 
2283
2283
  ## `sf lightning generate test`
2284
2284
 
@@ -2331,7 +2331,7 @@ FLAG DESCRIPTIONS
2331
2331
  Supplied parameter values or default values are filled into a copy of the template.
2332
2332
  ```
2333
2333
 
2334
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.19/src/commands/lightning/generate/test.ts)_
2334
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.21/src/commands/lightning/generate/test.ts)_
2335
2335
 
2336
2336
  ## `sf org assign permset`
2337
2337
 
@@ -2374,7 +2374,7 @@ EXAMPLES
2374
2374
  $ sf org assign permset --name DreamHouse --on-behalf-of user1@my.org --on-behalf-of user2 --on-behalf-of user
2375
2375
  ```
2376
2376
 
2377
- _See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.3.0/src/commands/org/assign/permset.ts)_
2377
+ _See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.3.1/src/commands/org/assign/permset.ts)_
2378
2378
 
2379
2379
  ## `sf org assign permsetlicense`
2380
2380
 
@@ -2418,7 +2418,7 @@ EXAMPLES
2418
2418
  user3
2419
2419
  ```
2420
2420
 
2421
- _See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.3.0/src/commands/org/assign/permsetlicense.ts)_
2421
+ _See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.3.1/src/commands/org/assign/permsetlicense.ts)_
2422
2422
 
2423
2423
  ## `sf org create sandbox`
2424
2424
 
@@ -2792,7 +2792,7 @@ FLAG DESCRIPTIONS
2792
2792
  might be different than what you specify in the definition file.
2793
2793
  ```
2794
2794
 
2795
- _See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.3.0/src/commands/org/create/user.ts)_
2795
+ _See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.3.1/src/commands/org/create/user.ts)_
2796
2796
 
2797
2797
  ## `sf org delete sandbox`
2798
2798
 
@@ -2998,7 +2998,7 @@ EXAMPLES
2998
2998
  $ sf org display user --target-org me@my.org --json
2999
2999
  ```
3000
3000
 
3001
- _See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.3.0/src/commands/org/display/user.ts)_
3001
+ _See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.3.1/src/commands/org/display/user.ts)_
3002
3002
 
3003
3003
  ## `sf org enable tracking`
3004
3004
 
@@ -3104,7 +3104,7 @@ EXAMPLES
3104
3104
  $ sf org generate password --on-behalf-of user1@my.org --on-behalf-of user2@my.org --on-behalf-of user3@my.org
3105
3105
  ```
3106
3106
 
3107
- _See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.3.0/src/commands/org/generate/password.ts)_
3107
+ _See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.3.1/src/commands/org/generate/password.ts)_
3108
3108
 
3109
3109
  ## `sf org list`
3110
3110
 
@@ -3173,7 +3173,7 @@ EXAMPLES
3173
3173
  $ sf org list auth
3174
3174
  ```
3175
3175
 
3176
- _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.18/src/commands/org/list/auth.ts)_
3176
+ _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.20/src/commands/org/list/auth.ts)_
3177
3177
 
3178
3178
  ## `sf org list limits`
3179
3179
 
@@ -3212,7 +3212,7 @@ EXAMPLES
3212
3212
  $ sf org list limits --target-org my-scratch-org
3213
3213
  ```
3214
3214
 
3215
- _See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.1.12/src/commands/org/list/limits.ts)_
3215
+ _See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.1.13/src/commands/org/list/limits.ts)_
3216
3216
 
3217
3217
  ## `sf org list metadata`
3218
3218
 
@@ -3376,7 +3376,7 @@ EXAMPLES
3376
3376
  $ sf org list sobject record-counts --sobject Account --sobject Lead --target-org my-scratch-org
3377
3377
  ```
3378
3378
 
3379
- _See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.1.12/src/commands/org/list/sobject/record-counts.ts)_
3379
+ _See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.1.13/src/commands/org/list/sobject/record-counts.ts)_
3380
3380
 
3381
3381
  ## `sf org list users`
3382
3382
 
@@ -3413,7 +3413,7 @@ EXAMPLES
3413
3413
  $ sf org list users --target-org me@my.org
3414
3414
  ```
3415
3415
 
3416
- _See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.3.0/src/commands/org/list/users.ts)_
3416
+ _See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.3.1/src/commands/org/list/users.ts)_
3417
3417
 
3418
3418
  ## `sf org login access-token`
3419
3419
 
@@ -3466,7 +3466,7 @@ FLAG DESCRIPTIONS
3466
3466
  To specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.
3467
3467
  ```
3468
3468
 
3469
- _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.18/src/commands/org/login/access-token.ts)_
3469
+ _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.20/src/commands/org/login/access-token.ts)_
3470
3470
 
3471
3471
  ## `sf org login device`
3472
3472
 
@@ -3525,7 +3525,7 @@ FLAG DESCRIPTIONS
3525
3525
  To specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.
3526
3526
  ```
3527
3527
 
3528
- _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.18/src/commands/org/login/device.ts)_
3528
+ _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.20/src/commands/org/login/device.ts)_
3529
3529
 
3530
3530
  ## `sf org login jwt`
3531
3531
 
@@ -3614,7 +3614,7 @@ FLAG DESCRIPTIONS
3614
3614
  To specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.
3615
3615
  ```
3616
3616
 
3617
- _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.18/src/commands/org/login/jwt.ts)_
3617
+ _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.20/src/commands/org/login/jwt.ts)_
3618
3618
 
3619
3619
  ## `sf org login sfdx-url`
3620
3620
 
@@ -3679,7 +3679,7 @@ EXAMPLES
3679
3679
  $ echo url | sf org login sfdx-url --sfdx-url-stdin
3680
3680
  ```
3681
3681
 
3682
- _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.18/src/commands/org/login/sfdx-url.ts)_
3682
+ _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.20/src/commands/org/login/sfdx-url.ts)_
3683
3683
 
3684
3684
  ## `sf org login web`
3685
3685
 
@@ -3764,7 +3764,7 @@ FLAG DESCRIPTIONS
3764
3764
  To specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.
3765
3765
  ```
3766
3766
 
3767
- _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.18/src/commands/org/login/web.ts)_
3767
+ _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.20/src/commands/org/login/web.ts)_
3768
3768
 
3769
3769
  ## `sf org logout`
3770
3770
 
@@ -3824,7 +3824,7 @@ FLAG DESCRIPTIONS
3824
3824
  All orgs includes Dev Hubs, sandboxes, DE orgs, and expired, deleted, and unknown-status scratch orgs.
3825
3825
  ```
3826
3826
 
3827
- _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.18/src/commands/org/logout.ts)_
3827
+ _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.20/src/commands/org/logout.ts)_
3828
3828
 
3829
3829
  ## `sf org open`
3830
3830
 
@@ -5271,7 +5271,7 @@ EXAMPLES
5271
5271
  $ sf plugins
5272
5272
  ```
5273
5273
 
5274
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.2.7/src/commands/plugins/index.ts)_
5274
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.3.0/src/commands/plugins/index.ts)_
5275
5275
 
5276
5276
  ## `sf plugins discover`
5277
5277
 
@@ -5315,7 +5315,7 @@ EXAMPLES
5315
5315
  $ sf plugins inspect myplugin
5316
5316
  ```
5317
5317
 
5318
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.2.7/src/commands/plugins/inspect.ts)_
5318
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.3.0/src/commands/plugins/inspect.ts)_
5319
5319
 
5320
5320
  ## `sf plugins:install PLUGIN...`
5321
5321
 
@@ -5359,7 +5359,7 @@ EXAMPLES
5359
5359
  $ sf plugins install someuser/someplugin
5360
5360
  ```
5361
5361
 
5362
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.2.7/src/commands/plugins/install.ts)_
5362
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.3.0/src/commands/plugins/install.ts)_
5363
5363
 
5364
5364
  ## `sf plugins:link PLUGIN`
5365
5365
 
@@ -5389,7 +5389,7 @@ EXAMPLES
5389
5389
  $ sf plugins link myplugin
5390
5390
  ```
5391
5391
 
5392
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.2.7/src/commands/plugins/link.ts)_
5392
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.3.0/src/commands/plugins/link.ts)_
5393
5393
 
5394
5394
  ## `sf plugins reset`
5395
5395
 
@@ -5404,7 +5404,7 @@ FLAGS
5404
5404
  --reinstall Reinstall all plugins after uninstalling.
5405
5405
  ```
5406
5406
 
5407
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.2.7/src/commands/plugins/reset.ts)_
5407
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.3.0/src/commands/plugins/reset.ts)_
5408
5408
 
5409
5409
  ## `sf plugins trust verify`
5410
5410
 
@@ -5432,7 +5432,7 @@ EXAMPLES
5432
5432
  $ sf plugins trust verify --npm @scope/npmName
5433
5433
  ```
5434
5434
 
5435
- _See code: [@salesforce/plugin-trust](https://github.com/salesforcecli/plugin-trust/blob/3.3.14/src/commands/plugins/trust/verify.ts)_
5435
+ _See code: [@salesforce/plugin-trust](https://github.com/salesforcecli/plugin-trust/blob/3.3.16/src/commands/plugins/trust/verify.ts)_
5436
5436
 
5437
5437
  ## `sf plugins:uninstall PLUGIN...`
5438
5438
 
@@ -5460,7 +5460,7 @@ EXAMPLES
5460
5460
  $ sf plugins uninstall myplugin
5461
5461
  ```
5462
5462
 
5463
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.2.7/src/commands/plugins/uninstall.ts)_
5463
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.3.0/src/commands/plugins/uninstall.ts)_
5464
5464
 
5465
5465
  ## `sf plugins update`
5466
5466
 
@@ -5478,7 +5478,7 @@ DESCRIPTION
5478
5478
  Update installed plugins.
5479
5479
  ```
5480
5480
 
5481
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.2.7/src/commands/plugins/update.ts)_
5481
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.3.0/src/commands/plugins/update.ts)_
5482
5482
 
5483
5483
  ## `sf project convert mdapi`
5484
5484
 
@@ -5540,7 +5540,7 @@ FLAG DESCRIPTIONS
5540
5540
  If you specify this parameter, don’t specify --metadata or --source-dir.
5541
5541
  ```
5542
5542
 
5543
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.23/src/commands/project/convert/mdapi.ts)_
5543
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.25/src/commands/project/convert/mdapi.ts)_
5544
5544
 
5545
5545
  ## `sf project convert source`
5546
5546
 
@@ -5552,7 +5552,7 @@ USAGE
5552
5552
  <value> | -m <value>]
5553
5553
 
5554
5554
  FLAGS
5555
- -d, --output-dir=<value> [default: metadataPackage_1709380111509] Output directory to store the Metadata
5555
+ -d, --output-dir=<value> [default: metadataPackage_1709594365139] Output directory to store the Metadata
5556
5556
  API–formatted files in.
5557
5557
  -m, --metadata=<value>... Metadata component names to convert.
5558
5558
  -n, --package-name=<value> Name of the package to associate with the metadata-formatted files.
@@ -5612,7 +5612,7 @@ FLAG DESCRIPTIONS
5612
5612
  Override the api version used for api requests made by this command
5613
5613
  ```
5614
5614
 
5615
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.23/src/commands/project/convert/source.ts)_
5615
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.25/src/commands/project/convert/source.ts)_
5616
5616
 
5617
5617
  ## `sf project delete source`
5618
5618
 
@@ -5751,7 +5751,7 @@ FLAG DESCRIPTIONS
5751
5751
  - Separate the test names with spaces: --tests Test1 Test2 "Test With Space"
5752
5752
  ```
5753
5753
 
5754
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.23/src/commands/project/delete/source.ts)_
5754
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.25/src/commands/project/delete/source.ts)_
5755
5755
 
5756
5756
  ## `sf project delete tracking`
5757
5757
 
@@ -5787,7 +5787,7 @@ EXAMPLES
5787
5787
  $ sf project delete tracking --target-org my-scratch
5788
5788
  ```
5789
5789
 
5790
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.23/src/commands/project/delete/tracking.ts)_
5790
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.25/src/commands/project/delete/tracking.ts)_
5791
5791
 
5792
5792
  ## `sf project deploy cancel`
5793
5793
 
@@ -5857,7 +5857,7 @@ FLAG DESCRIPTIONS
5857
5857
  project deploy report".
5858
5858
  ```
5859
5859
 
5860
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.23/src/commands/project/deploy/cancel.ts)_
5860
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.25/src/commands/project/deploy/cancel.ts)_
5861
5861
 
5862
5862
  ## `sf project deploy preview`
5863
5863
 
@@ -5941,7 +5941,7 @@ FLAG DESCRIPTIONS
5941
5941
  All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.
5942
5942
  ```
5943
5943
 
5944
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.23/src/commands/project/deploy/preview.ts)_
5944
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.25/src/commands/project/deploy/preview.ts)_
5945
5945
 
5946
5946
  ## `sf project deploy quick`
5947
5947
 
@@ -5981,6 +5981,9 @@ DESCRIPTION
5981
5981
  This command doesn't support source-tracking. The source you deploy overwrites the corresponding metadata in your org.
5982
5982
  This command doesn’t attempt to merge your source with the versions in your org.
5983
5983
 
5984
+ Note: Don't use this command on sandboxes; the command is intended to be used on production orgs. By default,
5985
+ sandboxes don't run tests during a deploy. Use `sf project deploy start` instead.
5986
+
5984
5987
  ALIASES
5985
5988
  $ sf deploy metadata quick
5986
5989
 
@@ -6034,7 +6037,7 @@ ERROR CODES
6034
6037
  Canceling (69) The deploy is being canceled.
6035
6038
  ```
6036
6039
 
6037
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.23/src/commands/project/deploy/quick.ts)_
6040
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.25/src/commands/project/deploy/quick.ts)_
6038
6041
 
6039
6042
  ## `sf project deploy report`
6040
6043
 
@@ -6129,7 +6132,7 @@ FLAG DESCRIPTIONS
6129
6132
  --coverage-formatters lcov --coverage-formatters clover
6130
6133
  ```
6131
6134
 
6132
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.23/src/commands/project/deploy/report.ts)_
6135
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.25/src/commands/project/deploy/report.ts)_
6133
6136
 
6134
6137
  ## `sf project deploy resume`
6135
6138
 
@@ -6225,7 +6228,7 @@ ERROR CODES
6225
6228
  Canceling (69) The deploy is being canceled.
6226
6229
  ```
6227
6230
 
6228
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.23/src/commands/project/deploy/resume.ts)_
6231
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.25/src/commands/project/deploy/resume.ts)_
6229
6232
 
6230
6233
  ## `sf project deploy start`
6231
6234
 
@@ -6255,8 +6258,8 @@ FLAGS
6255
6258
 
6256
6259
  SOURCE FORMAT FLAGS
6257
6260
  -d, --source-dir=<value>... Path to the local source files to deploy.
6258
- -m, --metadata=<value>... Metadata component names to deploy. Wildcards ( `*` ) supported as long as you use
6259
- quotes, such as `ApexClass:MyClass*`
6261
+ -m, --metadata=<value>... Metadata component names to deploy. Wildcards (`*` ) supported as long as you use quotes,
6262
+ such as `ApexClass:MyClass*`.
6260
6263
  -x, --manifest=<value> Full file path for manifest (package.xml) of components to deploy.
6261
6264
 
6262
6265
  TEST FLAGS
@@ -6281,7 +6284,7 @@ DELETE FLAGS
6281
6284
  --post-destructive-changes=<value> File path for a manifest (destructiveChangesPost.xml) of components to delete
6282
6285
  after the deploy.
6283
6286
  --pre-destructive-changes=<value> File path for a manifest (destructiveChangesPre.xml) of components to delete
6284
- before the deploy
6287
+ before the deploy.
6285
6288
  --purge-on-delete Specify that deleted components in the destructive changes manifest file are
6286
6289
  immediately eligible for deletion rather than being stored in the Recycle Bin.
6287
6290
 
@@ -6295,7 +6298,7 @@ DESCRIPTION
6295
6298
  want to deploy.
6296
6299
 
6297
6300
  If your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production
6298
- org, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable
6301
+ orgs, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable
6299
6302
  source tracking when you create the orgs by specifying the --no-track-source flag on the "sf org create
6300
6303
  scratch|sandbox" commands.
6301
6304
 
@@ -6311,29 +6314,34 @@ EXAMPLES
6311
6314
 
6312
6315
  $ sf project deploy start
6313
6316
 
6314
- Deploy the source files in a directory to an org with alias "my-scratch":
6317
+ Deploy all source files in the "force-app" directory to an org with alias "my-scratch"; show only concise output, in
6318
+ other words don't print a list of all the source that was deployed:
6315
6319
 
6316
- $ sf project deploy start --source-dir path/to/source --target-org my-scratch
6320
+ $ sf project deploy start --source-dir force-app --target-org my-scratch --concise
6317
6321
 
6318
- Deploy a specific Apex class and the objects whose source is in a directory (both examples are equivalent):
6322
+ Deploy all the Apex classes and custom objects that are in the "force-app" directory. The list views, layouts, etc,
6323
+ that are associated with the custom objects are also deployed. Both examples are equivalent:
6319
6324
 
6320
- $ sf project deploy start --source-dir path/to/apex/classes/MyClass.cls path/to/source/objects
6321
- $ sf project deploy start --source-dir path/to/apex/classes/MyClass.cls --source-dir path/to/source/objects
6325
+ $ sf project deploy start --source-dir force-app/main/default/classes force-app/main/default/objects
6326
+ $ sf project deploy start --source-dir force-app/main/default/classes --source-dir \
6327
+ force-app/main/default/objects
6322
6328
 
6323
- Deploy all Apex classes:
6329
+ Deploy all Apex classes that are in all package directories defined in the "sfdx-project.json" file:
6324
6330
 
6325
6331
  $ sf project deploy start --metadata ApexClass
6326
6332
 
6327
- Deploy a specific Apex class:
6333
+ Deploy a specific Apex class; ignore any conflicts between the local project and org (be careful with this flag,
6334
+ because it will overwrite the Apex class in the org if there are conflicts!):
6328
6335
 
6329
- $ sf project deploy start --metadata ApexClass:MyApexClass
6336
+ $ sf project deploy start --metadata ApexClass:MyApexClass --ignore-conflicts
6330
6337
 
6331
6338
  Deploy specific Apex classes that match a pattern; in this example, deploy Apex classes whose names contain the
6332
- string "MyApex":
6339
+ string "MyApex". Also ignore any deployment warnings (again, be careful with this flag! You typically want to see
6340
+ the warnings):
6333
6341
 
6334
- $ sf project deploy start --metadata 'ApexClass:MyApex*'
6342
+ $ sf project deploy start --metadata 'ApexClass:MyApex*' --ignore-warnings
6335
6343
 
6336
- Deploy all custom objects and Apex classes (both examples are equivalent):
6344
+ Deploy all custom objects and Apex classes found in all defined package directories (both examples are equivalent):
6337
6345
 
6338
6346
  $ sf project deploy start --metadata CustomObject ApexClass
6339
6347
  $ sf project deploy start --metadata CustomObject --metadata ApexClass
@@ -6370,8 +6378,13 @@ FLAG DESCRIPTIONS
6370
6378
 
6371
6379
  -g, --ignore-warnings Ignore warnings and allow a deployment to complete successfully.
6372
6380
 
6373
- If a warning occurs and this flag is set to true, the success status of the deployment is set to true. When this
6374
- flag is set to false, success is set to false, and the warning is treated like an error.
6381
+ If you specify this flag, and a warning occurs, the success status of the deployment is set to true. If you don't
6382
+ specify this flag, and a warning occurs, then the success status is set to false, and the warning is treated like an
6383
+ error.
6384
+
6385
+ This flag is useful in a CI environment and your deployment includes destructive changes; if you try to delete a
6386
+ component that doesn't exist in the org, you get a warning. In this case, to ensure that the command returns a
6387
+ success value of true, specify this flag.
6375
6388
 
6376
6389
  -l, --test-level=NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg Deployment Apex testing level.
6377
6390
 
@@ -6401,9 +6414,8 @@ FLAG DESCRIPTIONS
6401
6414
 
6402
6415
  -r, --ignore-errors Ignore any errors and don’t roll back deployment.
6403
6416
 
6404
- When deploying to a production org, keep this flag set to false (default value). When set to true, components
6405
- without errors are deployed and components with errors are skipped, and could result in an inconsistent production
6406
- org.
6417
+ Never use this flag when deploying to a production org. If you specify it, components without errors are deployed
6418
+ and components with errors are skipped, and could result in an inconsistent production org.
6407
6419
 
6408
6420
  -t, --tests=<value>... Apex tests to run when --test-level is RunSpecifiedTests.
6409
6421
 
@@ -6454,7 +6466,7 @@ ERROR CODES
6454
6466
  Canceling (69) The deploy is being canceled.
6455
6467
  ```
6456
6468
 
6457
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.23/src/commands/project/deploy/start.ts)_
6469
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.25/src/commands/project/deploy/start.ts)_
6458
6470
 
6459
6471
  ## `sf project deploy validate`
6460
6472
 
@@ -6528,20 +6540,28 @@ DESCRIPTION
6528
6540
  --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double
6529
6541
  quotes. The same syntax applies to --manifest and --source-dir.
6530
6542
 
6543
+ Note: Don't use this command on sandboxes; the command is intended to be used on production orgs. By default,
6544
+ sandboxes don't run tests during a deploy. If you want to validate a deployment with tests on a sandbox, use "sf
6545
+ project deploy start --dry-run --test-level RunLocalTests" instead.
6546
+
6531
6547
  ALIASES
6532
6548
  $ sf deploy metadata validate
6533
6549
 
6534
6550
  EXAMPLES
6535
6551
  NOTE: These examples focus on validating large deployments. See the help for "sf project deploy start" for examples of deploying smaller sets of metadata which you can also use to validate.
6536
6552
 
6537
- Validate the deployment of all source files in a directory to the default org:
6553
+ Validate the deployment of all source files in the "force-app" directory to the default org:
6554
+
6555
+ $ sf project deploy validate --source-dir force-app
6538
6556
 
6539
- $ sf project deploy validate --source-dir path/to/source
6557
+ Validate the deployment of all source files in two directories: "force-app" and "force-app-utils":
6558
+
6559
+ $ sf project deploy validate --source-dir force-app --source-dir force-app-utils
6540
6560
 
6541
6561
  Asynchronously validate the deployment and run all tests in the org with alias "my-prod-org"; command immediately
6542
6562
  returns the job ID:
6543
6563
 
6544
- $ sf project deploy validate --source-dir path/to/source --async --test-level RunAllTestsInOrg --target-org \
6564
+ $ sf project deploy validate --source-dir force-app --async --test-level RunAllTestsInOrg --target-org \
6545
6565
  my-prod-org
6546
6566
 
6547
6567
  Validate the deployment of all components listed in a manifest:
@@ -6563,8 +6583,13 @@ FLAG DESCRIPTIONS
6563
6583
 
6564
6584
  -g, --ignore-warnings Ignore warnings and allow a deployment to complete successfully.
6565
6585
 
6566
- If a warning occurs and this flag is set to true, the success status of the deployment is set to true. When this
6567
- flag is set to false, success is set to false, and the warning is treated like an error.
6586
+ If you specify this flag, and a warning occurs, the success status of the deployment is set to true. If you don't
6587
+ specify this flag, and a warning occurs, then the success status is set to false, and the warning is treated like an
6588
+ error.
6589
+
6590
+ This flag is useful in a CI environment and your deployment includes destructive changes; if you try to delete a
6591
+ component that doesn't exist in the org, you get a warning. In this case, to ensure that the command returns a
6592
+ success value of true, specify this flag.
6568
6593
 
6569
6594
  -l, --test-level=RunAllTestsInOrg|RunLocalTests|RunSpecifiedTests Deployment Apex testing level.
6570
6595
 
@@ -6633,7 +6658,7 @@ ERROR CODES
6633
6658
  Canceling (69) The deploy is being canceled.
6634
6659
  ```
6635
6660
 
6636
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.23/src/commands/project/deploy/validate.ts)_
6661
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.25/src/commands/project/deploy/validate.ts)_
6637
6662
 
6638
6663
  ## `sf project generate`
6639
6664
 
@@ -6737,7 +6762,7 @@ FLAG DESCRIPTIONS
6737
6762
  Override the api version used for api requests made by this command
6738
6763
  ```
6739
6764
 
6740
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.19/src/commands/project/generate.ts)_
6765
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.21/src/commands/project/generate.ts)_
6741
6766
 
6742
6767
  ## `sf project generate manifest`
6743
6768
 
@@ -6812,7 +6837,7 @@ EXAMPLES
6812
6837
  $ sf project generate manifest --from-org test@myorg.com --include-packages unlocked
6813
6838
  ```
6814
6839
 
6815
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.23/src/commands/project/generate/manifest.ts)_
6840
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.25/src/commands/project/generate/manifest.ts)_
6816
6841
 
6817
6842
  ## `sf project list ignored`
6818
6843
 
@@ -6853,7 +6878,7 @@ EXAMPLES
6853
6878
  $ sf project list ignored --source-dir package.xml
6854
6879
  ```
6855
6880
 
6856
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.23/src/commands/project/list/ignored.ts)_
6881
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.25/src/commands/project/list/ignored.ts)_
6857
6882
 
6858
6883
  ## `sf project reset tracking`
6859
6884
 
@@ -6901,7 +6926,7 @@ EXAMPLES
6901
6926
  $ sf project reset tracking --revision 30
6902
6927
  ```
6903
6928
 
6904
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.23/src/commands/project/reset/tracking.ts)_
6929
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.25/src/commands/project/reset/tracking.ts)_
6905
6930
 
6906
6931
  ## `sf project retrieve preview`
6907
6932
 
@@ -6957,7 +6982,7 @@ FLAG DESCRIPTIONS
6957
6982
  Overrides your default org.
6958
6983
  ```
6959
6984
 
6960
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.23/src/commands/project/retrieve/preview.ts)_
6985
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.25/src/commands/project/retrieve/preview.ts)_
6961
6986
 
6962
6987
  ## `sf project retrieve start`
6963
6988
 
@@ -6973,8 +6998,8 @@ FLAGS
6973
6998
  -c, --ignore-conflicts Ignore conflicts and retrieve and save files to your local filesystem, even if they
6974
6999
  overwrite your local changes.
6975
7000
  -d, --source-dir=<value>... File paths for source to retrieve from the org.
6976
- -m, --metadata=<value>... Metadata component names to retrieve. Wildcards ( `*` ) supported as long as you use
6977
- quotes, such as `ApexClass:MyClass*`
7001
+ -m, --metadata=<value>... Metadata component names to retrieve. Wildcards (`*`) supported as long as you use
7002
+ quotes, such as `ApexClass:MyClass*`.
6978
7003
  -n, --package-name=<value>... Package names to retrieve.
6979
7004
  -o, --target-org=<value> (required) Login username or alias for the target org.
6980
7005
  -r, --output-dir=<value> Directory root for the retrieved source files.
@@ -7000,7 +7025,7 @@ DESCRIPTION
7000
7025
  --target-metadata-dir flag, which retrieves the components into a ZIP file in the specified directory.
7001
7026
 
7002
7027
  If your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production
7003
- org, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable
7028
+ orgs, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable
7004
7029
  source tracking when you create the orgs by specifying the --no-track-source flag on the "sf org create
7005
7030
  scratch|sandbox" commands.
7006
7031
 
@@ -7012,33 +7037,37 @@ ALIASES
7012
7037
  $ sf retrieve metadata
7013
7038
 
7014
7039
  EXAMPLES
7015
- Retrieve remote changes from your default org:
7040
+ Retrieve all remote changes from your default org:
7016
7041
 
7017
7042
  $ sf project retrieve start
7018
7043
 
7019
- Retrieve the source files in a directory from an org with alias "my-scratch":
7044
+ Retrieve the source files in the "force-app" directory from an org with alias "my-scratch":
7020
7045
 
7021
- $ sf project retrieve start --source-dir path/to/source --target-org my-scratch
7046
+ $ sf project retrieve start --source-dir force-app --target-org my-scratch
7022
7047
 
7023
- Retrieve a specific Apex class and the objects whose source is in a directory (both examples are equivalent):
7048
+ Retrieve all the Apex classes and custom objects whose source is in the "force-app" directory. The list views,
7049
+ layouts, etc, that are associated with the custom objects are also retrieved. Both examples are equivalent:
7024
7050
 
7025
- $ sf project retrieve start --source-dir path/to/apex/classes/MyClass.cls path/to/source/objects
7026
- $ sf project retrieve start --source-dir path/to/apex/classes/MyClass.cls --source-dir path/to/source/objects
7051
+ $ sf project retrieve start --source-dir force-app/main/default/classes force-app/main/default/objects
7052
+ $ sf project retrieve start --source-dir force-app/main/default/classes --source-dir \
7053
+ force-app/main/default/objects
7027
7054
 
7028
- Retrieve all Apex classes:
7055
+ Retrieve all Apex classes that are in all package directories defined in the "sfdx-project.json" file:
7029
7056
 
7030
7057
  $ sf project retrieve start --metadata ApexClass
7031
7058
 
7032
- Retrieve a specific Apex class:
7059
+ Retrieve a specific Apex class; ignore any conflicts between the local project and org (be careful with this flag,
7060
+ because it will overwrite the Apex class source files in your local project if there are conflicts!):
7033
7061
 
7034
- $ sf project retrieve start --metadata ApexClass:MyApexClass
7062
+ $ sf project retrieve start --metadata ApexClass:MyApexClass --ignore-conflicts
7035
7063
 
7036
7064
  Retrieve specific Apex classes that match a pattern; in this example, retrieve Apex classes whose names contain the
7037
7065
  string "MyApex":
7038
7066
 
7039
7067
  $ sf project retrieve start --metadata 'ApexClass:MyApex*'
7040
7068
 
7041
- Retrieve all custom objects and Apex classes (both examples are equivalent):
7069
+ Retrieve all custom objects and Apex classes found in all defined package directories (both examples are
7070
+ equivalent):
7042
7071
 
7043
7072
  $ sf project retrieve start --metadata CustomObject ApexClass
7044
7073
  $ sf project retrieve start --metadata CustomObject --metadata ApexClass
@@ -7111,7 +7140,7 @@ ENVIRONMENT VARIABLES
7111
7140
  SF_USE_PROGRESS_BAR Set to false to disable the progress bar when running the metadata deploy command.
7112
7141
  ```
7113
7142
 
7114
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.23/src/commands/project/retrieve/start.ts)_
7143
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.25/src/commands/project/retrieve/start.ts)_
7115
7144
 
7116
7145
  ## `sf schema generate field`
7117
7146
 
@@ -7162,7 +7191,7 @@ FLAG DESCRIPTIONS
7162
7191
  If you don't specify this flag, the command prompts you to choose from your local objects.
7163
7192
  ```
7164
7193
 
7165
- _See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.1.15/src/commands/schema/generate/field.ts)_
7194
+ _See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.1.17/src/commands/schema/generate/field.ts)_
7166
7195
 
7167
7196
  ## `sf schema generate platformevent`
7168
7197
 
@@ -7191,7 +7220,7 @@ EXAMPLES
7191
7220
  $ sf schema generate platformevent --label "My Platform Event"
7192
7221
  ```
7193
7222
 
7194
- _See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.1.15/src/commands/schema/generate/platformevent.ts)_
7223
+ _See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.1.17/src/commands/schema/generate/platformevent.ts)_
7195
7224
 
7196
7225
  ## `sf schema generate sobject`
7197
7226
 
@@ -7245,7 +7274,7 @@ FLAG DESCRIPTIONS
7245
7274
  - Streaming API: With Bulk API and Sharing, classifies the custom object as an Enterprise Application object.
7246
7275
  ```
7247
7276
 
7248
- _See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.1.15/src/commands/schema/generate/sobject.ts)_
7277
+ _See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.1.17/src/commands/schema/generate/sobject.ts)_
7249
7278
 
7250
7279
  ## `sf schema generate tab`
7251
7280
 
@@ -7292,7 +7321,7 @@ FLAG DESCRIPTIONS
7292
7321
  The API name for a custom object always ends in `__c`, such as `MyObject__c`.
7293
7322
  ```
7294
7323
 
7295
- _See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.1.15/src/commands/schema/generate/tab.ts)_
7324
+ _See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.1.17/src/commands/schema/generate/tab.ts)_
7296
7325
 
7297
7326
  ## `sf search`
7298
7327
 
@@ -7308,7 +7337,7 @@ DESCRIPTION
7308
7337
  Once you select a command, hit enter and it will show the help for that command.
7309
7338
  ```
7310
7339
 
7311
- _See code: [@oclif/plugin-search](https://github.com/oclif/plugin-search/blob/1.0.17/src/commands/search.ts)_
7340
+ _See code: [@oclif/plugin-search](https://github.com/oclif/plugin-search/blob/1.0.19/src/commands/search.ts)_
7312
7341
 
7313
7342
  ## `sf sobject describe`
7314
7343
 
@@ -7354,7 +7383,7 @@ EXAMPLES
7354
7383
  $ sf sobject describe --sobject ApexCodeCoverage --use-tooling-api
7355
7384
  ```
7356
7385
 
7357
- _See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.1.6/src/commands/sobject/describe.ts)_
7386
+ _See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.1.7/src/commands/sobject/describe.ts)_
7358
7387
 
7359
7388
  ## `sf sobject list`
7360
7389
 
@@ -7392,7 +7421,7 @@ EXAMPLES
7392
7421
  $ sf sobject list --sobject custom --target-org my-scratch-org
7393
7422
  ```
7394
7423
 
7395
- _See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.1.6/src/commands/sobject/list.ts)_
7424
+ _See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.1.7/src/commands/sobject/list.ts)_
7396
7425
 
7397
7426
  ## `sf static-resource generate`
7398
7427
 
@@ -7452,7 +7481,7 @@ FLAG DESCRIPTIONS
7452
7481
  etc.
7453
7482
  ```
7454
7483
 
7455
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.19/src/commands/static-resource/generate.ts)_
7484
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.21/src/commands/static-resource/generate.ts)_
7456
7485
 
7457
7486
  ## `sf update [CHANNEL]`
7458
7487
 
@@ -7489,7 +7518,7 @@ EXAMPLES
7489
7518
  $ sf update --available
7490
7519
  ```
7491
7520
 
7492
- _See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/4.1.14/src/commands/update.ts)_
7521
+ _See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/4.1.16/src/commands/update.ts)_
7493
7522
 
7494
7523
  ## `sf version`
7495
7524
 
@@ -7564,7 +7593,7 @@ FLAG DESCRIPTIONS
7564
7593
  Supplied parameter values or default values are filled into a copy of the template.
7565
7594
  ```
7566
7595
 
7567
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.19/src/commands/visualforce/generate/component.ts)_
7596
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.21/src/commands/visualforce/generate/component.ts)_
7568
7597
 
7569
7598
  ## `sf visualforce generate page`
7570
7599
 
@@ -7612,7 +7641,7 @@ FLAG DESCRIPTIONS
7612
7641
  The name can be up to 40 characters and must start with a letter.
7613
7642
  ```
7614
7643
 
7615
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.19/src/commands/visualforce/generate/page.ts)_
7644
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.21/src/commands/visualforce/generate/page.ts)_
7616
7645
 
7617
7646
  ## `sf which`
7618
7647
 
@@ -7634,6 +7663,6 @@ EXAMPLES
7634
7663
  $ sf which help
7635
7664
  ```
7636
7665
 
7637
- _See code: [@oclif/plugin-which](https://github.com/oclif/plugin-which/blob/3.1.1/src/commands/which.ts)_
7666
+ _See code: [@oclif/plugin-which](https://github.com/oclif/plugin-which/blob/3.1.2/src/commands/which.ts)_
7638
7667
 
7639
7668
  <!-- commandsstop -->