Skip to content

Commit 7b490ea

Browse files
sf env: update help and package.json (topic description) (#97)
* fix: clean up "env" help and package.json file * fix: update help for "sf env list" remove --all info and stuff about compute environments
1 parent 7d42866 commit 7b490ea

File tree

2 files changed

+22
-16
lines changed

2 files changed

+22
-16
lines changed

messages/list.md

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,39 +4,45 @@ List the environments you’ve created or logged into.
44

55
# description
66

7-
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.
7+
The command displays only active environments. For orgs, active means unexpired scratch orgs and orgs you’re currently logged into.
88

9-
Output is displayed in multiple tables, one for each environment type. For example, the Salesforce Orgs table lists the non-scratch orgs you’re logged into, such as sandboxes, Dev Hubs, production orgs, and so on. Scratch orgs and compute environments get their own tables.
9+
Output is displayed in multiple tables, one for each environment type. For example, the Salesforce Orgs table lists the non-scratch orgs you’re logged into, such as sandboxes, Dev Hubs, production orgs, and so on. Scratch orgs get their own table.
1010

11-
For non-scratch orgs, the Username column refers to the user you logged into the org with. For scratch orgs it refers to the username that was generated for you when you created the scratch org. The first column indicates the default environment for each type.
11+
For non-scratch orgs, the Username column refers to the user you logged into the org with. For scratch orgs it refers to the username that was generated for you when you created the scratch org. The table also displays the default environment for each type, the instance URL, and how you authorized (logged into) the org, either using a web browser or JWT.
12+
13+
Use the table-manipulation flags, such as --filter and --sort, to change how the data is displayed.
1214

1315
Run "sf env display" to view details about a specific environment.
1416

1517
# examples
1618

17-
- List all environments:
18-
19-
<%= config.bin %> <%= command.id %> --all
20-
21-
- Filter the output to list only connected orgs. Rows from only the Salesforce Orgs table are displayed because it’s the only table with a "Status" column.
19+
- List all active environments:
2220

23-
<%= config.bin %> <%= command.id %> --filter "Status=Connected"
21+
<%= config.bin %> <%= command.id %>
2422

25-
- List only scratch orgs that expire after May 30, 2021:
23+
- Filter the output to list only orgs you authorized using a web browser; "OAuth Method" is the name of a column:
2624

27-
<%= config.bin %> <%= command.id %> --filter "Expiration>2021-05-30"
25+
<%= config.bin %> <%= command.id %> --filter "OAuth Method=web"
2826

2927
- Display only the Alias column and sort the aliases in descending order:
3028

3129
<%= config.bin %> <%= command.id %> --sort "-Alias" --columns "Alias"
3230

31+
- Don't truncate the displayed output:
32+
33+
<%= config.bin %> <%= command.id %> --no-truncate
34+
35+
- Display only the table data, not the headers, in comma-separated value (csv) format:
36+
37+
<%= config.bin %> <%= command.id %> --csv --no-header
38+
3339
# flags.extended.summary
3440

3541
Show extra columns.
3642

3743
# flags.columns.summary
3844

39-
Only show provided columns.
45+
List of columns to display.
4046

4147
# flags.csv.summary
4248

@@ -52,15 +58,15 @@ Hide table header from output.
5258

5359
# flags.no-truncate.summary
5460

55-
Do not truncate output to fit screen.
61+
Don't truncate output to fit screen.
5662

5763
# flags.output.summary
5864

59-
Output in a more machine friendly format.
65+
Format in which to display the output.
6066

6167
# flags.sort.summary
6268

63-
Property to sort by (prepend '-' for descending).
69+
Column to sort by (prepend '-' for descending).
6470

6571
# error.NoAuthsAvailable
6672

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@
7979
],
8080
"topics": {
8181
"env": {
82-
"description": "Commands to work with enviornments."
82+
"description": "Manage your environments, such as orgs."
8383
}
8484
}
8585
},

0 commit comments

Comments
 (0)