Skip to content

Commit 0bfc799

Browse files
author
SF-CLI-BOT
committed
chore(release): 0.0.9 [ci skip]
1 parent 499d054 commit 0bfc799

File tree

3 files changed

+64
-33
lines changed

3 files changed

+64
-33
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
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.
44

5+
### [0.0.9](https://github.com/salesforcecli/plugin-env/compare/v0.0.8...v0.0.9) (2021-07-12)
6+
57
### [0.0.8](https://github.com/salesforcecli/plugin-env/compare/v0.0.7...v0.0.8) (2021-07-11)
68

79

README.md

Lines changed: 61 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -69,38 +69,46 @@ sfdx plugins
6969

7070
## `sf env display`
7171

72-
Display details about a specific environment
72+
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.
7373

7474
```
7575
USAGE
7676
$ sf env display [--json] [-e <value>]
7777
7878
FLAGS
79-
-e, --environment=<value> Environment name or alias to display.
79+
-e, --environment=<value> Environment alias or login user.
8080
8181
GLOBAL FLAGS
8282
--json format output as json
8383
8484
DESCRIPTION
85-
Display details about a specific environment
85+
Specify an environment with either the username you used when you ran the "sf login" command or the environment's
86+
alias. Run "sf env list" to view all your environments and their aliases.
8687
87-
EXAMPLES
88-
$ sf env display -e my-scratch-org
88+
Output depends on the type of environment. For example, scratch org details include the access token, alias, username
89+
of the associated Dev Hub, the creation and expiration date, the generated scratch org username, and more. Compute
90+
environment details include the associated orgs, the list of functions, the project name, and more.
8991
90-
$ sf env display -e user@name.com
92+
EXAMPLES
93+
- Display details about a scratch org with alias my-scratch-org:
94+
sf env display --environment=my-scratch-org
95+
- Specify a username instead of an alias:
96+
sf env display --environment=test-123456-abcdefg@example.com
97+
- Specify JSON format and redirect output into a file:
98+
sf env display --environment=my-scratch-org --json > tmp/MyOrdDesc.json
9199
```
92100

93101
## `sf env list`
94102

95-
List the environments you’ve created or logged into.
103+
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.
96104

97105
```
98106
USAGE
99107
$ sf env list [--json] [-a] [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output
100108
csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ]
101109
102110
FLAGS
103-
-a, --all Show all environments, including inactive orgs.
111+
-a, --all Show all environments, even inactive ones.
104112
-x, --extended show extra columns
105113
--columns=<value> only show provided columns (comma-separated)
106114
--csv output is csv format [alias: --output=csv]
@@ -117,12 +125,38 @@ GLOBAL FLAGS
117125
--json format output as json
118126
119127
DESCRIPTION
120-
List the environments you’ve created or logged into.
128+
By default, the command displays only active environments. For orgs, active means unexpired scratch orgs and orgs
129+
you’re currently logged into. For compute environments, active means the environments connected to orgs you’re
130+
currently logged into. Use the --all flag to list expired or deleted scratch orgs and compute environments that aren’t
131+
connected to logged-in orgs. Warning: the latter list could be very long.
132+
133+
Output is displayed in multiple tables, one for each environment type. For example, the Salesforce Orgs table lists
134+
the non-scratch orgs you’re logged into, such as sandboxes, Dev Hubs, production orgs, and so on. Scratch orgs and
135+
compute environments get their own tables.
136+
137+
For non-scratch orgs, the Username column refers to the user you logged into the org with. For scratch orgs it refers
138+
to the username that was generated for you when you created the scratch org. The first column indicates the default
139+
environment for each type.
140+
141+
Run "sf env display" to view details about a specific environment.
121142
122143
EXAMPLES
123-
$ sf env list
144+
List all environments:
145+
146+
$ sf env list --all
147+
148+
Filter the output to list only connected orgs. Rows from only the Salesforce Orgs table are displayed because it’s
149+
the only table with a "Status" column.
150+
151+
$ sf env list --filter "Status=Connected"
124152
125-
$ sf env list --all
153+
List only scratch orgs that expire after May 30, 2021:
154+
155+
$ sf env list --filter "Expiration>2021-05-30"
156+
157+
Display only the Alias column and sort the aliases in descending order:
158+
159+
$ sf env list --sort "-Alias" --columns "Alias"
126160
```
127161

