@@ -63,10 +63,9 @@ sfdx plugins
63
63
## Commands
64
64
65
65
<!-- commands -->
66
-
67
- - [ ` sf env:display ` ] ( #sf-envdisplay )
68
- - [ ` sf env:list ` ] ( #sf-envlist )
69
- - [ ` sf env:open ` ] ( #sf-envopen )
66
+ * [ ` sf env:display ` ] ( #sf-envdisplay )
67
+ * [ ` sf env:list ` ] ( #sf-envlist )
68
+ * [ ` sf env:open ` ] ( #sf-envopen )
70
69
71
70
## ` sf env:display `
72
71
@@ -78,13 +77,14 @@ USAGE
78
77
79
78
OPTIONS
80
79
-e, --environment=environment Environment name or alias to display.
80
+ --json format output as json
81
81
82
82
EXAMPLES
83
83
sf env display -e my-scratch-org
84
84
sf env display -e user@name.com
85
85
```
86
86
87
- _ See code: [ src/commands/env/display.ts] ( https://github.com/salesforcecli/plugin-env/blob/v0.0.5 /src/commands/env/display.ts ) _
87
+ _ See code: [ src/commands/env/display.ts] ( https://github.com/salesforcecli/plugin-env/blob/v0.0.6 /src/commands/env/display.ts ) _
88
88
89
89
## ` sf env:list `
90
90
@@ -100,6 +100,7 @@ OPTIONS
100
100
--columns=columns only show provided columns (comma-separated)
101
101
--csv output is csv format [alias: --output=csv]
102
102
--filter=filter filter property by partial string matching, ex: name=foo
103
+ --json format output as json
103
104
--no-header hide table header from output
104
105
--no-truncate do not truncate output to fit screen
105
106
--output=csv|json|yaml output in a more machine friendly format
@@ -110,7 +111,7 @@ EXAMPLES
110
111
sf env list --all
111
112
```
112
113
113
- _ See code: [ src/commands/env/list.ts] ( https://github.com/salesforcecli/plugin-env/blob/v0.0.5 /src/commands/env/list.ts ) _
114
+ _ See code: [ src/commands/env/list.ts] ( https://github.com/salesforcecli/plugin-env/blob/v0.0.6 /src/commands/env/list.ts ) _
114
115
115
116
## ` sf env:open `
116
117
@@ -121,41 +122,45 @@ USAGE
121
122
$ sf env:open
122
123
123
124
OPTIONS
124
- -e, --target-env=target-env Environment name or alias to open.
125
- -p, --path=path Path to append to the end of the login URL.
126
- -r, --url-only Display the URL, but don’t launch it in a browser.
127
- --browser=browser Browser in which to open the environment .
125
+ -e, --target-env=target-env
126
+ Specify the login user or alias that’s associated with the environment. For scratch orgs, the login user is
127
+ generated by the command that created the scratch org. You can also set an alias for the scratch org when you create
128
+ it .
128
129
129
- DESCRIPTION
130
- If you run the command without flags, it attempts to open your default environment in your default web browser .
130
+ For Dev Hubs, sandboxes, and production orgs, specify the alias you set when you logged into the org with "sf
131
+ login" .
131
132
132
- Each of your environments is associated with an instance URL, such as https://login.salesforce.com. To open a specific
133
- web page at that URL, specify the portion of the URL after "<URL>/" with the --path flag, such as /apex/YourPage to
134
- open a Visualforce page.
135
- You can open the following types of environments in a web browser: scratch orgs, sandboxes, Dev Hubs, and production
136
- orgs.
133
+ -p, --path=path
134
+ Each of your environments is associated with an instance URL, such as https://<mydomian>.my.salesforce.com. To open
135
+ a specific web page at that URL, specify the portion of the URL after "<URL>/" with the --path flag, such as
136
+ /apex/YourPage to open a Visualforce page.
137
137
138
- If you run the command without flags, it attempts to open your default environment in your default web browser.
138
+ -r, --url-only
139
+
140
+ --browser=browser
141
+ Specify a browser by its app name according to your operating system. For example, Chrome’s app name is "google
142
+ chrome" on macOS, "google-chrome" on Linux and "chrome" on Windows. So to open an environment in Chrome on macOS,
143
+ specify --browser "google chrome". If you don’t specify --browser, the environment opens in your default browser.
139
144
140
- Each of your environments is associated with an instance URL, such as https://login.salesforce.com. To open a specific
141
- web page at that URL, specify the portion of the URL after "<URL>/" with the --path flag, such as /apex/YourPage to
142
- open a Visualforce page.
145
+ For convenience, "chrome", "firefox", and "edge" are mapped to the OS specific app name.
146
+
147
+ --json
148
+ format output as json
149
+
150
+ DESCRIPTION
151
+ If you run the command without flags, it attempts to open your default environment in your default web browser.
143
152
144
153
EXAMPLES
145
154
To open your default environment, run the command without flags:
146
155
sf env open
147
- This example opens the Visualforce page /apex/StartHere in a scratch org
148
- with alias "test-org":
156
+ This example opens the Visualforce page /apex/StartHere in a scratch org with alias "test-org":
149
157
sf env open --target-env test-org --path /apex/StartHere
150
- If you want to view the URL for the preceding command, but not launch it in a browser,
151
- add the --url-only flag:
158
+ If you want to view the URL for the preceding command, but not launch it in a browser:
152
159
sf env open --target-env test-org --path /apex/StartHere --url-only
153
- The preceding examples open the environment in your default web browser. To use
154
- a different browser, set the --browser flag to its OS-specific name. For example,
155
- to use Chrome on macOS:
160
+ The preceding examples open the environment in your default web browser. To use a different browser, set the --browser
161
+ flag to its OS-specific name. For example, to use Chrome on macOS:
156
162
sf env open --target-env test-org --path /apex/StartHere --browser "google chrome"
157
163
```
158
164
159
- _ See code: [ src/commands/env/open.ts] ( https://github.com/salesforcecli/plugin-env/blob/v0.0.5/src/commands/env/open.ts ) _
160
-
165
+ _ See code: [ src/commands/env/open.ts] ( https://github.com/salesforcecli/plugin-env/blob/v0.0.6/src/commands/env/open.ts ) _
161
166
<!-- commandsstop -->
0 commit comments