@@ -63,104 +63,133 @@ sfdx plugins
63
63
## Commands
64
64
65
65
<!-- commands -->
66
- * [ ` sf env: display ` ] ( #sf-envdisplay )
67
- * [ ` sf env: list ` ] ( #sf-envlist )
68
- * [ ` sf env: open ` ] ( #sf-envopen )
66
+ * [ ` sf env display ` ] ( #sf-env-display )
67
+ * [ ` sf env list ` ] ( #sf-env-list )
68
+ * [ ` sf env open ` ] ( #sf-env-open )
69
69
70
- ## ` sf env: display `
70
+ ## ` sf env display `
71
71
72
72
Display details about a specific environment
73
73
74
74
```
75
75
USAGE
76
- $ sf env: display
76
+ $ sf env display [--json] [-e <value>]
77
77
78
- OPTIONS
79
- -e, --environment=environment Environment name or alias to display.
80
- --json format output as json
78
+ FLAGS
79
+ -e, --environment=<value> Environment name or alias to display.
80
+
81
+ GLOBAL FLAGS
82
+ --json format output as json
83
+
84
+ DESCRIPTION
85
+ Display details about a specific environment
81
86
82
87
EXAMPLES
83
- sf env display -e my-scratch-org
84
- sf env display -e user@name.com
85
- ```
88
+ $ sf env display -e my-scratch-org
86
89
87
- _ See code: [ src/commands/env/display.ts] ( https://github.com/salesforcecli/plugin-env/blob/v0.0.6/src/commands/env/display.ts ) _
90
+ $ sf env display -e user@name.com
91
+ ```
88
92
89
- ## ` sf env: list `
93
+ ## ` sf env list `
90
94
91
95
List the environments you’ve created or logged into.
92
96
93
97
```
94
98
USAGE
95
- $ sf env:list
96
-
97
- OPTIONS
98
- -a, --all Show all environments, including inactive orgs.
99
- -x, --extended show extra columns
100
- --columns=columns only show provided columns (comma-separated)
101
- --csv output is csv format [alias: --output=csv]
102
- --filter=filter filter property by partial string matching, ex: name=foo
103
- --json format output as json
104
- --no-header hide table header from output
105
- --no-truncate do not truncate output to fit screen
106
- --output=csv|json|yaml output in a more machine friendly format
107
- --sort=sort property to sort by (prepend '-' for descending)
99
+ $ sf env list [--json] [-a] [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output
100
+ csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ]
108
101
109
- EXAMPLES
110
- sf env list
111
- sf env list --all
112
- ```
102
+ FLAGS
103
+ -a, --all Show all environments, including inactive orgs.
104
+ -x, --extended show extra columns
105
+ --columns=<value> only show provided columns (comma-separated)
106
+ --csv output is csv format [alias: --output=csv]
107
+ --filter=<value> filter property by partial string matching, ex: name=foo
108
+ --no-header hide table header from output
109
+ --no-truncate do not truncate output to fit screen
113
110
114
- _ See code: [ src/commands/env/list.ts] ( https://github.com/salesforcecli/plugin-env/blob/v0.0.6/src/commands/env/list.ts ) _
111
+ --output=<option> output in a more machine friendly format
112
+ <options: csv|json|yaml>
115
113
116
- ## ` sf env:open `
114
+ --sort=<value> property to sort by (prepend '-' for descending)
117
115
118
- You can open the following types of environments in a web browser: scratch orgs, sandboxes, Dev Hubs, and production orgs.
116
+ GLOBAL FLAGS
117
+ --json format output as json
119
118
120
- ```
121
- USAGE
122
- $ sf env:open
119
+ DESCRIPTION
120
+ List the environments you’ve created or logged into.
123
121
124
- OPTIONS
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.
122
+ EXAMPLES
123
+ $ sf env list
129
124
130
- For Dev Hubs, sandboxes, and production orgs, specify the alias you set when you logged into the org with "sf
131
- login".
125
+ $ sf env list --all
126
+ ```
132
127
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.
128
+ ## ` sf env open `
137
129
138
- -r, --url-only
130
+ You can open the following types of environments in a web browser: scratch orgs, sandboxes, Dev Hubs, and production orgs.
139
131
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.
132
+ ```
133
+ USAGE
134
+ $ sf env open [--json] [-p <value>] [-r] [-e <value>] [--browser <value>]
144
135
145
- For convenience, "chrome", "firefox", and "edge" are mapped to the OS specific app name.
136
+ 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.
139
+ -r, --url-only Display the URL, but don’t launch it in a browser.
140
+ --browser=<value> Browser in which to open the environment.
146
141
147
- --json
148
- format output as json
142
+ GLOBAL FLAGS
143
+ --json format output as json
149
144
150
145
DESCRIPTION
146
+ Open an environment in your web browser.
147
+
148
+ You can open the following types of environments in a web browser: scratch orgs, sandboxes, Dev Hubs, and production
149
+ orgs.
150
+
151
151
If you run the command without flags, it attempts to open your default environment in your default web browser.
152
152
153
153
EXAMPLES
154
154
To open your default environment, run the command without flags:
155
- sf env open
155
+
156
+ $ sf env open
157
+
156
158
This example opens the Visualforce page /apex/StartHere in a scratch org with alias "test-org":
157
- sf env open --target-env test-org --path /apex/StartHere
159
+
160
+ $ sf env open --target-env test-org --path /apex/StartHere
161
+
158
162
If you want to view the URL for the preceding command, but not launch it in a browser:
159
- sf env open --target-env test-org --path /apex/StartHere --url-only
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:
162
- sf env open --target-env test-org --path /apex/StartHere --browser "google chrome"
163
- ```
164
163
165
- _ See code: [ src/commands/env/open.ts] ( https://github.com/salesforcecli/plugin-env/blob/v0.0.6/src/commands/env/open.ts ) _
164
+ $ sf env open --target-env test-org --path /apex/StartHere --url-only
165
+
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:
168
+
169
+ $ sf env open --target-env test-org --path /apex/StartHere --browser "google chrome"
170
+
171
+ FLAG DESCRIPTIONS
172
+ -e, --target-env=<value> Environment name or alias to open.
173
+
174
+ Specify the login user or alias that’s associated with the environment. For scratch orgs, the login user is
175
+ generated by the command that created the scratch org. You can also set an alias for the scratch org when you create
176
+ it.
177
+
178
+ For Dev Hubs, sandboxes, and production orgs, specify the alias you set when you logged into the org with "sf
179
+ login".
180
+
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
+
187
+ --browser=<value> Browser in which to open the environment.
188
+
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.
194
+ ```
166
195
<!-- commandsstop -->
0 commit comments