You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+2Lines changed: 2 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,8 @@
2
2
3
3
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.
Copy file name to clipboardExpand all lines: README.md
+61-32Lines changed: 61 additions & 32 deletions
Original file line number
Diff line number
Diff line change
@@ -69,38 +69,46 @@ sfdx plugins
69
69
70
70
## `sf env display`
71
71
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.
73
73
74
74
```
75
75
USAGE
76
76
$ sf env display [--json] [-e <value>]
77
77
78
78
FLAGS
79
-
-e, --environment=<value> Environment name or alias to display.
79
+
-e, --environment=<value> Environment alias or login user.
80
80
81
81
GLOBAL FLAGS
82
82
--json format output as json
83
83
84
84
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.
86
87
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.
89
91
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
91
99
```
92
100
93
101
## `sf env list`
94
102
95
-
List the environmentsyou’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.
96
104
97
105
```
98
106
USAGE
99
107
$ sf env list [--json] [-a] [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output
0 commit comments