diff --git a/CHANGELOG.md b/CHANGELOG.md index fa170e55..57d2b9de 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,14 @@ 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.8](https://github.com/salesforcecli/plugin-env/compare/v0.0.7...v0.0.8) (2021-07-11) + + +### Bug Fixes + +* bump oclif ([8b201b7](https://github.com/salesforcecli/plugin-env/commit/8b201b78063a5d83602ee2fccbb31550268812ee)) +* bump oclif/core ([f8f60f6](https://github.com/salesforcecli/plugin-env/commit/f8f60f656c0570bb97ce1e8c459e23dac46df463)) + ### [0.0.7](https://github.com/salesforcecli/plugin-env/compare/v0.0.6...v0.0.7) (2021-06-21) diff --git a/README.md b/README.md index a5ebaf88..6e067bba 100644 --- a/README.md +++ b/README.md @@ -63,104 +63,133 @@ sfdx plugins ## Commands -* [`sf env:display`](#sf-envdisplay) -* [`sf env:list`](#sf-envlist) -* [`sf env:open`](#sf-envopen) +* [`sf env display`](#sf-env-display) +* [`sf env list`](#sf-env-list) +* [`sf env open`](#sf-env-open) -## `sf env:display` +## `sf env display` Display details about a specific environment ``` USAGE - $ sf env:display + $ sf env display [--json] [-e ] -OPTIONS - -e, --environment=environment Environment name or alias to display. - --json format output as json +FLAGS + -e, --environment= Environment name or alias to display. + +GLOBAL FLAGS + --json format output as json + +DESCRIPTION + Display details about a specific environment EXAMPLES - sf env display -e my-scratch-org - sf env display -e user@name.com -``` + $ sf env display -e my-scratch-org -_See code: [src/commands/env/display.ts](https://github.com/salesforcecli/plugin-env/blob/v0.0.6/src/commands/env/display.ts)_ + $ sf env display -e user@name.com +``` -## `sf env:list` +## `sf env list` List the environments you’ve created or logged into. ``` USAGE - $ sf env:list - -OPTIONS - -a, --all Show all environments, including inactive orgs. - -x, --extended show extra columns - --columns=columns only show provided columns (comma-separated) - --csv output is csv format [alias: --output=csv] - --filter=filter filter property by partial string matching, ex: name=foo - --json format output as json - --no-header hide table header from output - --no-truncate do not truncate output to fit screen - --output=csv|json|yaml output in a more machine friendly format - --sort=sort property to sort by (prepend '-' for descending) + $ sf env list [--json] [-a] [--columns | -x] [--sort ] [--filter ] [--output + csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ] -EXAMPLES - sf env list - sf env list --all -``` +FLAGS + -a, --all Show all environments, including inactive orgs. + -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 -_See code: [src/commands/env/list.ts](https://github.com/salesforcecli/plugin-env/blob/v0.0.6/src/commands/env/list.ts)_ + --output=