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
Jun 21, 2021
1 parent
d43a09a
commit 5b0e144
Showing
3 changed files
with
43 additions
and
31 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,10 +63,9 @@ sfdx plugins | |
## Commands | ||
|
||
<!-- commands --> | ||
|
||
- [`sf env:display`](#sf-envdisplay) | ||
- [`sf env:list`](#sf-envlist) | ||
- [`sf env:open`](#sf-envopen) | ||
* [`sf env:display`](#sf-envdisplay) | ||
* [`sf env:list`](#sf-envlist) | ||
* [`sf env:open`](#sf-envopen) | ||
|
||
## `sf env:display` | ||
|
||
|
@@ -78,13 +77,14 @@ USAGE | |
OPTIONS | ||
-e, --environment=environment Environment name or alias to display. | ||
--json format output as json | ||
EXAMPLES | ||
sf env display -e my-scratch-org | ||
sf env display -e [email protected] | ||
``` | ||
|
||
_See code: [src/commands/env/display.ts](https://github.com/salesforcecli/plugin-env/blob/v0.0.5/src/commands/env/display.ts)_ | ||
_See code: [src/commands/env/display.ts](https://github.com/salesforcecli/plugin-env/blob/v0.0.6/src/commands/env/display.ts)_ | ||
|
||
## `sf env:list` | ||
|
||
|
@@ -100,6 +100,7 @@ OPTIONS | |
--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 | ||
|
@@ -110,7 +111,7 @@ EXAMPLES | |
sf env list --all | ||
``` | ||
|
||
_See code: [src/commands/env/list.ts](https://github.com/salesforcecli/plugin-env/blob/v0.0.5/src/commands/env/list.ts)_ | ||
_See code: [src/commands/env/list.ts](https://github.com/salesforcecli/plugin-env/blob/v0.0.6/src/commands/env/list.ts)_ | ||
|
||
## `sf env:open` | ||
|
||
|
@@ -121,41 +122,45 @@ USAGE | |
$ sf env:open | ||
OPTIONS | ||
-e, --target-env=target-env Environment name or alias to open. | ||
-p, --path=path Path to append to the end of the login URL. | ||
-r, --url-only Display the URL, but don’t launch it in a browser. | ||
--browser=browser Browser in which to open the environment. | ||
-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. | ||
DESCRIPTION | ||
If you run the command without flags, it attempts to open your default environment in your default web browser. | ||
For Dev Hubs, sandboxes, and production orgs, specify the alias you set when you logged into the org with "sf | ||
login". | ||
Each of your environments is associated with an instance URL, such as https://login.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. | ||
You can open the following types of environments in a web browser: scratch orgs, sandboxes, Dev Hubs, and production | ||
orgs. | ||
-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. | ||
If you run the command without flags, it attempts to open your default environment in your default web browser. | ||
-r, --url-only | ||
--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. | ||
Each of your environments is associated with an instance URL, such as https://login.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. | ||
For convenience, "chrome", "firefox", and "edge" are mapped to the OS specific app name. | ||
--json | ||
format output as json | ||
DESCRIPTION | ||
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 | ||
This example opens the Visualforce page /apex/StartHere in a scratch org | ||
with alias "test-org": | ||
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 | ||
If you want to view the URL for the preceding command, but not launch it in a browser, | ||
add the --url-only flag: | ||
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: | ||
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.5/src/commands/env/open.ts)_ | ||
|
||
_See code: [src/commands/env/open.ts](https://github.com/salesforcecli/plugin-env/blob/v0.0.6/src/commands/env/open.ts)_ | ||
<!-- 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