@salesforce/cli 1.38.0 → 1.41.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 +6 -0
- package/README.md +105 -31
- package/npm-shrinkwrap.json +30834 -19314
- package/oclif.manifest.json +1 -1
- package/package.json +10 -6
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.41.0](https://github.com/salesforcecli/cli/compare/v1.40.0...v1.41.0) (2022-08-10)
|
|
6
|
+
|
|
7
|
+
## [1.40.0](https://github.com/salesforcecli/cli/compare/v1.39.0...v1.40.0) (2022-08-03)
|
|
8
|
+
|
|
9
|
+
## [1.39.0](https://github.com/salesforcecli/cli/compare/v1.38.0...v1.39.0) (2022-07-27)
|
|
10
|
+
|
|
5
11
|
## [1.38.0](https://github.com/salesforcecli/cli/compare/v1.36.0...v1.38.0) (2022-07-20)
|
|
6
12
|
|
|
7
13
|
### Features
|
package/README.md
CHANGED
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
- [Getting Started](#getting-started)
|
|
12
12
|
- [Feedback](#feedback)
|
|
13
13
|
- [Usage](#usage)
|
|
14
|
+
- [Architecture](#architecture)
|
|
14
15
|
- [Commands](#commands)
|
|
15
16
|
<!-- tocstop -->
|
|
16
17
|
|
|
@@ -31,7 +32,7 @@ $ npm install -g @salesforce/cli
|
|
|
31
32
|
$ sf COMMAND
|
|
32
33
|
running command...
|
|
33
34
|
$ sf (--version|-v)
|
|
34
|
-
@salesforce/cli/1.
|
|
35
|
+
@salesforce/cli/1.41.0 linux-x64 node-v14.20.0
|
|
35
36
|
$ sf --help [COMMAND]
|
|
36
37
|
USAGE
|
|
37
38
|
$ sf COMMAND
|
|
@@ -40,6 +41,10 @@ USAGE
|
|
|
40
41
|
|
|
41
42
|
<!-- usagestop -->
|
|
42
43
|
|
|
44
|
+
# Architecture
|
|
45
|
+
|
|
46
|
+
See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI.
|
|
47
|
+
|
|
43
48
|
# Commands
|
|
44
49
|
|
|
45
50
|
<!-- commands -->
|
|
@@ -96,6 +101,7 @@ USAGE
|
|
|
96
101
|
- [`sf plugins:install PLUGIN...`](#sf-pluginsinstall-plugin-1)
|
|
97
102
|
- [`sf plugins:link PLUGIN`](#sf-pluginslink-plugin)
|
|
98
103
|
- [`sf plugins:uninstall PLUGIN...`](#sf-pluginsuninstall-plugin)
|
|
104
|
+
- [`sf plugins:trust:verify -n <string> [-r <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sf-pluginstrustverify--n-string--r-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
|
|
99
105
|
- [`sf plugins:uninstall PLUGIN...`](#sf-pluginsuninstall-plugin-1)
|
|
100
106
|
- [`sf plugins:uninstall PLUGIN...`](#sf-pluginsuninstall-plugin-2)
|
|
101
107
|
- [`sf plugins update`](#sf-plugins-update)
|
|
@@ -104,6 +110,7 @@ USAGE
|
|
|
104
110
|
- [`sf run function start`](#sf-run-function-start)
|
|
105
111
|
- [`sf run function start container`](#sf-run-function-start-container)
|
|
106
112
|
- [`sf run function start local`](#sf-run-function-start-local)
|
|
113
|
+
- [`sf search`](#sf-search)
|
|
107
114
|
- [`sf update [CHANNEL]`](#sf-update-channel)
|
|
108
115
|
- [`sf version`](#sf-version)
|
|
109
116
|
- [`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)
|
|
@@ -347,16 +354,18 @@ Deploy a Salesforce Function to an org from your local project.
|
|
|
347
354
|
|
|
348
355
|
```
|
|
349
356
|
USAGE
|
|
350
|
-
$ sf deploy functions -o <value> [-b <value>] [--force] [-q]
|
|
357
|
+
$ sf deploy functions -o <value> [--json] [-b <value>] [--force] [-q]
|
|
351
358
|
|
|
352
359
|
FLAGS
|
|
353
360
|
-b, --branch=<value> Deploy the latest commit from a branch different from the currently active branch.
|
|
354
|
-
-j, --json Output list in JSON format.
|
|
355
361
|
-o, --connected-org=<value> (required) Username or alias for the org that the compute environment should be connected
|
|
356
362
|
to.
|
|
357
363
|
-q, --quiet Limit the amount of output displayed from the deploy process.
|
|
358
364
|
--force Ignore warnings and overwrite remote repository (not allowed in production).
|
|
359
365
|
|
|
366
|
+
GLOBAL FLAGS
|
|
367
|
+
--json Format output as json.
|
|
368
|
+
|
|
360
369
|
DESCRIPTION
|
|
361
370
|
Deploy a Salesforce Function to an org from your local project.
|
|
362
371
|
|
|
@@ -988,13 +997,15 @@ Create a compute environment for use with Salesforce Functions.
|
|
|
988
997
|
|
|
989
998
|
```
|
|
990
999
|
USAGE
|
|
991
|
-
$ sf env create compute [-o <value>] [-a <value>]
|
|
1000
|
+
$ sf env create compute [--json] [-o <value>] [-a <value>]
|
|
992
1001
|
|
|
993
1002
|
FLAGS
|
|
994
1003
|
-a, --alias=<value> Alias for the created environment.
|
|
995
|
-
-j, --json Output list in JSON format.
|
|
996
1004
|
-o, --connected-org=<value> Username or alias for the org that the compute environment should be connected to.
|
|
997
1005
|
|
|
1006
|
+
GLOBAL FLAGS
|
|
1007
|
+
--json Format output as json.
|
|
1008
|
+
|
|
998
1009
|
DESCRIPTION
|
|
999
1010
|
Create a compute environment for use with Salesforce Functions.
|
|
1000
1011
|
|
|
@@ -1227,13 +1238,15 @@ Delete an environment.
|
|
|
1227
1238
|
|
|
1228
1239
|
```
|
|
1229
1240
|
USAGE
|
|
1230
|
-
$ sf env delete [-e <value> | ] [--confirm <value>]
|
|
1241
|
+
$ sf env delete [--json] [-e <value> | ] [--confirm <value>]
|
|
1231
1242
|
|
|
1232
1243
|
FLAGS
|
|
1233
1244
|
-e, --target-compute=<value> Environment name.
|
|
1234
|
-
-j, --json Output list in JSON format.
|
|
1235
1245
|
--confirm=name... Confirmation name.
|
|
1236
1246
|
|
|
1247
|
+
GLOBAL FLAGS
|
|
1248
|
+
--json Format output as json.
|
|
1249
|
+
|
|
1237
1250
|
DESCRIPTION
|
|
1238
1251
|
Delete an environment.
|
|
1239
1252
|
|
|
@@ -1474,13 +1487,15 @@ Add log drain to a specified environment.
|
|
|
1474
1487
|
|
|
1475
1488
|
```
|
|
1476
1489
|
USAGE
|
|
1477
|
-
$ sf env logdrain add [-e <value> | ] [-l <value> | ]
|
|
1490
|
+
$ sf env logdrain add [--json] [-e <value> | ] [-l <value> | ]
|
|
1478
1491
|
|
|
1479
1492
|
FLAGS
|
|
1480
1493
|
-e, --target-compute=<value> Environment name.
|
|
1481
|
-
-j, --json Output list in JSON format.
|
|
1482
1494
|
-l, --drain-url=<value> Endpoint that will receive sent logs.
|
|
1483
1495
|
|
|
1496
|
+
GLOBAL FLAGS
|
|
1497
|
+
--json Format output as json.
|
|
1498
|
+
|
|
1484
1499
|
DESCRIPTION
|
|
1485
1500
|
Add log drain to a specified environment.
|
|
1486
1501
|
|
|
@@ -1499,11 +1514,13 @@ List log drains connected to a specified environment.
|
|
|
1499
1514
|
|
|
1500
1515
|
```
|
|
1501
1516
|
USAGE
|
|
1502
|
-
$ sf env logdrain list [-e <value> | ]
|
|
1517
|
+
$ sf env logdrain list [--json] [-e <value> | ]
|
|
1503
1518
|
|
|
1504
1519
|
FLAGS
|
|
1505
1520
|
-e, --target-compute=<value> Environment name.
|
|
1506
|
-
|
|
1521
|
+
|
|
1522
|
+
GLOBAL FLAGS
|
|
1523
|
+
--json Format output as json.
|
|
1507
1524
|
|
|
1508
1525
|
EXAMPLES
|
|
1509
1526
|
List log drains:
|
|
@@ -1521,13 +1538,15 @@ Remove log drain from a specified environment.
|
|
|
1521
1538
|
|
|
1522
1539
|
```
|
|
1523
1540
|
USAGE
|
|
1524
|
-
$ sf env logdrain remove [-e <value> | ] [-l <value> | ]
|
|
1541
|
+
$ sf env logdrain remove [--json] [-e <value> | ] [-l <value> | ]
|
|
1525
1542
|
|
|
1526
1543
|
FLAGS
|
|
1527
1544
|
-e, --target-compute=<value> Environment name.
|
|
1528
|
-
-j, --json Output list in JSON format.
|
|
1529
1545
|
-l, --drain-url=<value> Log drain url to remove.
|
|
1530
1546
|
|
|
1547
|
+
GLOBAL FLAGS
|
|
1548
|
+
--json Format output as json.
|
|
1549
|
+
|
|
1531
1550
|
DESCRIPTION
|
|
1532
1551
|
Remove log drain from a specified environment.
|
|
1533
1552
|
|
|
@@ -1700,11 +1719,13 @@ Display a single config variable for an environment.
|
|
|
1700
1719
|
|
|
1701
1720
|
```
|
|
1702
1721
|
USAGE
|
|
1703
|
-
$ sf env var get [KEY] [-e <value> | ]
|
|
1722
|
+
$ sf env var get [KEY] [--json] [-e <value> | ]
|
|
1704
1723
|
|
|
1705
1724
|
FLAGS
|
|
1706
1725
|
-e, --target-compute=<value> Environment name.
|
|
1707
|
-
|
|
1726
|
+
|
|
1727
|
+
GLOBAL FLAGS
|
|
1728
|
+
--json Format output as json.
|
|
1708
1729
|
|
|
1709
1730
|
DESCRIPTION
|
|
1710
1731
|
Display a single config variable for an environment.
|
|
@@ -1723,11 +1744,13 @@ List your environment's config vars in a table.
|
|
|
1723
1744
|
|
|
1724
1745
|
```
|
|
1725
1746
|
USAGE
|
|
1726
|
-
$ sf env var list [-e <value> | ]
|
|
1747
|
+
$ sf env var list [--json] [-e <value> | ]
|
|
1727
1748
|
|
|
1728
1749
|
FLAGS
|
|
1729
1750
|
-e, --target-compute=<value> Environment name.
|
|
1730
|
-
|
|
1751
|
+
|
|
1752
|
+
GLOBAL FLAGS
|
|
1753
|
+
--json Format output as json.
|
|
1731
1754
|
|
|
1732
1755
|
DESCRIPTION
|
|
1733
1756
|
List your environment's config vars in a table.
|
|
@@ -1750,11 +1773,13 @@ Set a single config value for an environment.
|
|
|
1750
1773
|
|
|
1751
1774
|
```
|
|
1752
1775
|
USAGE
|
|
1753
|
-
$ sf env var set [-e <value> | ]
|
|
1776
|
+
$ sf env var set [--json] [-e <value> | ]
|
|
1754
1777
|
|
|
1755
1778
|
FLAGS
|
|
1756
1779
|
-e, --target-compute=<value> Environment name.
|
|
1757
|
-
|
|
1780
|
+
|
|
1781
|
+
GLOBAL FLAGS
|
|
1782
|
+
--json Format output as json.
|
|
1758
1783
|
|
|
1759
1784
|
EXAMPLES
|
|
1760
1785
|
Set a config value:
|
|
@@ -1768,11 +1793,13 @@ Unset a single config value for an environment.
|
|
|
1768
1793
|
|
|
1769
1794
|
```
|
|
1770
1795
|
USAGE
|
|
1771
|
-
$ sf env var unset [-e <value> | ]
|
|
1796
|
+
$ sf env var unset [--json] [-e <value> | ]
|
|
1772
1797
|
|
|
1773
1798
|
FLAGS
|
|
1774
1799
|
-e, --target-compute=<value> Environment name.
|
|
1775
|
-
|
|
1800
|
+
|
|
1801
|
+
GLOBAL FLAGS
|
|
1802
|
+
--json Format output as json.
|
|
1776
1803
|
|
|
1777
1804
|
DESCRIPTION
|
|
1778
1805
|
Unset a single config value for an environment.
|
|
@@ -2016,18 +2043,20 @@ Login using JWT instead of default web-based flow. This will authenticate you wi
|
|
|
2016
2043
|
|
|
2017
2044
|
```
|
|
2018
2045
|
USAGE
|
|
2019
|
-
$ sf login functions jwt -u <value> -f <value> -i <value> [-l <value> | ] [-
|
|
2046
|
+
$ sf login functions jwt -u <value> -f <value> -i <value> [--json] [-l <value> | ] [-a <value>] [-d] [-v]
|
|
2020
2047
|
|
|
2021
2048
|
FLAGS
|
|
2022
2049
|
-a, --alias=<value> Alias for the org.
|
|
2023
2050
|
-d, --set-default Set the org as the default that all org-related commands run against.
|
|
2024
2051
|
-f, --keyfile=<value> (required) Path to JWT keyfile.
|
|
2025
2052
|
-i, --clientid=<value> (required) OAuth client ID.
|
|
2026
|
-
-j, --json Output list in JSON format.
|
|
2027
2053
|
-l, --instance-url=<value> The login URL of the instance the org lives on.
|
|
2028
2054
|
-u, --username=<value> (required) Authentication username.
|
|
2029
2055
|
-v, --set-default-dev-hub Set the org as the default Dev Hub for scratch org creation.
|
|
2030
2056
|
|
|
2057
|
+
GLOBAL FLAGS
|
|
2058
|
+
--json Format output as json.
|
|
2059
|
+
|
|
2031
2060
|
DESCRIPTION
|
|
2032
2061
|
Login using JWT instead of default web-based flow. This will authenticate you with both sf and Salesforce Functions.
|
|
2033
2062
|
|
|
@@ -2264,10 +2293,10 @@ Log out of your Salesforce Functions account.
|
|
|
2264
2293
|
|
|
2265
2294
|
```
|
|
2266
2295
|
USAGE
|
|
2267
|
-
$ sf logout functions [
|
|
2296
|
+
$ sf logout functions [--json]
|
|
2268
2297
|
|
|
2269
|
-
FLAGS
|
|
2270
|
-
|
|
2298
|
+
GLOBAL FLAGS
|
|
2299
|
+
--json Format output as json.
|
|
2271
2300
|
|
|
2272
2301
|
EXAMPLES
|
|
2273
2302
|
Log out:
|
|
@@ -2482,6 +2511,33 @@ ALIASES
|
|
|
2482
2511
|
$ sf plugins remove
|
|
2483
2512
|
```
|
|
2484
2513
|
|
|
2514
|
+
## `sf plugins:trust:verify -n <string> [-r <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
|
|
2515
|
+
|
|
2516
|
+
Validate a digital signature for a npm package.
|
|
2517
|
+
|
|
2518
|
+
```
|
|
2519
|
+
USAGE
|
|
2520
|
+
$ sf plugins trust verify -n <string> [-r <string>] [--json] [--loglevel
|
|
2521
|
+
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
|
|
2522
|
+
|
|
2523
|
+
FLAGS
|
|
2524
|
+
-n, --npm=<value> (required) Specify the npm name.
|
|
2525
|
+
This can include a tag/version.
|
|
2526
|
+
-r, --registry=<value> The registry name. The behavior is
|
|
2527
|
+
the same as npm.
|
|
2528
|
+
--json format output as json
|
|
2529
|
+
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
|
|
2530
|
+
this command invocation
|
|
2531
|
+
|
|
2532
|
+
DESCRIPTION
|
|
2533
|
+
Validate a digital signature for a npm package.
|
|
2534
|
+
|
|
2535
|
+
EXAMPLES
|
|
2536
|
+
$ sf plugins trust verify --npm @scope/npmName --registry http://my.repo.org:4874
|
|
2537
|
+
|
|
2538
|
+
$ sf plugins trust verify --npm @scope/npmName
|
|
2539
|
+
```
|
|
2540
|
+
|
|
2485
2541
|
## `sf plugins:uninstall PLUGIN...`
|
|
2486
2542
|
|
|
2487
2543
|
Removes a plugin from the CLI.
|
|
@@ -2666,16 +2722,18 @@ Send a cloudevent to a function.
|
|
|
2666
2722
|
|
|
2667
2723
|
```
|
|
2668
2724
|
USAGE
|
|
2669
|
-
$ sf run function [-l <value> | ] [-H <value>] [-p <value>] [-s] [-o <value>]
|
|
2725
|
+
$ sf run function [--json] [-l <value> | ] [-H <value>] [-p <value>] [-s] [-o <value>]
|
|
2670
2726
|
|
|
2671
2727
|
FLAGS
|
|
2672
2728
|
-H, --headers=<value>... Set headers.
|
|
2673
|
-
-j, --json Output list in JSON format.
|
|
2674
2729
|
-l, --function-url=<value> URL of the function to run.
|
|
2675
2730
|
-o, --connected-org=<value> Username or alias for the target org; overrides default target org.
|
|
2676
2731
|
-p, --payload=<value> Set the payload of the cloudevent as a JSON object or a path to a file via @file.json.
|
|
2677
2732
|
-s, --structured Set the cloudevent to be emitted as a structured JSON cloudevent.
|
|
2678
2733
|
|
|
2734
|
+
GLOBAL FLAGS
|
|
2735
|
+
--json Format output as json.
|
|
2736
|
+
|
|
2679
2737
|
EXAMPLES
|
|
2680
2738
|
Run a function:
|
|
2681
2739
|
|
|
@@ -2786,6 +2844,22 @@ EXAMPLES
|
|
|
2786
2844
|
$ sf run function start local --port 5000 --language javascript
|
|
2787
2845
|
```
|
|
2788
2846
|
|
|
2847
|
+
## `sf search`
|
|
2848
|
+
|
|
2849
|
+
Search for a command.
|
|
2850
|
+
|
|
2851
|
+
```
|
|
2852
|
+
USAGE
|
|
2853
|
+
$ sf search
|
|
2854
|
+
|
|
2855
|
+
DESCRIPTION
|
|
2856
|
+
Search for a command.
|
|
2857
|
+
|
|
2858
|
+
Once you select a command, hit enter and it will show the help for that command.
|
|
2859
|
+
```
|
|
2860
|
+
|
|
2861
|
+
_See code: [@oclif/plugin-search](https://github.com/oclif/plugin-search/blob/v0.0.1/dist/commands/search.ts)_
|
|
2862
|
+
|
|
2789
2863
|
## `sf update [CHANNEL]`
|
|
2790
2864
|
|
|
2791
2865
|
update the sf CLI
|
|
@@ -2885,10 +2959,10 @@ Show information on your Salesforce Functions login.
|
|
|
2885
2959
|
|
|
2886
2960
|
```
|
|
2887
2961
|
USAGE
|
|
2888
|
-
$ sf whoami functions [
|
|
2962
|
+
$ sf whoami functions [--json]
|
|
2889
2963
|
|
|
2890
|
-
FLAGS
|
|
2891
|
-
|
|
2964
|
+
GLOBAL FLAGS
|
|
2965
|
+
--json Format output as json.
|
|
2892
2966
|
|
|
2893
2967
|
DESCRIPTION
|
|
2894
2968
|
Show information on your Salesforce Functions login.
|