@salesforce/cli 1.17.0 → 1.20.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 CHANGED
@@ -2,6 +2,12 @@
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.20.0](https://github.com/salesforcecli/cli/compare/v1.19.0...v1.20.0) (2022-03-23)
6
+
7
+ ## [1.19.0](https://github.com/salesforcecli/cli/compare/v1.18.0...v1.19.0) (2022-03-16)
8
+
9
+ ## [1.18.0](https://github.com/salesforcecli/cli/compare/v1.17.0...v1.18.0) (2022-03-09)
10
+
5
11
  ## [1.17.0](https://github.com/salesforcecli/cli/compare/v1.16.0...v1.17.0) (2022-03-02)
6
12
 
7
13
  ## [1.16.0](https://github.com/salesforcecli/cli/compare/v1.15.0...v1.16.0) (2022-02-23)
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.17.0 linux-x64 node-v14.19.0
34
+ @salesforce/cli/1.20.0 linux-x64 node-v14.19.1
35
35
  $ sf --help [COMMAND]
36
36
  USAGE
37
37
  $ sf COMMAND
@@ -52,6 +52,7 @@ USAGE
52
52
  - [`sf deploy`](#sf-deploy)
53
53
  - [`sf deploy functions`](#sf-deploy-functions)
54
54
  - [`sf deploy metadata`](#sf-deploy-metadata)
55
+ - [`sf env compute collaborator add`](#sf-env-compute-collaborator-add)
55
56
  - [`sf env create compute`](#sf-env-create-compute)
56
57
  - [`sf env delete`](#sf-env-delete)
57
58
  - [`sf env display`](#sf-env-display)
@@ -78,10 +79,13 @@ USAGE
78
79
  - [`sf logout functions`](#sf-logout-functions)
79
80
  - [`sf logout org`](#sf-logout-org)
80
81
  - [`sf plugins`](#sf-plugins)
81
- - [`sf plugins:inspect PLUGIN...`](#sf-pluginsinspect-plugin)
82
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)
83
85
  - [`sf plugins:link PLUGIN`](#sf-pluginslink-plugin)
84
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)
85
89
  - [`sf plugins update`](#sf-plugins-update)
86
90
  - [`sf retrieve metadata`](#sf-retrieve-metadata)
87
91
  - [`sf run function`](#sf-run-function)
@@ -90,6 +94,7 @@ USAGE
90
94
  - [`sf run function start local`](#sf-run-function-start-local)
91
95
  - [`sf update [CHANNEL]`](#sf-update-channel)
92
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)
93
98
  - [`sf whoami functions`](#sf-whoami-functions)
94
99
 
95
100
  ## `sf autocomplete [SHELL]`
@@ -322,7 +327,7 @@ EXAMPLES
322
327
  $ sf deploy --interactive
323
328
  ```
324
329
 
325
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/v1.1.1/src/commands/deploy.ts)_
330
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/v1.2.0/src/commands/deploy.ts)_
326
331
 
327
332
  ## `sf deploy functions`
328
333
 
@@ -344,17 +349,24 @@ Deploy metadata in source format to an org from your local project.
344
349
 
345
350
  ```
346
351
  USAGE
347
- $ sf deploy metadata [--json] [-m <value> | -x <value> | -d <value>] [-o <value>] [-l
348
- 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>]
349
354
 
350
355
  FLAGS
356
+ -a, --api-version=<value> Target API version for the deploy.
351
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.
352
359
  -l, --test-level=<option> [default: NoTestRun] Deployment Apex testing level.
353
360
  <options: NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg>
354
361
  -m, --metadata=<value>... Metadata component names to deploy.
355
362
  -o, --target-org=<value> Login username or alias for the target org.
356
- -w, --wait=<value> [default: 33] Number of minutes to wait for command to complete and display results.
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.
357
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.
358
370
 
359
371
  GLOBAL FLAGS
360
372
  --json Format output as json.
@@ -410,6 +422,11 @@ EXAMPLES
410
422
  $ sf deploy metadata --metadata ApexClass --test-level RunLocalTests
411
423
 
412
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
+
413
430
  -d, --source-dir=<value>... Path to the local source files to deploy.
414
431
 
415
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
@@ -417,6 +434,11 @@ FLAG DESCRIPTIONS
417
434
 
418
435
  If you specify this flag, don’t specify --metadata or --manifest.
419
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
+
420
442
  -l, --test-level=NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg Deployment Apex testing level.
421
443
 
422
444
  Valid values are:
@@ -443,7 +465,18 @@ FLAG DESCRIPTIONS
443
465
 
444
466
  Overrides your default org.
445
467
 
446
- -w, --wait=<value> Number of minutes to wait for command to complete and display results.
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.
447
480
 
448
481
  If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
449
482
 
@@ -456,10 +489,25 @@ CONFIGURATION VARIABLES
456
489
  apiVersion API version of your project. Default: API version of your Dev Hub org.
457
490
 
458
491
  ENVIRONMENT VARIABLES
459
- SF_TARGET_ORG Username or alias of your default org. Overrides the target-org configuration variable.
460
- SFDX_DEFAULTUSERNAME Username or alias of your default org. Overrides the defaultusername configuration value.
461
- SFDX_USE_PROGRESS_BAR Set to false to disable the progress bar when running force:mdapi:deploy, force:source:deploy,
462
- or force:source:push.
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.
494
+ ```
495
+
496
+ ## `sf env compute collaborator add`
497
+
498
+ Add a Heroku user as a collaborator on this Functions account, allowing them to attach Heroku add-ons to compute environments.
499
+
500
+ ```
501
+ USAGE
502
+ $ sf env compute collaborator add -h <value>
503
+
504
+ FLAGS
505
+ -h, --heroku-user=<value> (required) Email address of the Heroku user you're adding as a collaborator.
506
+
507
+ EXAMPLES
508
+ Add a Heroku user as a collaborator on this Functions account.
509
+
510
+ $ sf env compute collaborator add --heroku-user example@heroku.com
463
511
  ```
464
512
 
465
513
  ## `sf env create compute`
@@ -784,10 +832,11 @@ Display a single config variable for an environment.
784
832
 
785
833
  ```
786
834
  USAGE
787
- $ sf env var get [KEY] [-e <value> | ]
835
+ $ sf env var get [KEY] [-e <value> | ] [-j]
788
836
 
789
837
  FLAGS
790
838
  -e, --target-compute=<value> Environment name.
839
+ -j, --json Output list in JSON format.
791
840
 
792
841
  DESCRIPTION
793
842
  Display a single config variable for an environment.
@@ -1003,7 +1052,7 @@ DESCRIPTION
1003
1052
  Display help for sf.
1004
1053
  ```
1005
1054
 
1006
- _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.11/src/commands/help.ts)_
1055
+ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.12/src/commands/help.ts)_
1007
1056
 
1008
1057
  ## `sf info:releasenotes:display [-v <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
1009
1058
 
@@ -1070,7 +1119,7 @@ EXAMPLES
1070
1119
  $ sf login
1071
1120
  ```
1072
1121
 
1073
- _See code: [@salesforce/plugin-login](https://github.com/salesforcecli/plugin-login/blob/v1.0.8/src/commands/login.ts)_
1122
+ _See code: [@salesforce/plugin-login](https://github.com/salesforcecli/plugin-login/blob/v1.0.9/src/commands/login.ts)_
1074
1123
 
1075
1124
  ## `sf login functions`
1076
1125
 
@@ -1337,7 +1386,7 @@ EXAMPLES
1337
1386
  $ sf logout --no-prompt
1338
1387
  ```
1339
1388
 
1340
- _See code: [@salesforce/plugin-login](https://github.com/salesforcecli/plugin-login/blob/v1.0.8/src/commands/logout.ts)_
1389
+ _See code: [@salesforce/plugin-login](https://github.com/salesforcecli/plugin-login/blob/v1.0.9/src/commands/logout.ts)_
1341
1390
 
1342
1391
  ## `sf logout functions`
1343
1392
 
@@ -1412,6 +1461,44 @@ EXAMPLES
1412
1461
 
1413
1462
  _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.0/src/commands/plugins/index.ts)_
1414
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
+
1415
1502
  ## `sf plugins:inspect PLUGIN...`
1416
1503
 
1417
1504
  Displays installation properties of a plugin.
@@ -1522,6 +1609,52 @@ ALIASES
1522
1609
  $ sf plugins remove
1523
1610
  ```
1524
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
+
1525
1658
  ## `sf plugins update`
1526
1659
 
1527
1660
  Update installed plugins.
@@ -1553,8 +1686,8 @@ FLAGS
1553
1686
  -m, --metadata=<value>... Metadata component names to retrieve.
1554
1687
  -n, --package-name=<value>... Package names to retrieve.
1555
1688
  -o, --target-org=<value> Login username or alias for the target org.
1556
- -w, --wait=<value> [default: 33] Number of minutes to wait for the command to complete and display results
1557
- 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.
1558
1691
  -x, --manifest=<value> File path for the manifest (package.xml) that specifies the components to retrieve.
1559
1692
 
1560
1693
  GLOBAL FLAGS
@@ -1677,7 +1810,7 @@ USAGE
1677
1810
 
1678
1811
  FLAGS
1679
1812
  -b, --debug-port=<value> [default: 9229] Port for remote debugging.
1680
- -l, --language=(javascript|typescript|java|auto) [default: auto]
1813
+ -l, --language=(javascript|typescript|java|auto) [default: auto] The language that the function runs in.
1681
1814
  -p, --port=<value> [default: 8080] Port for running the function.
1682
1815
  -v, --verbose Output additional logs.
1683
1816
 
@@ -1813,6 +1946,42 @@ USAGE
1813
1946
 
1814
1947
  _See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/v1.0.4/src/commands/version.ts)_
1815
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
+
1816
1985
  ## `sf whoami functions`
1817
1986
 
1818
1987
  Show information on your Salesforce Functions login.
@@ -0,0 +1,27 @@
1
+ "use strict";
2
+ /*
3
+ * Copyright (c) 2022, salesforce.com, inc.
4
+ * All rights reserved.
5
+ * Licensed under the BSD 3-Clause license.
6
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
7
+ */
8
+ Object.defineProperty(exports, "__esModule", { value: true });
9
+ const core_1 = require("@oclif/core");
10
+ const sf_plugins_core_1 = require("@salesforce/sf-plugins-core");
11
+ const hook = async function ({ config, matches, argv }) {
12
+ const prompter = new sf_plugins_core_1.Prompter();
13
+ const { command } = await prompter.timedPrompt([
14
+ {
15
+ name: 'command',
16
+ type: 'list',
17
+ message: 'Which of these commands do you mean',
18
+ choices: matches.map((p) => (0, core_1.toConfiguredId)(p.id, config)),
19
+ },
20
+ ]);
21
+ if (argv.includes('--help') || argv.includes('-h')) {
22
+ return config.runCommand('help', [(0, core_1.toStandardizedId)(command, config)]);
23
+ }
24
+ return config.runCommand((0, core_1.toStandardizedId)(command, config), argv);
25
+ };
26
+ exports.default = hook;
27
+ //# sourceMappingURL=incomplete.js.map