@salesforce/cli 1.19.0 → 1.22.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +10 -0
- package/README.md +167 -17
- package/npm-shrinkwrap.json +1261 -3350
- package/oclif.manifest.json +1 -1
- package/package.json +19 -19
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,16 @@
|
|
|
2
2
|
|
|
3
3
|
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
|
|
4
4
|
|
|
5
|
+
## [1.22.0](https://github.com/salesforcecli/cli/compare/v1.21.0...v1.22.0) (2022-03-31)
|
|
6
|
+
|
|
7
|
+
## [1.21.0](https://github.com/salesforcecli/cli/compare/v1.20.0...v1.21.0) (2022-03-30)
|
|
8
|
+
|
|
9
|
+
### Bug Fixes
|
|
10
|
+
|
|
11
|
+
- bump minor verisons & run npx yarn-deduplicate ([7392c04](https://github.com/salesforcecli/cli/commit/7392c04522b4c43cefbf37378e0089b8566b23f4))
|
|
12
|
+
|
|
13
|
+
## [1.20.0](https://github.com/salesforcecli/cli/compare/v1.19.0...v1.20.0) (2022-03-23)
|
|
14
|
+
|
|
5
15
|
## [1.19.0](https://github.com/salesforcecli/cli/compare/v1.18.0...v1.19.0) (2022-03-16)
|
|
6
16
|
|
|
7
17
|
## [1.18.0](https://github.com/salesforcecli/cli/compare/v1.17.0...v1.18.0) (2022-03-09)
|
package/README.md
CHANGED
|
@@ -31,7 +31,7 @@ $ npm install -g @salesforce/cli
|
|
|
31
31
|
$ sf COMMAND
|
|
32
32
|
running command...
|
|
33
33
|
$ sf (--version|-v)
|
|
34
|
-
@salesforce/cli/1.
|
|
34
|
+
@salesforce/cli/1.22.0 linux-x64 node-v14.19.1
|
|
35
35
|
$ sf --help [COMMAND]
|
|
36
36
|
USAGE
|
|
37
37
|
$ sf COMMAND
|
|
@@ -79,10 +79,13 @@ USAGE
|
|
|
79
79
|
- [`sf logout functions`](#sf-logout-functions)
|
|
80
80
|
- [`sf logout org`](#sf-logout-org)
|
|
81
81
|
- [`sf plugins`](#sf-plugins)
|
|
82
|
-
- [`sf plugins:inspect PLUGIN...`](#sf-pluginsinspect-plugin)
|
|
83
82
|
- [`sf plugins:install PLUGIN...`](#sf-pluginsinstall-plugin)
|
|
83
|
+
- [`sf plugins:inspect PLUGIN...`](#sf-pluginsinspect-plugin)
|
|
84
|
+
- [`sf plugins:install PLUGIN...`](#sf-pluginsinstall-plugin-1)
|
|
84
85
|
- [`sf plugins:link PLUGIN`](#sf-pluginslink-plugin)
|
|
85
86
|
- [`sf plugins:uninstall PLUGIN...`](#sf-pluginsuninstall-plugin)
|
|
87
|
+
- [`sf plugins:uninstall PLUGIN...`](#sf-pluginsuninstall-plugin-1)
|
|
88
|
+
- [`sf plugins:uninstall PLUGIN...`](#sf-pluginsuninstall-plugin-2)
|
|
86
89
|
- [`sf plugins update`](#sf-plugins-update)
|
|
87
90
|
- [`sf retrieve metadata`](#sf-retrieve-metadata)
|
|
88
91
|
- [`sf run function`](#sf-run-function)
|
|
@@ -91,6 +94,7 @@ USAGE
|
|
|
91
94
|
- [`sf run function start local`](#sf-run-function-start-local)
|
|
92
95
|
- [`sf update [CHANNEL]`](#sf-update-channel)
|
|
93
96
|
- [`sf version`](#sf-version)
|
|
97
|
+
- [`sf whatsnew [-v <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sf-whatsnew--v-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
|
|
94
98
|
- [`sf whoami functions`](#sf-whoami-functions)
|
|
95
99
|
|
|
96
100
|
## `sf autocomplete [SHELL]`
|
|
@@ -323,7 +327,7 @@ EXAMPLES
|
|
|
323
327
|
$ sf deploy --interactive
|
|
324
328
|
```
|
|
325
329
|
|
|
326
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/v1.
|
|
330
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/v1.2.0/src/commands/deploy.ts)_
|
|
327
331
|
|
|
328
332
|
## `sf deploy functions`
|
|
329
333
|
|
|
@@ -345,17 +349,24 @@ Deploy metadata in source format to an org from your local project.
|
|
|
345
349
|
|
|
346
350
|
```
|
|
347
351
|
USAGE
|
|
348
|
-
$ sf deploy metadata [--json] [-
|
|
349
|
-
NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg] [-w <value>]
|
|
352
|
+
$ sf deploy metadata [--json] [-a <value>] [--dry-run] [-r] [-g] [-x <value>] [-m <value>] [-d <value>] [-o
|
|
353
|
+
<value>] [-t <value>] [-l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg] [--verbose] [-w <value>]
|
|
350
354
|
|
|
351
355
|
FLAGS
|
|
356
|
+
-a, --api-version=<value> Target API version for the deploy.
|
|
352
357
|
-d, --source-dir=<value>... Path to the local source files to deploy.
|
|
358
|
+
-g, --ignore-warnings Ignore warnings and allow a deployment to complete successfully.
|
|
353
359
|
-l, --test-level=<option> [default: NoTestRun] Deployment Apex testing level.
|
|
354
360
|
<options: NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg>
|
|
355
361
|
-m, --metadata=<value>... Metadata component names to deploy.
|
|
356
362
|
-o, --target-org=<value> Login username or alias for the target org.
|
|
357
|
-
-
|
|
363
|
+
-r, --ignore-errors Ignore any errors and don’t roll back deployment.
|
|
364
|
+
-t, --tests=<value>... [default: ] Apex tests to run when --test-level is RunSpecifiedTests.
|
|
365
|
+
-w, --wait=<minutes> [default: [object Object]] Number of minutes to wait for command to complete and display
|
|
366
|
+
results.
|
|
358
367
|
-x, --manifest=<value> Full file path for manifest (package.xml) of components to deploy.
|
|
368
|
+
--dry-run Validate deploy and run Apex tests but don’t save to the org.
|
|
369
|
+
--verbose Show verbose output of the deploy result.
|
|
359
370
|
|
|
360
371
|
GLOBAL FLAGS
|
|
361
372
|
--json Format output as json.
|
|
@@ -411,6 +422,11 @@ EXAMPLES
|
|
|
411
422
|
$ sf deploy metadata --metadata ApexClass --test-level RunLocalTests
|
|
412
423
|
|
|
413
424
|
FLAG DESCRIPTIONS
|
|
425
|
+
-a, --api-version=<value> Target API version for the deploy.
|
|
426
|
+
|
|
427
|
+
Use this flag to override the default API version, which is the latest version supported the CLI, with the API
|
|
428
|
+
version of your package.xml file.
|
|
429
|
+
|
|
414
430
|
-d, --source-dir=<value>... Path to the local source files to deploy.
|
|
415
431
|
|
|
416
432
|
The supplied path can be to a single file (in which case the operation is applied to only one file) or to a folder
|
|
@@ -418,6 +434,11 @@ FLAG DESCRIPTIONS
|
|
|
418
434
|
|
|
419
435
|
If you specify this flag, don’t specify --metadata or --manifest.
|
|
420
436
|
|
|
437
|
+
-g, --ignore-warnings Ignore warnings and allow a deployment to complete successfully.
|
|
438
|
+
|
|
439
|
+
If a warning occurs and this flag is set to true, the success status of the deployment is set to true. When this
|
|
440
|
+
flag is set to false, success is set to false, and the warning is treated like an error.
|
|
441
|
+
|
|
421
442
|
-l, --test-level=NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg Deployment Apex testing level.
|
|
422
443
|
|
|
423
444
|
Valid values are:
|
|
@@ -444,7 +465,18 @@ FLAG DESCRIPTIONS
|
|
|
444
465
|
|
|
445
466
|
Overrides your default org.
|
|
446
467
|
|
|
447
|
-
-
|
|
468
|
+
-r, --ignore-errors Ignore any errors and don’t roll back deployment.
|
|
469
|
+
|
|
470
|
+
When deploying to a production org, keep this flag set to false (default value). When set to true, components
|
|
471
|
+
without errors are deployed and components with errors are skipped, and could result in an inconsistent production
|
|
472
|
+
org.
|
|
473
|
+
|
|
474
|
+
-t, --tests=<value>... Apex tests to run when --test-level is RunSpecifiedTests.
|
|
475
|
+
|
|
476
|
+
Separate multiple test names with commas, and enclose the entire flag value in double quotes if a test contains a
|
|
477
|
+
space.
|
|
478
|
+
|
|
479
|
+
-w, --wait=<minutes> Number of minutes to wait for command to complete and display results.
|
|
448
480
|
|
|
449
481
|
If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
|
|
450
482
|
|
|
@@ -457,11 +489,8 @@ CONFIGURATION VARIABLES
|
|
|
457
489
|
apiVersion API version of your project. Default: API version of your Dev Hub org.
|
|
458
490
|
|
|
459
491
|
ENVIRONMENT VARIABLES
|
|
460
|
-
SF_TARGET_ORG
|
|
461
|
-
|
|
462
|
-
SFDX_USE_PROGRESS_BAR Set to false to disable the progress bar when running force:mdapi:deploy, force:source:deploy,
|
|
463
|
-
or force:source:push.
|
|
464
|
-
SF_USE_PROGRESS_BAR Set to false to disable the progress bar when running the metadata deploy command.
|
|
492
|
+
SF_TARGET_ORG Username or alias of your default org. Overrides the target-org configuration variable.
|
|
493
|
+
SF_USE_PROGRESS_BAR Set to false to disable the progress bar when running the metadata deploy command.
|
|
465
494
|
```
|
|
466
495
|
|
|
467
496
|
## `sf env compute collaborator add`
|
|
@@ -803,10 +832,11 @@ Display a single config variable for an environment.
|
|
|
803
832
|
|
|
804
833
|
```
|
|
805
834
|
USAGE
|
|
806
|
-
$ sf env var get [KEY] [-e <value> | ]
|
|
835
|
+
$ sf env var get [KEY] [-e <value> | ] [-j]
|
|
807
836
|
|
|
808
837
|
FLAGS
|
|
809
838
|
-e, --target-compute=<value> Environment name.
|
|
839
|
+
-j, --json Output list in JSON format.
|
|
810
840
|
|
|
811
841
|
DESCRIPTION
|
|
812
842
|
Display a single config variable for an environment.
|
|
@@ -1089,7 +1119,7 @@ EXAMPLES
|
|
|
1089
1119
|
$ sf login
|
|
1090
1120
|
```
|
|
1091
1121
|
|
|
1092
|
-
_See code: [@salesforce/plugin-login](https://github.com/salesforcecli/plugin-login/blob/v1.0.
|
|
1122
|
+
_See code: [@salesforce/plugin-login](https://github.com/salesforcecli/plugin-login/blob/v1.0.9/src/commands/login.ts)_
|
|
1093
1123
|
|
|
1094
1124
|
## `sf login functions`
|
|
1095
1125
|
|
|
@@ -1356,7 +1386,7 @@ EXAMPLES
|
|
|
1356
1386
|
$ sf logout --no-prompt
|
|
1357
1387
|
```
|
|
1358
1388
|
|
|
1359
|
-
_See code: [@salesforce/plugin-login](https://github.com/salesforcecli/plugin-login/blob/v1.0.
|
|
1389
|
+
_See code: [@salesforce/plugin-login](https://github.com/salesforcecli/plugin-login/blob/v1.0.9/src/commands/logout.ts)_
|
|
1360
1390
|
|
|
1361
1391
|
## `sf logout functions`
|
|
1362
1392
|
|
|
@@ -1431,6 +1461,44 @@ EXAMPLES
|
|
|
1431
1461
|
|
|
1432
1462
|
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.0/src/commands/plugins/index.ts)_
|
|
1433
1463
|
|
|
1464
|
+
## `sf plugins:install PLUGIN...`
|
|
1465
|
+
|
|
1466
|
+
Installs a plugin into the CLI.
|
|
1467
|
+
|
|
1468
|
+
```
|
|
1469
|
+
USAGE
|
|
1470
|
+
$ sf plugins:install PLUGIN...
|
|
1471
|
+
|
|
1472
|
+
ARGUMENTS
|
|
1473
|
+
PLUGIN Plugin to install.
|
|
1474
|
+
|
|
1475
|
+
FLAGS
|
|
1476
|
+
-f, --force Run yarn install with force flag.
|
|
1477
|
+
-h, --help Show CLI help.
|
|
1478
|
+
-v, --verbose
|
|
1479
|
+
|
|
1480
|
+
DESCRIPTION
|
|
1481
|
+
Installs a plugin into the CLI.
|
|
1482
|
+
|
|
1483
|
+
Can be installed from npm or a git url.
|
|
1484
|
+
|
|
1485
|
+
Installation of a user-installed plugin will override a core plugin.
|
|
1486
|
+
|
|
1487
|
+
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
|
|
1488
|
+
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
|
|
1489
|
+
the CLI without the need to patch and update the whole CLI.
|
|
1490
|
+
|
|
1491
|
+
ALIASES
|
|
1492
|
+
$ sf plugins add
|
|
1493
|
+
|
|
1494
|
+
EXAMPLES
|
|
1495
|
+
$ sf plugins:install myplugin
|
|
1496
|
+
|
|
1497
|
+
$ sf plugins:install https://github.com/someuser/someplugin
|
|
1498
|
+
|
|
1499
|
+
$ sf plugins:install someuser/someplugin
|
|
1500
|
+
```
|
|
1501
|
+
|
|
1434
1502
|
## `sf plugins:inspect PLUGIN...`
|
|
1435
1503
|
|
|
1436
1504
|
Displays installation properties of a plugin.
|
|
@@ -1541,6 +1609,52 @@ ALIASES
|
|
|
1541
1609
|
$ sf plugins remove
|
|
1542
1610
|
```
|
|
1543
1611
|
|
|
1612
|
+
## `sf plugins:uninstall PLUGIN...`
|
|
1613
|
+
|
|
1614
|
+
Removes a plugin from the CLI.
|
|
1615
|
+
|
|
1616
|
+
```
|
|
1617
|
+
USAGE
|
|
1618
|
+
$ sf plugins:uninstall PLUGIN...
|
|
1619
|
+
|
|
1620
|
+
ARGUMENTS
|
|
1621
|
+
PLUGIN plugin to uninstall
|
|
1622
|
+
|
|
1623
|
+
FLAGS
|
|
1624
|
+
-h, --help Show CLI help.
|
|
1625
|
+
-v, --verbose
|
|
1626
|
+
|
|
1627
|
+
DESCRIPTION
|
|
1628
|
+
Removes a plugin from the CLI.
|
|
1629
|
+
|
|
1630
|
+
ALIASES
|
|
1631
|
+
$ sf plugins unlink
|
|
1632
|
+
$ sf plugins remove
|
|
1633
|
+
```
|
|
1634
|
+
|
|
1635
|
+
## `sf plugins:uninstall PLUGIN...`
|
|
1636
|
+
|
|
1637
|
+
Removes a plugin from the CLI.
|
|
1638
|
+
|
|
1639
|
+
```
|
|
1640
|
+
USAGE
|
|
1641
|
+
$ sf plugins:uninstall PLUGIN...
|
|
1642
|
+
|
|
1643
|
+
ARGUMENTS
|
|
1644
|
+
PLUGIN plugin to uninstall
|
|
1645
|
+
|
|
1646
|
+
FLAGS
|
|
1647
|
+
-h, --help Show CLI help.
|
|
1648
|
+
-v, --verbose
|
|
1649
|
+
|
|
1650
|
+
DESCRIPTION
|
|
1651
|
+
Removes a plugin from the CLI.
|
|
1652
|
+
|
|
1653
|
+
ALIASES
|
|
1654
|
+
$ sf plugins unlink
|
|
1655
|
+
$ sf plugins remove
|
|
1656
|
+
```
|
|
1657
|
+
|
|
1544
1658
|
## `sf plugins update`
|
|
1545
1659
|
|
|
1546
1660
|
Update installed plugins.
|
|
@@ -1572,8 +1686,8 @@ FLAGS
|
|
|
1572
1686
|
-m, --metadata=<value>... Metadata component names to retrieve.
|
|
1573
1687
|
-n, --package-name=<value>... Package names to retrieve.
|
|
1574
1688
|
-o, --target-org=<value> Login username or alias for the target org.
|
|
1575
|
-
-w, --wait=<value> [default:
|
|
1576
|
-
to the terminal window.
|
|
1689
|
+
-w, --wait=<value> [default: [object Object]] Number of minutes to wait for the command to complete and
|
|
1690
|
+
display results to the terminal window.
|
|
1577
1691
|
-x, --manifest=<value> File path for the manifest (package.xml) that specifies the components to retrieve.
|
|
1578
1692
|
|
|
1579
1693
|
GLOBAL FLAGS
|
|
@@ -1832,6 +1946,42 @@ USAGE
|
|
|
1832
1946
|
|
|
1833
1947
|
_See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/v1.0.4/src/commands/version.ts)_
|
|
1834
1948
|
|
|
1949
|
+
## `sf whatsnew [-v <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
|
|
1950
|
+
|
|
1951
|
+
Display Salesforce CLI release notes on the command line.
|
|
1952
|
+
|
|
1953
|
+
```
|
|
1954
|
+
USAGE
|
|
1955
|
+
$ sf whatsnew [-v <string>] [--json] [--loglevel
|
|
1956
|
+
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
|
|
1957
|
+
|
|
1958
|
+
FLAGS
|
|
1959
|
+
-v, --version=<value> CLI version or tag for which to
|
|
1960
|
+
display release notes.
|
|
1961
|
+
--json format output as json
|
|
1962
|
+
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
|
|
1963
|
+
this command invocation
|
|
1964
|
+
|
|
1965
|
+
DESCRIPTION
|
|
1966
|
+
Display Salesforce CLI release notes on the command line.
|
|
1967
|
+
|
|
1968
|
+
ALIASES
|
|
1969
|
+
$ sf whatsnew
|
|
1970
|
+
|
|
1971
|
+
EXAMPLES
|
|
1972
|
+
Display release notes for the currently installed CLI version:
|
|
1973
|
+
|
|
1974
|
+
sf whatsnew
|
|
1975
|
+
|
|
1976
|
+
Display release notes for CLI version 7.120.0:
|
|
1977
|
+
|
|
1978
|
+
sf whatsnew --version 7.120.0
|
|
1979
|
+
|
|
1980
|
+
Display release notes for the CLI version that corresponds to a tag (stable, stable-rc, latest, latest-rc, rc):
|
|
1981
|
+
|
|
1982
|
+
sf whatsnew --version latest
|
|
1983
|
+
```
|
|
1984
|
+
|
|
1835
1985
|
## `sf whoami functions`
|
|
1836
1986
|
|
|
1837
1987
|
Show information on your Salesforce Functions login.
|