Skip to content

Commit

Permalink
fix: clean up help
Browse files Browse the repository at this point in the history
  • Loading branch information
jshackell-sfdc committed Oct 16, 2023
1 parent 4e727eb commit 58f7267
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 13 deletions.
4 changes: 2 additions & 2 deletions messages/config.get.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ Get the value of a configuration variable.

# description

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.
Run "sf config list" to see the configuration variables you've already set and their level (local or global).

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.
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.

# examples

Expand Down
6 changes: 4 additions & 2 deletions messages/config.list.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,14 @@ List the configuration variables that you've previously set.

# description

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.
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 take precedence over global config variables, which apply to all projects. Both global and local config variables take precedence over their equivalent environment variables.

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 this 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, but not "target-org" either globally or locally, then the environment variable value is displayed.

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.

# examples

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

$ <%= config.bin %> <%= command.id %>
14 changes: 6 additions & 8 deletions messages/config.set.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,25 +16,23 @@ The resolution order if you've set a flag value in multiple ways is as follows:

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

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.

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.

# examples

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

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

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

<%= config.bin %> <%= command.id %> target-org=my-scratch-org

- Set the global target-org configuration variable:

<%= config.bin %> <%= command.id %> --global target-org=my-scratch-org
<%= config.bin %> <%= command.id %> target-org my-scratch-org

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

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

# flags.global.summary

Expand Down
2 changes: 1 addition & 1 deletion messages/config.unset.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ For the full list of available configuration variables, see https://developer.sa

# flags.global.summary

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

# error.NoConfigKeysFound

Expand Down

0 comments on commit 58f7267

Please sign in to comment.