Skip to content

Commit 684ef09

Browse files
Merge pull request #405 from salesforcecli/jshackell/messages
fix: clean up help for "config list"
2 parents e36fc24 + 1a70e03 commit 684ef09

File tree

4 files changed

+13
-13
lines changed

4 files changed

+13
-13
lines changed

messages/config.get.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ Get the value of a configuration variable.
44

55
# description
66

7-
Run "sf config list" to see all the configuration variables you've set. Global configuration variable are always displayed; local ones are displayed if you run the command in a project directory. Run "sf config set" to set a configuration variable.
7+
Run "sf config list" to see the configuration variables you've already set and their level (local or global).
88

9-
For the full list of available configuration variables, see https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_dev_cli_config_values.htm.
9+
Run "sf config set" to set a configuration variable. For the full list of available configuration variables, see https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_dev_cli_config_values.htm.
1010

1111
# examples
1212

messages/config.list.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,14 @@ List the configuration variables that you've previously set.
44

55
# description
66

7-
Global configuration variables apply to any Salesforce DX project and are always displayed. If you run this command from a project directory, local configuration variables are also displayed.
7+
A config variable can be global or local, depending on whether you used the --global flag when you set it. Local config variables apply only to the current project and override global config variables, which apply to all projects. You can set all config variables as environment variables. Environment variables override their equivalent local and global config variables.
8+
9+
The output of this command takes into account your current context. For example, let's say you run this command from a Salesforce DX project in which you've locally set the "target-org" config variable. The command displays the local value, even if you've also set "target-org" globally. If you haven't set the config variable locally, then the global value is displayed, if set. If you set the SF_TARGET_ORG environment variable, it's displayed as such and overrides any locally or globally set "target-org" config variable.
810

911
For the full list of available configuration variables, see https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_dev_cli_config_values.htm.
1012

1113
# examples
1214

13-
- List both global configuration variables and those local to your project:
15+
- List the global and local configuration variables that apply to your current context:
1416

1517
$ <%= config.bin %> <%= command.id %>

messages/config.set.md

+6-8
Original file line numberDiff line numberDiff line change
@@ -16,25 +16,23 @@ The resolution order if you've set a flag value in multiple ways is as follows:
1616

1717
Run "sf config list" to see the configuration variables you've already set and their level (local or global).
1818

19+
If you're setting a single config variable, you don't need to use an equal sign between the variable and value. But you must use the equal sign if setting multiple config variables.
20+
1921
For the full list of available configuration variables, see https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_dev_cli_config_values.htm.
2022

2123
# examples
2224

2325
- Set the local target-org configuration variable to an org username:
2426

25-
<%= config.bin %> <%= command.id %> target-org=[email protected]
27+
<%= config.bin %> <%= command.id %> target-org [email protected]
2628

2729
- Set the local target-org configuration variable to an alias:
2830

29-
<%= config.bin %> <%= command.id %> target-org=my-scratch-org
30-
31-
- Set the global target-org configuration variable:
32-
33-
<%= config.bin %> <%= command.id %> --global target-org=my-scratch-org
31+
<%= config.bin %> <%= command.id %> target-org my-scratch-org
3432

35-
- Set a single configuration variable without using an equal sign; this syntax doesn't work when setting multiple configuration variables:
33+
- Set the global target-org and target-dev-hub configuration variables using aliases:
3634

37-
<%= config.bin %> <%= command.id %> target-org [email protected]
35+
<%= config.bin %> <%= command.id %> --global target-org=my-scratch-org target-dev-hub=my-dev-hub
3836

3937
# flags.global.summary
4038

messages/config.unset.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ For the full list of available configuration variables, see https://developer.sa
2020

2121
# flags.global.summary
2222

23-
Unset the configuration variables globally, so they can no longer be used from any Salesforce DX project.
23+
Unset the configuration variables globally.
2424

2525
# error.NoConfigKeysFound
2626

0 commit comments

Comments
 (0)