Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: clean up help for "config list" #405

Merged
merged 2 commits into from
Oct 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 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.

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.

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