128162
## `sf env open`
@@ -134,8 +168,8 @@ USAGE
134168
$ sf env open [--json] [-p <value>] [-r] [-e <value>] [--browser <value>]
135169
136170
FLAGS
137-
-e, --target-env=<value> Environment name or alias to open.
138-
-p, --path=<value> Path to append to the end of the open URL.
171+
-e, --target-env=<value> Environment login user or alias to open.
172+
-p, --path=<value> Path to append to the end of the login URL.
139173
-r, --url-only Display the URL, but don’t launch it in a browser.
140174
--browser=<value> Browser in which to open the environment.
141175
@@ -148,28 +182,32 @@ DESCRIPTION
148182
You can open the following types of environments in a web browser: scratch orgs, sandboxes, Dev Hubs, and production
149183
orgs.
150184
151-
If you run the command without flags, it attempts to open your default environment in your default web browser.
185+
If you run the command without flags, it attempts to open your default environment in your default web browser. Run
186+
"sf env list" to view your default environment.
187+
188+
Each of your environments is associated with an instance URL, such as https://login.salesforce.com. To open a specific
189+
web page, specify the portion of the URL after "<URL>/" with the --path flag, such as /apex/YourPage to open a
190+
Visualforce page.
152191
153192
EXAMPLES
154-
To open your default environment, run the command without flags:
193+
Open your default environment:
155194
156195
$ sf env open
157196
158-
This example opens the Visualforce page /apex/StartHere in a scratch org with alias "test-org":
197+
Open the Visualforce page /apex/StartHere in a scratch org with alias test-org:
159198
160199
$ sf env open --target-env test-org --path /apex/StartHere
161200
162-
If you want to view the URL for the preceding command, but not launch it in a browser:
201+
View the URL but don't launch it in a browser:
163202
164203
$ sf env open --target-env test-org --path /apex/StartHere --url-only
165204
166-
The preceding examples open the environment in your default web browser. To use a different browser, set the
167-
--browser flag to its OS-specific name. For example, to use Chrome on macOS:
205+
Open the environment in the Google Chrome browser:
168206
169-
$ sf env open --target-env test-org --path /apex/StartHere --browser "google chrome"
207+
$ sf env open --target-env test-org --path /apex/StartHere --browser chrome
170208
171209
FLAG DESCRIPTIONS
172-
-e, --target-env=<value> Environment name or alias to open.
210+
-e, --target-env=<value> Environment login user or alias to open.
173211
174212
Specify the login user or alias that’s associated with the environment. For scratch orgs, the login user is
175213
generated by the command that created the scratch org. You can also set an alias for the scratch org when you create
@@ -178,18 +216,9 @@ FLAG DESCRIPTIONS
178216
For Dev Hubs, sandboxes, and production orgs, specify the alias you set when you logged into the org with "sf
179217
login".
180218
181-
-p, --path=<value> Path to append to the end of the open URL.
182-
183-
Each of your environments is associated with an instance URL, such as https://<mydomian>.my.salesforce.com. To open
184-
a specific web page at that URL, specify the portion of the URL after "<URL>/" with the --path flag, such as
185-
/apex/YourPage to open a Visualforce page.
186-
187219
--browser=<value> Browser in which to open the environment.
188220
189-
Specify a browser by its app name according to your operating system. For example, Chrome’s app name is "google
190-
chrome" on macOS, "google-chrome" on Linux and "chrome" on Windows. So to open an environment in Chrome on macOS,
191-
specify --browser "google chrome". If you don’t specify --browser, the environment opens in your default browser.
192-
193-
For convenience, "chrome", "firefox", and "edge" are mapped to the OS specific app name.
221+
You can specify that the environment open in one of the following browsers: Firefox, Safari, Google Chrome, or
222+
Windows Edge. If you don’t specify --browser, the environment opens in your default browser.
194223
```
195224
<!-- commandsstop -->

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@salesforce/plugin-env",
33
"description": "An sf plugin for logging into and interacting with different Salesforce environments.",
4-
"version": "0.0.8",
4+
"version": "0.0.9",
55
"author": "Salesforce",
66
"bugs": "https://github.com/forcedotcom/cli/issues",
77
"dependencies": {

0 commit comments

Comments
 (0)