@salesforce/cli 1.7.0 → 1.10.0-dev

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.
Files changed (6) hide show
  1. package/LICENSE.txt +1 -1
  2. package/README.md +110 -67
  3. package/npm-shrinkwrap.json +60442 -0
  4. package/oclif.manifest.json +1 -1
  5. package/package.json +36 -56
  6. package/CHANGELOG.md +0 -317
package/LICENSE.txt CHANGED
@@ -1,4 +1,4 @@
1
- Copyright (c) 2018, Salesforce.com, Inc.
1
+ Copyright (c) 2022, Salesforce.com, Inc.
2
2
  All rights reserved.
3
3
 
4
4
  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
package/README.md CHANGED
@@ -6,11 +6,12 @@
6
6
  [![License](https://img.shields.io/npm/l/@salesforce/cli.svg)](https://github.com/salesforcecli/cli/blob/master/package.json)
7
7
 
8
8
  <!-- toc -->
9
- * [@salesforce/cli](#salesforcecli)
10
- * [Getting Started](#getting-started)
11
- * [Feedback](#feedback)
12
- * [Usage](#usage)
13
- * [Commands](#commands)
9
+
10
+ - [@salesforce/cli](#salesforcecli)
11
+ - [Getting Started](#getting-started)
12
+ - [Feedback](#feedback)
13
+ - [Usage](#usage)
14
+ - [Commands](#commands)
14
15
  <!-- tocstop -->
15
16
 
16
17
  # Getting Started
@@ -24,68 +25,72 @@ To provide feedback, use create a new issue [here](https://github.com/forcedotco
24
25
  # Usage
25
26
 
26
27
  <!-- usage -->
28
+
27
29
  ```sh-session
28
30
  $ npm install -g @salesforce/cli
29
31
  $ sf COMMAND
30
32
  running command...
31
33
  $ sf (--version|-v)
32
- @salesforce/cli/1.7.0 linux-x64 node-v14.18.2
34
+ @salesforce/cli/1.10.0 linux-x64 node-v14.18.3
33
35
  $ sf --help [COMMAND]
34
36
  USAGE
35
37
  $ sf COMMAND
36
38
  ...
37
39
  ```
40
+
38
41
  <!-- usagestop -->
39
42
 
40
43
  # Commands
41
44
 
42
45
  <!-- commands -->
43
- * [`sf autocomplete [SHELL]`](#sf-autocomplete-shell)
44
- * [`sf config get`](#sf-config-get)
45
- * [`sf config list`](#sf-config-list)
46
- * [`sf config set`](#sf-config-set)
47
- * [`sf config unset`](#sf-config-unset)
48
- * [`sf deploy`](#sf-deploy)
49
- * [`sf deploy functions`](#sf-deploy-functions)
50
- * [`sf deploy metadata`](#sf-deploy-metadata)
51
- * [`sf env create compute`](#sf-env-create-compute)
52
- * [`sf env delete`](#sf-env-delete)
53
- * [`sf env display`](#sf-env-display)
54
- * [`sf env list`](#sf-env-list)
55
- * [`sf env log tail`](#sf-env-log-tail)
56
- * [`sf env logdrain add`](#sf-env-logdrain-add)
57
- * [`sf env logdrain list`](#sf-env-logdrain-list)
58
- * [`sf env logdrain remove`](#sf-env-logdrain-remove)
59
- * [`sf env open`](#sf-env-open)
60
- * [`sf env var get KEY`](#sf-env-var-get-key)
61
- * [`sf env var list`](#sf-env-var-list)
62
- * [`sf env var set`](#sf-env-var-set)
63
- * [`sf env var unset`](#sf-env-var-unset)
64
- * [`sf generate function`](#sf-generate-function)
65
- * [`sf generate project`](#sf-generate-project)
66
- * [`sf help [COMMAND]`](#sf-help-command)
67
- * [`sf info:releasenotes:display [-v <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sf-inforeleasenotesdisplay--v-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
68
- * [`sf login`](#sf-login)
69
- * [`sf login functions`](#sf-login-functions)
70
- * [`sf login functions jwt`](#sf-login-functions-jwt)
71
- * [`sf login org`](#sf-login-org)
72
- * [`sf login org jwt`](#sf-login-org-jwt)
73
- * [`sf logout`](#sf-logout)
74
- * [`sf logout functions`](#sf-logout-functions)
75
- * [`sf logout org`](#sf-logout-org)
76
- * [`sf plugins`](#sf-plugins)
77
- * [`sf plugins:inspect PLUGIN...`](#sf-pluginsinspect-plugin)
78
- * [`sf plugins:install PLUGIN...`](#sf-pluginsinstall-plugin)
79
- * [`sf plugins:link PLUGIN`](#sf-pluginslink-plugin)
80
- * [`sf plugins:uninstall PLUGIN...`](#sf-pluginsuninstall-plugin)
81
- * [`sf plugins update`](#sf-plugins-update)
82
- * [`sf retrieve metadata`](#sf-retrieve-metadata)
83
- * [`sf run function`](#sf-run-function)
84
- * [`sf run function start`](#sf-run-function-start)
85
- * [`sf run function start local`](#sf-run-function-start-local)
86
- * [`sf update [CHANNEL]`](#sf-update-channel)
87
- * [`sf version`](#sf-version)
88
- * [`sf whoami functions`](#sf-whoami-functions)
46
+
47
+ - [`sf autocomplete [SHELL]`](#sf-autocomplete-shell)
48
+ - [`sf config get`](#sf-config-get)
49
+ - [`sf config list`](#sf-config-list)
50
+ - [`sf config set`](#sf-config-set)
51
+ - [`sf config unset`](#sf-config-unset)
52
+ - [`sf deploy`](#sf-deploy)
53
+ - [`sf deploy functions`](#sf-deploy-functions)
54
+ - [`sf deploy metadata`](#sf-deploy-metadata)
55
+ - [`sf env create compute`](#sf-env-create-compute)
56
+ - [`sf env delete`](#sf-env-delete)
57
+ - [`sf env display`](#sf-env-display)
58
+ - [`sf env list`](#sf-env-list)
59
+ - [`sf env log tail`](#sf-env-log-tail)
60
+ - [`sf env logdrain add`](#sf-env-logdrain-add)
61
+ - [`sf env logdrain list`](#sf-env-logdrain-list)
62
+ - [`sf env logdrain remove`](#sf-env-logdrain-remove)
63
+ - [`sf env open`](#sf-env-open)
64
+ - [`sf env var get KEY`](#sf-env-var-get-key)
65
+ - [`sf env var list`](#sf-env-var-list)
66
+ - [`sf env var set`](#sf-env-var-set)
67
+ - [`sf env var unset`](#sf-env-var-unset)
68
+ - [`sf generate function`](#sf-generate-function)
69
+ - [`sf generate project`](#sf-generate-project)
70
+ - [`sf help [COMMAND]`](#sf-help-command)
71
+ - [`sf info:releasenotes:display [-v <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sf-inforeleasenotesdisplay--v-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
72
+ - [`sf login`](#sf-login)
73
+ - [`sf login functions`](#sf-login-functions)
74
+ - [`sf login functions jwt`](#sf-login-functions-jwt)
75
+ - [`sf login org`](#sf-login-org)
76
+ - [`sf login org jwt`](#sf-login-org-jwt)
77
+ - [`sf logout`](#sf-logout)
78
+ - [`sf logout functions`](#sf-logout-functions)
79
+ - [`sf logout org`](#sf-logout-org)
80
+ - [`sf plugins`](#sf-plugins)
81
+ - [`sf plugins:inspect PLUGIN...`](#sf-pluginsinspect-plugin)
82
+ - [`sf plugins:install PLUGIN...`](#sf-pluginsinstall-plugin)
83
+ - [`sf plugins:link PLUGIN`](#sf-pluginslink-plugin)
84
+ - [`sf plugins:uninstall PLUGIN...`](#sf-pluginsuninstall-plugin)
85
+ - [`sf plugins update`](#sf-plugins-update)
86
+ - [`sf retrieve metadata`](#sf-retrieve-metadata)
87
+ - [`sf run function`](#sf-run-function)
88
+ - [`sf run function start`](#sf-run-function-start)
89
+ - [`sf run function start container`](#sf-run-function-start-container)
90
+ - [`sf run function start local`](#sf-run-function-start-local)
91
+ - [`sf update [CHANNEL]`](#sf-update-channel)
92
+ - [`sf version`](#sf-version)
93
+ - [`sf whoami functions`](#sf-whoami-functions)
89
94
 
90
95
  ## `sf autocomplete [SHELL]`
91
96
 
@@ -114,7 +119,7 @@ EXAMPLES
114
119
  $ sf autocomplete --refresh-cache
115
120
  ```
116
121
 
117
- _See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v1.0.0/src/commands/autocomplete/index.ts)_
122
+ _See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v1.1.1/src/commands/autocomplete/index.ts)_
118
123
 
119
124
  ## `sf config get`
120
125
 
@@ -317,7 +322,7 @@ EXAMPLES
317
322
  $ sf deploy --interactive
318
323
  ```
319
324
 
320
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/v1.0.5/src/commands/deploy.ts)_
325
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/v1.0.6/src/commands/deploy.ts)_
321
326
 
322
327
  ## `sf deploy functions`
323
328
 
@@ -424,8 +429,8 @@ FLAG DESCRIPTIONS
424
429
  75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and
425
430
  trigger individually and is different than the overall coverage percentage.
426
431
 
427
- - RunLocalTests — All tests in your org are run, except the ones that originate from installed managed packages.
428
- This test level is the default for production deployments that include Apex classes or triggers.
432
+ - RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked
433
+ packages. This test level is the default for production deployments that include Apex classes or triggers.
429
434
 
430
435
  - RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.
431
436
 
@@ -998,7 +1003,7 @@ DESCRIPTION
998
1003
  Display help for sf.
999
1004
  ```
1000
1005
 
1001
- _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.10/src/commands/help.ts)_
1006
+ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.9/src/commands/help.ts)_
1002
1007
 
1003
1008
  ## `sf info:releasenotes:display [-v <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
1004
1009
 
@@ -1065,7 +1070,7 @@ EXAMPLES
1065
1070
  $ sf login
1066
1071
  ```
1067
1072
 
1068
- _See code: [@salesforce/plugin-login](https://github.com/salesforcecli/plugin-login/blob/v1.0.6/src/commands/login.ts)_
1073
+ _See code: [@salesforce/plugin-login](https://github.com/salesforcecli/plugin-login/blob/v1.0.7/src/commands/login.ts)_
1069
1074
 
1070
1075
  ## `sf login functions`
1071
1076
 
@@ -1332,7 +1337,7 @@ EXAMPLES
1332
1337
  $ sf logout --no-prompt
1333
1338
  ```
1334
1339
 
1335
- _See code: [@salesforce/plugin-login](https://github.com/salesforcecli/plugin-login/blob/v1.0.6/src/commands/logout.ts)_
1340
+ _See code: [@salesforce/plugin-login](https://github.com/salesforcecli/plugin-login/blob/v1.0.7/src/commands/logout.ts)_
1336
1341
 
1337
1342
  ## `sf logout functions`
1338
1343
 
@@ -1405,7 +1410,7 @@ EXAMPLES
1405
1410
  $ sf plugins
1406
1411
  ```
1407
1412
 
1408
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.0.11/src/commands/plugins/index.ts)_
1413
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.0.12/src/commands/plugins/index.ts)_
1409
1414
 
1410
1415
  ## `sf plugins:inspect PLUGIN...`
1411
1416
 
@@ -1460,7 +1465,7 @@ ALIASES
1460
1465
  $ sf plugins add
1461
1466
 
1462
1467
  EXAMPLES
1463
- $ sf plugins:install myplugin
1468
+ $ sf plugins:install myplugin
1464
1469
 
1465
1470
  $ sf plugins:install https://github.com/someuser/someplugin
1466
1471
 
@@ -1664,11 +1669,48 @@ EXAMPLES
1664
1669
 
1665
1670
  ## `sf run function start`
1666
1671
 
1672
+ Build and run a Salesforce Function.
1673
+
1674
+ ```
1675
+ USAGE
1676
+ $ sf run function start [-b <value>] [-l javascript|typescript|java|auto] [-p <value>] [-v]
1677
+
1678
+ FLAGS
1679
+ -b, --debug-port=<value> [default: 9229] Port for remote debugging.
1680
+ -l, --language=(javascript|typescript|java|auto) [default: auto]
1681
+ -p, --port=<value> [default: 8080] Port for running the function.
1682
+ -v, --verbose Output additional logs.
1683
+
1684
+ DESCRIPTION
1685
+ Build and run a Salesforce Function.
1686
+
1687
+ Run this command from the directory of your Salesforce Functions project.
1688
+
1689
+ This command will run the target function locally (on the same operating system as this CLI), just like the `local`
1690
+ subcommand.
1691
+
1692
+ Previously, this command ran functions in a container. Container mode is still supported via the `container`
1693
+ subcommand. Arguments relevant to container mode are still accepted, but are deprecated, ignored, and will be dropped
1694
+ in a future release.
1695
+
1696
+ EXAMPLES
1697
+ Build a function and start the invoker
1698
+
1699
+ $ sf run function start
1700
+
1701
+ Start the invoker with a specific language and port
1702
+
1703
+ $ sf run function start --port 5000 --language javascript
1704
+ ```
1705
+
1706
+ ## `sf run function start container`
1707
+
1667
1708
  Build and run a Salesforce Function in a container.
1668
1709
 
1669
1710
  ```
1670
1711
  USAGE
1671
- $ sf run function start [-p <value>] [-b <value>] [--clear-cache] [--no-pull] [-e <value>] [--network <value>] [-v]
1712
+ $ sf run function start container [-p <value>] [-b <value>] [--clear-cache] [--no-pull] [-e <value>] [--network
1713
+ <value>] [-v]
1672
1714
 
1673
1715
  FLAGS
1674
1716
  -b, --debug-port=<value> [default: 9229] Port for remote debugging.
@@ -1688,15 +1730,15 @@ DESCRIPTION
1688
1730
  EXAMPLES
1689
1731
  Build and run a function:
1690
1732
 
1691
- $ sf run function start
1733
+ $ sf run function start container
1692
1734
 
1693
1735
  Run a function on a specific port with additional logs:
1694
1736
 
1695
- $ sf run function start --port 5000 --verbose
1737
+ $ sf run function start container --port 5000 --verbose
1696
1738
 
1697
1739
  Add environment variables and specify a network:
1698
1740
 
1699
- $ sf run function start --env KEY=VALUE --network host
1741
+ $ sf run function start container --env KEY=VALUE --network host
1700
1742
  ```
1701
1743
 
1702
1744
  ## `sf run function start local`
@@ -1740,7 +1782,7 @@ DESCRIPTION
1740
1782
  update the sf CLI
1741
1783
  ```
1742
1784
 
1743
- _See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/v2.1.3/src/commands/update.ts)_
1785
+ _See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/v2.1.5/src/commands/update.ts)_
1744
1786
 
1745
1787
  ## `sf version`
1746
1788
 
@@ -1749,7 +1791,7 @@ USAGE
1749
1791
  $ sf version
1750
1792
  ```
1751
1793
 
1752
- _See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/v1.0.3/src/commands/version.ts)_
1794
+ _See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/v1.0.4/src/commands/version.ts)_
1753
1795
 
1754
1796
  ## `sf whoami functions`
1755
1797
 
@@ -1776,4 +1818,5 @@ EXAMPLES
1776
1818
 
1777
1819
  $ sf whoami functions --show-token --json
1778
1820
  ```
1821
+
1779
1822
  <!-- commandsstop -->