generated from salesforcecli/plugin-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
SF-CLI-BOT
committed
Jul 11, 2021
1 parent
8b201b7
commit 2cea21e
Showing
3 changed files
with
101 additions
and
64 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -63,104 +63,133 @@ sfdx plugins | |
| ## Commands | ||
|
|
||
| <!-- 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 <value>] | ||
| OPTIONS | ||
| -e, --environment=environment Environment name or alias to display. | ||
| --json format output as json | ||
| FLAGS | ||
| -e, --environment=<value> 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 [email protected] | ||
| ``` | ||
| $ 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 [email protected] | ||
| ``` | ||
|
|
||
| ## `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 <value> | -x] [--sort <value>] [--filter <value>] [--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=<value> only show provided columns (comma-separated) | ||
| --csv output is csv format [alias: --output=csv] | ||
| --filter=<value> 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=<option> output in a more machine friendly format | ||
| <options: csv|json|yaml> | ||
| ## `sf env:open` | ||
| --sort=<value> property to sort by (prepend '-' for descending) | ||
| You can open the following types of environments in a web browser: scratch orgs, sandboxes, Dev Hubs, and production orgs. | ||
| GLOBAL FLAGS | ||
| --json format output as json | ||
| ``` | ||
| USAGE | ||
| $ sf env:open | ||
| DESCRIPTION | ||
| List the environments you’ve created or logged into. | ||
| OPTIONS | ||
| -e, --target-env=target-env | ||
| Specify the login user or alias that’s associated with the environment. For scratch orgs, the login user is | ||
| generated by the command that created the scratch org. You can also set an alias for the scratch org when you create | ||
| it. | ||
| EXAMPLES | ||
| $ sf env list | ||
| For Dev Hubs, sandboxes, and production orgs, specify the alias you set when you logged into the org with "sf | ||
| login". | ||
| $ sf env list --all | ||
| ``` | ||
|
|
||
| -p, --path=path | ||
| Each of your environments is associated with an instance URL, such as https://<mydomian>.my.salesforce.com. To open | ||
| a specific web page at that URL, specify the portion of the URL after "<URL>/" with the --path flag, such as | ||
| /apex/YourPage to open a Visualforce page. | ||
| ## `sf env open` | ||
|
|
||
| -r, --url-only | ||
| You can open the following types of environments in a web browser: scratch orgs, sandboxes, Dev Hubs, and production orgs. | ||
|
|
||
| --browser=browser | ||
| Specify a browser by its app name according to your operating system. For example, Chrome’s app name is "google | ||
| chrome" on macOS, "google-chrome" on Linux and "chrome" on Windows. So to open an environment in Chrome on macOS, | ||
| specify --browser "google chrome". If you don’t specify --browser, the environment opens in your default browser. | ||
| ``` | ||
| USAGE | ||
| $ sf env open [--json] [-p <value>] [-r] [-e <value>] [--browser <value>] | ||
| For convenience, "chrome", "firefox", and "edge" are mapped to the OS specific app name. | ||
| FLAGS | ||
| -e, --target-env=<value> Environment name or alias to open. | ||
| -p, --path=<value> Path to append to the end of the open URL. | ||
| -r, --url-only Display the URL, but don’t launch it in a browser. | ||
| --browser=<value> Browser in which to open the environment. | ||
| --json | ||
| format output as json | ||
| GLOBAL FLAGS | ||
| --json format output as json | ||
| DESCRIPTION | ||
| Open an environment in your web browser. | ||
| You can open the following types of environments in a web browser: scratch orgs, sandboxes, Dev Hubs, and production | ||
| orgs. | ||
| If you run the command without flags, it attempts to open your default environment in your default web browser. | ||
| EXAMPLES | ||
| To open your default environment, run the command without flags: | ||
| sf env open | ||
| $ sf env open | ||
| This example opens the Visualforce page /apex/StartHere in a scratch org with alias "test-org": | ||
| sf env open --target-env test-org --path /apex/StartHere | ||
| $ sf env open --target-env test-org --path /apex/StartHere | ||
| If you want to view the URL for the preceding command, but not launch it in a browser: | ||
| sf env open --target-env test-org --path /apex/StartHere --url-only | ||
| The preceding examples open the environment in your default web browser. To use a different browser, set the --browser | ||
| flag to its OS-specific name. For example, to use Chrome on macOS: | ||
| sf env open --target-env test-org --path /apex/StartHere --browser "google chrome" | ||
| ``` | ||
| _See code: [src/commands/env/open.ts](https://github.com/salesforcecli/plugin-env/blob/v0.0.6/src/commands/env/open.ts)_ | ||
| $ sf env open --target-env test-org --path /apex/StartHere --url-only | ||
| The preceding examples open the environment in your default web browser. To use a different browser, set the | ||
| --browser flag to its OS-specific name. For example, to use Chrome on macOS: | ||
| $ sf env open --target-env test-org --path /apex/StartHere --browser "google chrome" | ||
| FLAG DESCRIPTIONS | ||
| -e, --target-env=<value> Environment name or alias to open. | ||
| Specify the login user or alias that’s associated with the environment. For scratch orgs, the login user is | ||
| generated by the command that created the scratch org. You can also set an alias for the scratch org when you create | ||
| it. | ||
| For Dev Hubs, sandboxes, and production orgs, specify the alias you set when you logged into the org with "sf | ||
| login". | ||
| -p, --path=<value> Path to append to the end of the open URL. | ||
| Each of your environments is associated with an instance URL, such as https://<mydomian>.my.salesforce.com. To open | ||
| a specific web page at that URL, specify the portion of the URL after "<URL>/" with the --path flag, such as | ||
| /apex/YourPage to open a Visualforce page. | ||
| --browser=<value> Browser in which to open the environment. | ||
| Specify a browser by its app name according to your operating system. For example, Chrome’s app name is "google | ||
| chrome" on macOS, "google-chrome" on Linux and "chrome" on Windows. So to open an environment in Chrome on macOS, | ||
| specify --browser "google chrome". If you don’t specify --browser, the environment opens in your default browser. | ||
| For convenience, "chrome", "firefox", and "edge" are mapped to the OS specific app name. | ||
| ``` | ||
| <!-- commandsstop --> | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters