diff --git a/CHANGELOG.md b/CHANGELOG.md index 5089687b..b02f65b1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,13 @@ 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. +### [0.0.21](https://github.com/salesforcecli/cli/compare/v0.0.20...v0.0.21) (2021-07-14) + + +### Bug Fixes + +* remove @salesforce/plugin-functions ([1b59fc2](https://github.com/salesforcecli/cli/commit/1b59fc2be51c62eddc66cfa1d0403bd9174cd799)) + ### [0.0.20](https://github.com/salesforcecli/cli/compare/v0.0.19...v0.0.20) (2021-07-14) diff --git a/README.md b/README.md index 0d93dfcd..27d22ccc 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ $ npm install -g @salesforce/cli $ sf COMMAND running command... $ sf (-v|--version|version) -@salesforce/cli/0.0.19 linux-x64 node-v14.17.3 +@salesforce/cli/0.0.20 linux-x64 node-v14.17.3 $ sf --help [COMMAND] USAGE $ sf COMMAND @@ -32,24 +32,11 @@ USAGE # Commands -* [`sf env create compute`](#sf-env-create-compute) -* [`sf env delete`](#sf-env-delete) * [`sf env display`](#sf-env-display) * [`sf env list`](#sf-env-list) -* [`sf env log tail`](#sf-env-log-tail) -* [`sf env logdrain add`](#sf-env-logdrain-add) -* [`sf env logdrain list`](#sf-env-logdrain-list) -* [`sf env logdrain remove`](#sf-env-logdrain-remove) * [`sf env open`](#sf-env-open) -* [`sf env var get KEY`](#sf-env-var-get-key) -* [`sf env var list`](#sf-env-var-list) -* [`sf env var set`](#sf-env-var-set) -* [`sf env var unset`](#sf-env-var-unset) -* [`sf generate function`](#sf-generate-function) -* [`sf generate project`](#sf-generate-project) * [`sf help [COMMAND]`](#sf-help-command) * [`sf login`](#sf-login) -* [`sf login functions`](#sf-login-functions) * [`sf login org`](#sf-login-org) * [`sf login org jwt`](#sf-login-org-jwt) * [`sf logout`](#sf-logout) @@ -60,194 +47,99 @@ USAGE * [`sf plugins:uninstall PLUGIN...`](#sf-pluginsuninstall-plugin) * [`sf plugins update`](#sf-plugins-update) * [`sf project deploy`](#sf-project-deploy) -* [`sf project deploy functions`](#sf-project-deploy-functions) * [`sf project deploy org`](#sf-project-deploy-org) -* [`sf run function`](#sf-run-function) -* [`sf run function start`](#sf-run-function-start) -* [`sf whoami functions`](#sf-whoami-functions) - -## `sf env create compute` - -create a compute environment for use with Salesforce Functions - -``` -USAGE - $ sf env create compute [--json] [-o ] [-a ] - -FLAGS - -a, --setalias= alias for the created environment - -o, --connected-org= username or alias for the org that the compute environment should be connected to - -GLOBAL FLAGS - --json format output as json - -DESCRIPTION - create a compute environment for use with Salesforce Functions - -EXAMPLES - $ sfdx env:create:compute - - $ sfdx env:create:compute --setalias my-compute-environment - - $ sfdx env:create:compute --connected-org my-scratch-org -``` - -## `sf env delete` - -delete an environment - -``` -USAGE - $ sf env delete -e [--json] [-c ] - -FLAGS - -c, --confirm=name... confirmation name - -e, --environment= (required) environment name - -GLOBAL FLAGS - --json format output as json - -DESCRIPTION - delete an environment - -EXAMPLES - $ sfdx env:delete --environment=billingApp-Scratch1 - - $ sfdx env:delete --environment=billingApp-Scratch1 --confirm=billingApp-Scratch1 -``` +* [`sf project retrieve org`](#sf-project-retrieve-org) ## `sf env display` -display details for an environment +Specify an environment with either the username you used when you ran the "sf login" command or the environment's alias. Run "sf env list" to view all your environments and their aliases. ``` USAGE - $ sf env display -e [--json] [--verbose] + $ sf env display [--json] [-e ] FLAGS - -e, --environment= (required) environment name - --verbose verbose display output + -e, --environment= Environment alias or login user. GLOBAL FLAGS --json format output as json DESCRIPTION - display details for an environment + Specify an environment with either the username you used when you ran the "sf login" command or the environment's + alias. Run "sf env list" to view all your environments and their aliases. + + Output depends on the type of environment. For example, scratch org details include the access token, alias, username + of the associated Dev Hub, the creation and expiration date, the generated scratch org username, and more. Compute + environment details include the associated orgs, the list of functions, the project name, and more. EXAMPLES - $ sfdx env:display --environment=billingApp-Scratch1 + - Display details about a scratch org with alias my-scratch-org: + sf env display --environment=my-scratch-org + - Specify a username instead of an alias: + sf env display --environment=test-123456-abcdefg@example.com + - Specify JSON format and redirect output into a file: + sf env display --environment=my-scratch-org --json > tmp/MyOrdDesc.json ``` ## `sf env list` -List all environments by type +By default, the command displays only active environments. For orgs, active means unexpired scratch orgs and orgs you’re currently logged into. For compute environments, active means the environments connected to orgs you’re currently logged into. Use the --all flag to list expired or deleted scratch orgs and compute environments that aren’t connected to logged-in orgs. Warning: the latter list could be very long. ``` USAGE - $ sf env list [-j] [--all] [-t org|scratchorg|compute] + $ sf env list [--json] [-a] [--columns | -x] [--sort ] [--filter ] [--output + csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ] FLAGS - -j, --json output list in JSON format + -a, --all Show all environments, even inactive ones. + -x, --extended show extra columns + --columns= only show provided columns (comma-separated) + --csv output is csv format [alias: --output=csv] + --filter= filter property by partial string matching, ex: name=foo + --no-header hide table header from output + --no-truncate do not truncate output to fit screen - -t, --environment-type=