@salesforce/cli 1.36.0 → 1.37.0

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 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.37.0](https://github.com/salesforcecli/cli/compare/v1.36.0...v1.37.0) (2022-07-13)
+
+### Bug Fixes
+
+- **deps:** update plugin-functions to 1.12.1 ([42f5ecd](https://github.com/salesforcecli/cli/commit/42f5ecdd30e395d823678658da1df51409c89028))
+
 ## [1.36.0](https://github.com/salesforcecli/cli/compare/v1.35.0...v1.36.0) (2022-07-06)
 
 ## [1.35.0](https://github.com/salesforcecli/cli/compare/v1.34.0...v1.35.0) (2022-06-29)

package/README.md

@@ -31,7 +31,7 @@ $ npm install -g @salesforce/cli
 $ sf COMMAND
 running command...
 $ sf (--version|-v)
-@salesforce/cli/1.36.0 linux-x64 node-v14.19.3
+@salesforce/cli/1.37.0 linux-x64 node-v14.20.0
 $ sf --help [COMMAND]
 USAGE
   $ sf COMMAND
@@ -66,6 +66,7 @@ USAGE
 - [`sf env delete scratch`](#sf-env-delete-scratch)
 - [`sf env display`](#sf-env-display)
 - [`sf env list`](#sf-env-list)
+- [`sf env log`](#sf-env-log)
 - [`sf env log tail`](#sf-env-log-tail)
 - [`sf env logdrain add`](#sf-env-logdrain-add)
 - [`sf env logdrain list`](#sf-env-logdrain-list)
@@ -342,16 +343,38 @@ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli
 
 ## `sf deploy functions`
 
+Deploy a Salesforce Function to an org from your local project.
+
 ```
 USAGE
-  $ sf deploy functions -o <value> [-b <value>] [--force] [-q]
+  $ sf deploy functions -o <value> [-b <value>] [--force] [-q] [-j]
 
 FLAGS
   -b, --branch=<value>         Deploy the latest commit from a branch different from the currently active branch.
+  -j, --json                   Output list in JSON format.
   -o, --connected-org=<value>  (required) Username or alias for the org that the compute environment should be connected
                                to.
   -q, --quiet                  Limit the amount of output displayed from the deploy process.
   --force                      Ignore warnings and overwrite remote repository (not allowed in production).
+
+DESCRIPTION
+  Deploy a Salesforce Function to an org from your local project.
+
+  You must run this command from within a git repository. Only committed changes to Functions are deployed. The active
+  branch is deployed unless specified otherwise with `--branch`.
+
+EXAMPLES
+  Deploy a Salesforce Function:
+
+    $ sf deploy functions --connected-org org-alias
+
+  Deploy to 'deploy-branch':
+
+    $ sf deploy functions --connected-org org-alias --branch deploy-branch
+
+  Overwrite the remote repository:
+
+    $ sf deploy functions --connected-org org-alias --force
 ```
 
 ## `sf deploy metadata`
@@ -965,10 +988,11 @@ Create a compute environment for use with Salesforce Functions.
 
 ```
 USAGE
-  $ sf env create compute [-o <value>] [-a <value> | ]
+  $ sf env create compute [-o <value>] [-a <value>] [-j]
 
 FLAGS
   -a, --alias=<value>          Alias for the created environment.
+  -j, --json                   Output list in JSON format.
   -o, --connected-org=<value>  Username or alias for the org that the compute environment should be connected to.
 
 DESCRIPTION
@@ -1203,10 +1227,11 @@ Delete an environment.
 
 ```
 USAGE
-  $ sf env delete [-e <value> | ] [--confirm <value>]
+  $ sf env delete [-e <value> | ] [--confirm <value>] [-j]
 
 FLAGS
   -e, --target-compute=<value>  Environment name.
+  -j, --json                    Output list in JSON format.
   --confirm=name...             Confirmation name.
 
 DESCRIPTION
@@ -1408,6 +1433,24 @@ EXAMPLES
     $ sf env list --csv --no-header
 ```
 
+## `sf env log`
+
+Stream log output for an environment.
+
+```
+USAGE
+  $ sf env log [-e <value> | ] [-n <value>]
+
+FLAGS
+  -e, --target-compute=<value>  Compute environment name to retrieve logs.
+  -n, --num=<value>             Number of lines to display.
+
+EXAMPLES
+  Stream log output:
+
+    $ sf env log --target-compute environment-alias
+```
+
 ## `sf env log tail`
 
 Stream log output for an environment.
@@ -1431,10 +1474,11 @@ Add log drain to a specified environment.
 
 ```
 USAGE
-  $ sf env logdrain add [-e <value> | ] [-l <value> | ]
+  $ sf env logdrain add [-e <value> | ] [-l <value> | ] [-j]
 
 FLAGS
   -e, --target-compute=<value>  Environment name.
+  -j, --json                    Output list in JSON format.
   -l, --drain-url=<value>       Endpoint that will receive sent logs.
 
 DESCRIPTION
@@ -1477,10 +1521,11 @@ Remove log drain from a specified environment.
 
 ```
 USAGE
-  $ sf env logdrain remove [-e <value> | ] [-l <value> | ]
+  $ sf env logdrain remove [-e <value> | ] [-l <value> | ] [-j]
 
 FLAGS
   -e, --target-compute=<value>  Environment name.
+  -j, --json                    Output list in JSON format.
   -l, --drain-url=<value>       Log drain url to remove.
 
 DESCRIPTION
@@ -1705,10 +1750,11 @@ Set a single config value for an environment.
 
 ```
 USAGE
-  $ sf env var set [-e <value> | ]
+  $ sf env var set [-e <value> | ] [-j]
 
 FLAGS
   -e, --target-compute=<value>  Environment name.
+  -j, --json                    Output list in JSON format.
 
 EXAMPLES
   Set a config value:
@@ -1722,10 +1768,11 @@ Unset a single config value for an environment.
 
 ```
 USAGE
-  $ sf env var unset [-e <value> | ]
+  $ sf env var unset [-e <value> | ] [-j]
 
 FLAGS
   -e, --target-compute=<value>  Environment name.
+  -j, --json                    Output list in JSON format.
 
 DESCRIPTION
   Unset a single config value for an environment.
@@ -1758,7 +1805,7 @@ DESCRIPTION
 EXAMPLES
   Create a JavaScript function:
 
-    $ sf generate function --function-name MyFunction --language javascript
+    $ sf generate function --function-name myfunction --language javascript
 ```
 
 ## `sf generate project`
@@ -1969,17 +2016,17 @@ Login using JWT instead of default web-based flow. This will authenticate you wi
 
 ```
 USAGE
-  $ sf login functions jwt -u <value> -f <value> -i <value> [-l <value> | ] [--json] [-a <value>] [-d] [-v]
+  $ sf login functions jwt -u <value> -f <value> -i <value> [-l <value> | ] [-j] [-a <value>] [-d] [-v]
 
 FLAGS
   -a, --alias=<value>         Alias for the org.
   -d, --set-default           Set the org as the default that all org-related commands run against.
   -f, --keyfile=<value>       (required) Path to JWT keyfile.
   -i, --clientid=<value>      (required) OAuth client ID.
+  -j, --json                  Output list in JSON format.
   -l, --instance-url=<value>  The login URL of the instance the org lives on.
   -u, --username=<value>      (required) Authentication username.
   -v, --set-default-dev-hub   Set the org as the default Dev Hub for scratch org creation.
-  --json                      Format output as JSON.
 
 DESCRIPTION
   Login using JWT instead of default web-based flow. This will authenticate you with both sf and Salesforce Functions.
@@ -2217,7 +2264,10 @@ Log out of your Salesforce Functions account.
 
 ```
 USAGE
-  $ sf logout functions
+  $ sf logout functions [-j]
+
+FLAGS
+  -j, --json  Output list in JSON format.
 
 EXAMPLES
   Log out:
@@ -2616,10 +2666,11 @@ Send a cloudevent to a function.
 
 ```
 USAGE
-  $ sf run function [-l <value> | ] [-H <value>] [-p <value>] [-s] [-o <value>]
+  $ sf run function [-l <value> | ] [-H <value>] [-p <value>] [-s] [-o <value>] [-j]
 
 FLAGS
   -H, --headers=<value>...     Set headers.
+  -j, --json                   Output list in JSON format.
   -l, --function-url=<value>   URL of the function to run.
   -o, --connected-org=<value>  Username or alias for the target org; overrides default target org.
   -p, --payload=<value>        Set the payload of the cloudevent as a JSON object or a path to a file via @file.json.