@salesforce/cli 1.3.0 → 1.5.1

package/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 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.
 
+### [1.5.1](https://github.com/salesforcecli/cli/compare/v1.5.0...v1.5.1) (2021-12-02)
+
+## [1.5.0](https://github.com/salesforcecli/cli/compare/v1.4.0...v1.5.0) (2021-12-01)
+
+## [1.4.0](https://github.com/salesforcecli/cli/compare/v1.3.1...v1.4.0) (2021-11-17)
+
+### [1.3.1](https://github.com/salesforcecli/cli/compare/v1.3.0...v1.3.1) (2021-11-11)
+
+
+### Bug Fixes
+
+* bump versions ([7983bcc](https://github.com/salesforcecli/cli/commit/7983bcc2bc8ccfdc1123a6dce2548b70e1811d1f))
+
 ## [1.3.0](https://github.com/salesforcecli/cli/compare/v1.2.0...v1.3.0) (2021-11-04)
 
 

package/README.md

@@ -29,7 +29,7 @@ $ npm install -g @salesforce/cli
 $ sf COMMAND
 running command...
 $ sf (--version|-v|version)
-@salesforce/cli/1.3.0 linux-x64 node-v14.18.1
+@salesforce/cli/1.5.1 linux-x64 node-v14.18.2
 $ sf --help [COMMAND]
 USAGE
   $ sf COMMAND
@@ -80,6 +80,8 @@ USAGE
 * [`sf retrieve metadata`](#sf-retrieve-metadata)
 * [`sf run function`](#sf-run-function)
 * [`sf run function start`](#sf-run-function-start)
+* [`sf run function start local`](#sf-run-function-start-local)
+* [`sf update [CHANNEL]`](#sf-update-channel)
 * [`sf whoami functions`](#sf-whoami-functions)
 
 ## `sf config get`
@@ -438,6 +440,10 @@ FLAGS
 DESCRIPTION
   Create a compute environment for use with Salesforce Functions.
 
+  Compute environments must be connected to a Salesforce org. By default the command uses your local environment's
+  connected org. Use the '--connected-org' flag to specify a specific org. Run 'sf env list' to see a list of
+  environments.
+
 EXAMPLES
   Create a compute environment to run Salesforce Functions:
 
@@ -467,6 +473,12 @@ FLAGS
 DESCRIPTION
   Delete an environment.
 
+  You must include the name of the environment to delete using '--target-compute'. Run 'sf env list' to see a list of
+  environments.
+
+  Running this command will prompt a confirmation. If you want to skip this confirmation, use the '--confirm' flag and
+  the environment alias to skip confirmation.
+
 EXAMPLES
   Delete a compute environment:
 
@@ -597,9 +609,6 @@ USAGE
 FLAGS
   -e, --target-compute=<value>  Compute environment name to retrieve logs.
 
-DESCRIPTION
-  Stream log output for an environment.
-
 EXAMPLES
   Stream log output:
 
@@ -621,6 +630,9 @@ FLAGS
 DESCRIPTION
   Add log drain to a specified environment.
 
+  Both '--target-compute' and '--url' are required flags. '--url' should be a HTTP or HTTPS URL that can receive the log
+  drain messages.
+
 EXAMPLES
   Add a log drain:
 
@@ -639,9 +651,6 @@ FLAGS
   -e, --target-compute=<value>  Environment name.
   -j, --json                    Output list in JSON format.
 
-DESCRIPTION
-  List log drains connected to a specified environment.
-
 EXAMPLES
   List log drains:
 
@@ -667,6 +676,8 @@ FLAGS
 DESCRIPTION
   Remove log drain from a specified environment.
 
+  Both '--target-compute' and '--drain-url' are required flags.
+
 EXAMPLES
   Remove a logdrain:
 
@@ -744,6 +755,8 @@ FLAGS
 DESCRIPTION
   Display a single config variable for an environment.
 
+  You must provide the '--target-compute' flag and the key to retrieve.
+
 EXAMPLES
   Get a config variable:
 
@@ -765,6 +778,8 @@ FLAGS
 DESCRIPTION
   List your environment's config vars in a table.
 
+  Use the '--json' flag to return config vars in JSON format.
+
 EXAMPLES
   List config vars:
 
@@ -786,9 +801,6 @@ USAGE
 FLAGS
   -e, --target-compute=<value>  Environment name.
 
-DESCRIPTION
-  Set a single config value for an environment.
-
 EXAMPLES
   Set a config value:
 
@@ -809,6 +821,8 @@ FLAGS
 DESCRIPTION
   Unset a single config value for an environment.
 
+  Run 'sf env var list' to see a list of config values that can be unset.
+
 EXAMPLES
   Unset a value:
 
@@ -830,6 +844,8 @@ FLAGS
 DESCRIPTION
   Create a Salesforce Function with basic scaffolding specific to a given language.
 
+  Both '--language' and '--name' are required flags. Function names must start with a capital letter.
+
 EXAMPLES
   Create a JavaScript function:
 
@@ -950,7 +966,7 @@ DESCRIPTION
   Display help for sf.
 ```
 
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.1/src/commands/help.ts)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.7/src/commands/help.ts)_
 
 ## `sf login`
 
@@ -981,7 +997,7 @@ EXAMPLES
     $ sf login
 ```
 
-_See code: [@salesforce/plugin-login](https://github.com/salesforcecli/plugin-login/blob/v1.0.5/src/commands/login.ts)_
+_See code: [@salesforce/plugin-login](https://github.com/salesforcecli/plugin-login/blob/v1.0.6/src/commands/login.ts)_
 
 ## `sf login functions`
 
@@ -994,6 +1010,8 @@ USAGE
 DESCRIPTION
   Log in to Salesforce Functions.
 
+  This step is required to develop or deploy Salesforce Functions.
+
 EXAMPLES
   Log in to Salesforce Functions:
 
@@ -1021,6 +1039,8 @@ FLAGS
 DESCRIPTION
   Login using JWT instead of default web-based flow. This will authenticate you with both sf and Salesforce Functions.
 
+  Use this command when executing from a script.
+
 EXAMPLES
   Log in using JWT:
 
@@ -1084,16 +1104,17 @@ EXAMPLES
 
   Log in to a sandbox and set it as your default org:
 
-    $ sf login org --instance-url https://test.salesforce.com --set-default
+    $ sf login org --instance-url https://MyDomainName--SandboxName.sandbox.my.salesforce.com --set-default
 
   Use --browser to specify a specific browser, such as Google Chrome:
 
-    $ sf login org --instance-url https://test.salesforce.com --set-default --browser chrome
+    $ sf login org --instance-url https://MyDomainName--SandboxName.sandbox.my.salesforce.com --set-default \
+      --browser chrome
 
   Use your own connected app by specifying its consumer key (also called client ID):
 
-    $ sf login org --instance-url https://test.salesforce.com --set-default --browser chrome --clientid \
-      04580y4051234051
+    $ sf login org --instance-url https://MyDomainName--SandboxName.sandbox.my.salesforce.com --set-default \
+      --browser chrome --clientid 04580y4051234051
 
 FLAG DESCRIPTIONS
   -b, --browser=<value>  Browser in which to open the org.
@@ -1108,7 +1129,7 @@ FLAG DESCRIPTIONS
 
     To specify a My Domain URL, use the format https://yourcompanyname.my.salesforce.com.
 
-    To specify a sandbox, set --instance-url to https://test.salesforce.com.
+    To specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.
 
 CONFIGURATION VARIABLES
   apiVersion   API version of your project. Default: API version of your Dev Hub org.
@@ -1187,10 +1208,10 @@ EXAMPLES
     $ sf login org jwt --username jdoe@example.org --keyfile /Users/jdoe/JWT/server.key --clientid 04580y4051234051 \
       --alias ci-dev-hub --set-default-dev-hub
 
-  Log in to a sandbox using URL https://test.salesforce.com:
+  Log in to a sandbox using URL https://MyDomainName--SandboxName.sandbox.my.salesforce.com:
 
     $ sf login org jwt --username jdoe@example.org --keyfile /Users/jdoe/JWT/server.key --clientid 04580y4051234051 \
-      --alias ci-org --set-default --instance-url https://test.salesforce.com
+      --alias ci-org --set-default --instance-url https://MyDomainName--SandboxName.sandbox.my.salesforce.com
 
 FLAG DESCRIPTIONS
   -l, --instance-url=<value>  URL of the instance that the org lives on.
@@ -1199,7 +1220,7 @@ FLAG DESCRIPTIONS
 
     To specify a My Domain URL, use the format https://yourcompanyname.my.salesforce.com.
 
-    To specify a sandbox, set --instance-url to https://test.salesforce.com.
+    To specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.
 
 CONFIGURATION VARIABLES
   apiVersion   API version of your project. Default: API version of your Dev Hub org.
@@ -1243,7 +1264,7 @@ EXAMPLES
     $ sf logout --no-prompt
 ```
 
-_See code: [@salesforce/plugin-login](https://github.com/salesforcecli/plugin-login/blob/v1.0.5/src/commands/logout.ts)_
+_See code: [@salesforce/plugin-login](https://github.com/salesforcecli/plugin-login/blob/v1.0.6/src/commands/logout.ts)_
 
 ## `sf logout functions`
 
@@ -1253,9 +1274,6 @@ Log out of your Salesforce Functions account.
 USAGE
   $ sf logout functions
 
-DESCRIPTION
-  Log out of your Salesforce Functions account.
-
 EXAMPLES
   Log out:
 
@@ -1566,9 +1584,6 @@ FLAGS
   -p, --payload=<value>        Set the payload of the cloudevent as a JSON object or a path to a file via @file.json.
   -s, --structured             Set the cloudevent to be emitted as a structured JSON cloudevent.
 
-DESCRIPTION
-  Send a cloudevent to a function.
-
 EXAMPLES
   Run a function:
 
@@ -1581,7 +1596,7 @@ EXAMPLES
 
 ## `sf run function start`
 
-Build and run a Salesforce Function locally.
+Build and run a Salesforce Function in a container.
 
 ```
 USAGE
@@ -1598,7 +1613,9 @@ FLAGS
   --no-pull                 Skip pulling builder image before use.
 
 DESCRIPTION
-  Build and run a Salesforce Function locally.
+  Build and run a Salesforce Function in a container.
+
+  Run this command from the directory of your Salesforce Functions project.
 
 EXAMPLES
   Build and run a function:
@@ -1614,6 +1631,49 @@ EXAMPLES
     $ sf run function start --env KEY=VALUE --network host
 ```
 
+## `sf run function start local`
+
+Build and run a Salesforce Function locally.
+
+```
+USAGE
+  $ sf run function start local [-p <value>] [-b <value>] [-l javascript|typescript|java|auto]
+
+FLAGS
+  -b, --debug-port=<value>                          [default: 9229] Port to use for debbugging the function.
+  -l, --language=(javascript|typescript|java|auto)  [default: auto] The language that the function runs in.
+  -p, --port=<value>                                [default: 8080] Port to bind the invoker to.
+
+DESCRIPTION
+  Build and run a Salesforce Function locally.
+
+EXAMPLES
+  Build a function and start the invoker
+
+    $ sf run function start local
+
+  Start the invoker with a specific language and port
+
+    $ sf run function start local --port 5000 --language javascript
+```
+
+## `sf update [CHANNEL]`
+
+update the sf CLI
+
+```
+USAGE
+  $ sf update [CHANNEL] [--from-local]
+
+FLAGS
+  --from-local  interactively choose an already installed version
+
+DESCRIPTION
+  update the sf CLI
+```
+
+_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/v2.0.0/src/commands/update.ts)_
+
 ## `sf whoami functions`
 
 Show information on your Salesforce Functions login.
@@ -1628,6 +1688,8 @@ FLAGS
 DESCRIPTION
   Show information on your Salesforce Functions login.
 
+  Returns your email and ID. Use '--show-token' to show your Salesforce Functions token.
+
 EXAMPLES
   Get account information:
 

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"1.3.0","commands":{}}
+{"version":"1.5.1","commands":{}}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@salesforce/cli",
   "description": "The Salesforce CLI",
-  "version": "1.3.0",
+  "version": "1.5.1",
   "author": "Salesforce",
   "bin": {
     "sf": "./bin/run"
@@ -34,6 +34,7 @@
       "@oclif/plugin-help",
       "@oclif/plugin-not-found",
       "@oclif/plugin-plugins",
+      "@oclif/plugin-update",
       "@sf/config",
       "@sf/deploy-retrieve",
       "@sf/drm",
@@ -72,19 +73,20 @@
     ]
   },
   "dependencies": {
-    "@oclif/core": "1.0.2",
-    "@oclif/plugin-help": "5.1.1",
+    "@oclif/core": "^1.0.7",
+    "@oclif/plugin-help": "5.1.7",
     "@oclif/plugin-not-found": "2.2.0",
     "@oclif/plugin-plugins": "2.0.1",
-    "@salesforce/plugin-telemetry": "1.2.8",
+    "@oclif/plugin-update": "2.0.0",
+    "@salesforce/plugin-telemetry": "1.4.0",
     "@salesforce/sf-plugins-core": "1.0.4",
-    "@sf/config": "npm:@salesforce/plugin-config@2.2.10",
+    "@sf/config": "npm:@salesforce/plugin-config@2.2.11",
     "@sf/deploy-retrieve": "npm:@salesforce/plugin-deploy-retrieve@1.0.5",
     "@sf/drm": "npm:@salesforce/plugin-deploy-retrieve-metadata@1.0.7",
     "@sf/env": "npm:@salesforce/plugin-env@1.0.3",
-    "@sf/functions": "npm:@salesforce/plugin-functions@1.1.6",
+    "@sf/functions": "npm:@salesforce/plugin-functions@1.2.2",
     "@sf/gen": "npm:@salesforce/plugin-generate@1.0.5",
-    "@sf/login": "npm:@salesforce/plugin-login@1.0.5",
+    "@sf/login": "npm:@salesforce/plugin-login@1.0.6",
     "tslib": "^2.3.1"
   },
   "pinnedDependencies": [
@@ -95,10 +97,14 @@
     "@sf/functions",
     "@sf/gen",
     "@sf/login",
-    "@salesforce/plugin-telemetry"
+    "@salesforce/plugin-telemetry",
+    "@oclif/plugin-help",
+    "@oclif/plugin-not-found",
+    "@oclif/plugin-plugins",
+    "@oclif/plugin-update"
   ],
   "resolutions": {
-    "@salesforce/templates": "^52.4.0"
+    "@salesforce/templates": "52.6.0"
   },
   "repository": "salesforcecli/cli",
   "scripts": {
@@ -114,16 +120,16 @@
     "pack:deb": "oclif pack:deb",
     "pack:macos": "oclif pack:macos",
     "pack:tarballs": "oclif pack:tarballs",
-    "pack:verify": "./bin/dev cli:tarballs:verify --cli sf --windows-username-buffer 36",
+    "pack:verify": "sf-release cli:tarballs:verify --cli sf --windows-username-buffer 36",
     "pack:win": "oclif pack:win",
     "postpack": "rm -f oclif.manifest.json",
     "posttest": "yarn test:deprecation-policy",
     "prepack": "sf-prepack",
     "prepare": "yarn compile && yarn lint",
-    "pretarball": "./bin/dev cli:tarballs:prepare --types",
+    "pretarball": "sf-release cli:tarballs:prepare --types",
     "promote-dist-tags": "./scripts/promote-dist-tags",
-    "promote:verify": "./bin/dev cli:versions:inspect --channels stable --locations archive --cli sf",
-    "test:smoke-unix": "./tmp/sf/bin/sf --version && ./tmp/sf/bin/sf help && ./tmp/sf/bin/sf plugins --core",
+    "promote:verify": "sf-release cli:versions:inspect --channels stable --locations archive --cli sf",
+    "test:smoke-unix": "sf-release cli:tarballs:smoke --cli sf",
     "test:deprecation-policy": "./bin/dev snapshot:compare",
     "test": "echo disable # sf-test",
     "upload:deb": "oclif upload:deb",
@@ -145,7 +151,7 @@
     "@oclif/test": "^1",
     "@salesforce/dev-config": "^2.1.2",
     "@salesforce/dev-scripts": "^0.9.18",
-    "@salesforce/plugin-release-management": "^2.5.3",
+    "@salesforce/plugin-release-management": "^2.7.1",
     "@salesforce/prettier-config": "^0.0.2",
     "@typescript-eslint/eslint-plugin": "^4.33.0",
     "@typescript-eslint/parser": "^4.33.0",
@@ -159,12 +165,12 @@
     "eslint-config-salesforce-license": "^0.1.6",
     "eslint-config-salesforce-typescript": "^0.2.8",
     "eslint-plugin-header": "^3.1.1",
-    "eslint-plugin-import": "^2.24.2",
+    "eslint-plugin-import": "^2.25.3",
     "eslint-plugin-jsdoc": "^35.5.1",
     "eslint-plugin-prettier": "^3.4.1",
     "globby": "^11.0.4",
     "husky": "^4.3.8",
-    "mocha": "^9.1.2",
+    "mocha": "^9.1.3",
     "nyc": "^15.1.0",
     "oclif": "^2.0.0-main.6",
     "prettier": "^2.4.1",