generated from salesforcecli/plugin-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update help markdown files for all "sf env" commands (#84)
- Loading branch information
1 parent
2cea21e
commit 499d054
Showing
4 changed files
with
75 additions
and
42 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,27 +1,42 @@ | ||
# summary | ||
|
||
Display details about an environment. | ||
|
||
# description | ||
|
||
Display details about a specific environment | ||
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. | ||
|
||
Output depends on the type of environment. For example, scratch org details include the access token, alias, username of the associated Dev Hub, the creation and expiration date, the generated scratch org username, and more. Compute environment details include the associated orgs, the list of functions, the project name, and more. | ||
|
||
# examples | ||
|
||
- sf env display -e my-scratch-org | ||
- sf env display -e [email protected] | ||
- Display details about a scratch org with alias my-scratch-org: | ||
|
||
<%= config.bin %> <%= command.id %> --environment=my-scratch-org | ||
|
||
- Specify a username instead of an alias: | ||
|
||
<%= config.bin %> <%= command.id %> --environment=[email protected] | ||
|
||
- Specify JSON format and redirect output into a file: | ||
|
||
<%= config.bin %> <%= command.id %> --environment=my-scratch-org --json > tmp/MyOrdDesc.json | ||
|
||
# flags.environment.summary | ||
|
||
Environment name or alias to display. | ||
Environment alias or login user. | ||
|
||
# error.NoResultsFound | ||
|
||
No results found | ||
No results found. | ||
|
||
# error.NoEnvFound | ||
|
||
No environment found for %s. | ||
|
||
# error.NoDefaultEnv | ||
|
||
No default environment found. Use -e or --environment to specify which env to open. | ||
No default environment found. Use -e or --environment to specify an environment to open. | ||
|
||
# error.NoAuthsAvailable | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,43 @@ | ||
# summary | ||
|
||
List the environments you’ve created or logged into. | ||
|
||
# description | ||
|
||
List the environments you’ve created or logged into. | ||
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. | ||
|
||
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. | ||
|
||
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. | ||
|
||
Run "sf env display" to view details about a specific environment. | ||
|
||
# examples | ||
|
||
- sf env list | ||
- sf env list --all | ||
- List all environments: | ||
|
||
<%= config.bin %> <%= command.id %> --all | ||
|
||
- 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. | ||
|
||
<%= config.bin %> <%= command.id %> --filter "Status=Connected" | ||
|
||
- List only scratch orgs that expire after May 30, 2021: | ||
|
||
<%= config.bin %> <%= command.id %> --filter "Expiration>2021-05-30" | ||
|
||
- Display only the Alias column and sort the aliases in descending order: | ||
|
||
<%= config.bin %> <%= command.id %> --sort "-Alias" --columns "Alias" | ||
|
||
# flags.all.summary | ||
|
||
Show all environments, including inactive orgs. | ||
Show all environments, even inactive ones. | ||
|
||
# error.NoAuthsAvailable | ||
|
||
There are no authentications available. | ||
|
||
# error.NoResultsFound | ||
|
||
No results found | ||
No results found. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters