@salesforce/plugin-settings

{ "commands": { "alias:list": { "aliases": [ "force:alias:list" ], "args": {}, "deprecateAliases": true, "description": "Aliases are global, which means that you can use all the listed aliases in any Salesforce DX project on your computer.", "examples": [ "List all the aliases you've set:\n<%= config.bin %> <%= command.id %>" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "alias:list", "pluginAlias": "@salesforce/plugin-settings", "pluginName": "@salesforce/plugin-settings", "pluginType": "core", "strict": true, "summary": "List all aliases currently set on your local computer.", "isESM": true, "relativePath": [ "lib", "commands", "alias", "list.js" ], "aliasPermutations": [ "force:alias:list", "alias:force:list", "alias:list:force", "force:list:alias", "list:force:alias", "list:alias:force" ], "permutations": [ "alias:list", "list:alias" ] }, "alias:set": { "aliases": [ "force:alias:set" ], "args": {}, "deprecateAliases": true, "description": "Aliases are user-defined short names that make it easier to use the CLI. For example, users often set an alias for a scratch org usernames because they're long and unintuitive. Check the --help of a CLI command to determine where you can use an alias.\n\nYou can associate an alias with only one value at a time. If you set an alias multiple times, the alias points to the most recent value. Aliases are global; after you set an alias, you can use it in any Salesforce DX project on your computer.\n\nUse quotes to specify an alias value that contains spaces. You typically use an equal sign to set your alias, although you don't need it if you're setting a single alias in a command.", "examples": [ "Set an alias for a scratch org username:\n<%= config.bin %> <%= command.id %> my-scratch-org=test-sadbiytjsupn@example.com", "Set multiple aliases with a single command:\n<%= config.bin %> <%= command.id %> my-scratch-org=test-sadbiytjsupn@example.com my-other-scratch-org=test-ss0xut7txzxf@example.com", "Set an alias that contains spaces:\n<%= config.bin %> <%= command.id %> my-alias='alias with spaces'", "Set a single alias without using an equal sign:\n<%= config.bin %> <%= command.id %> my-scratch-org test-ss0xut7txzxf@example.com" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "alias:set", "pluginAlias": "@salesforce/plugin-settings", "pluginName": "@salesforce/plugin-settings", "pluginType": "core", "strict": false, "summary": "Set one or more aliases on your local computer.", "isESM": true, "relativePath": [ "lib", "commands", "alias", "set.js" ], "aliasPermutations": [ "force:alias:set", "alias:force:set", "alias:set:force", "force:set:alias", "set:force:alias", "set:alias:force" ], "permutations": [ "alias:set", "set:alias" ] }, "alias:unset": { "aliases": [ "force:alias:unset" ], "args": {}, "deprecateAliases": true, "description": "Aliases are global, so when you unset one it's no longer available in any Salesforce DX project.", "examples": [ "Unset an alias:\n<%= config.bin %> <%= command.id %> my-alias", "Unset multiple aliases with a single command:\n<%= config.bin %> <%= command.id %> my-alias my-other-alias", "Unset all aliases:\n<%= config.bin %> <%= command.id %> --all [--no-prompt]" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "all": { "char": "a", "name": "all", "summary": "Unset all currently set aliases.", "allowNo": false, "type": "boolean" }, "no-prompt": { "char": "p", "name": "no-prompt", "summary": "Don't prompt the user for confirmation when unsetting all aliases.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "alias:unset", "pluginAlias": "@salesforce/plugin-settings", "pluginName": "@salesforce/plugin-settings", "pluginType": "core", "strict": false, "summary": "Unset one or more aliases that are currently set on your local computer.", "isESM": true, "relativePath": [ "lib", "commands", "alias", "unset.js" ], "aliasPermutations": [ "force:alias:unset", "alias:force:unset", "alias:unset:force", "force:unset:alias", "unset:force:alias", "unset:alias:force" ], "permutations": [ "alias:unset", "unset:alias" ] }, "config:get": { "aliases": [ "force:config:get" ], "args": {}, "deprecateAliases": true, "description": "Run \"sf config list\" to see the configuration variables you've already set and their level (local or global).\n\nRun \"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": [ "Get the value of the \"target-org\" configuration variable.\n<%= config.bin %> <%= command.id %> target-org", "Get multiple configuration variables and display whether they're set locally or globally:\n<%= config.bin %> <%= command.id %> target-org api-version --verbose" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "verbose": { "name": "verbose", "summary": "Display whether the configuration variables are set locally or globally.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "config:get", "pluginAlias": "@salesforce/plugin-settings", "pluginName": "@salesforce/plugin-settings", "pluginType": "core", "strict": false, "summary": "Get the value of a configuration variable.", "enableJsonFlag": true, "configurationVariablesSection": { "header": "CONFIGURATION VARIABLES", "body": [ { "name": "org-instance-url", "description": "URL of the Salesforce instance hosting your org. Default: https://login.salesforce.com." }, { "name": "org-api-version", "description": "API version of your project. Default: API version of your Dev Hub org." }, { "name": "target-dev-hub", "description": "Username or alias of your default Dev Hub org. (sf only)" }, { "name": "target-org", "description": "Username or alias of the org that all commands run against by default. (sf only)" }, { "name": "org-isv-debugger-sid", "description": "ISV debugger SID." }, { "name": "org-isv-debugger-url", "description": "ISV debugger URL." }, { "name": "org-custom-metadata-templates", "description": "A valid repository URL or directory for the custom org metadata templates." }, { "name": "org-max-query-limit", "description": "Maximum number of Salesforce records returned by a CLI command. Default: 10,000." }, { "name": "org-capitalize-record-types", "description": "Whether record types are capitalized on scratch org creation." } ] }, "isESM": true, "relativePath": [ "lib", "commands", "config", "get.js" ], "aliasPermutations": [ "force:config:get", "config:force:get", "config:get:force", "force:get:config", "get:force:config", "get:config:force" ], "permutations": [ "config:get", "get:config" ] }, "config:list": { "aliases": [ "force:config:list" ], "args": {}, "deprecateAliases": true, "description": "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.\n\nThe 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. \n\nFor 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 the global and local configuration variables that apply to your current context:\n$ <%= config.bin %> <%= command.id %>" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "config:list", "pluginAlias": "@salesforce/plugin-settings", "pluginName": "@salesforce/plugin-settings", "pluginType": "core", "strict": true, "summary": "List the configuration variables that you've previously set.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "config", "list.js" ], "aliasPermutations": [ "force:config:list", "config:force:list", "config:list:force", "force:list:config", "list:force:config", "list:config:force" ], "permutations": [ "config:list", "list:config" ] }, "config:set": { "aliases": [ "force:config:set" ], "args": {}, "deprecateAliases": true, "description": "Use configuration variables to set CLI defaults, such as your default org or the API version you want the CLI to use. For example, if you set the \"target-org\" configuration variable, you don't need to specify it as a \"sf deploy metadata\" flag if you're deploying to your default org.\n\nLocal configuration variables apply only to your current project. Global variables, specified with the --global flag, apply in any Salesforce DX project.\n\nThe resolution order if you've set a flag value in multiple ways is as follows:\n\n 1. Flag value specified at the command line.\n 2. Local (project-level) configuration variable.\n 3. Global configuration variable.\n\nRun \"sf config list\" to see the configuration variables you've already set and their level (local or global).\n\nIf 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.\n\nFor 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:\n<%= config.bin %> <%= command.id %> target-org me@my.org", "Set the local target-org configuration variable to an alias:\n<%= config.bin %> <%= command.id %> target-org my-scratch-org", "Set the global target-org and target-dev-hub configuration variables using aliases:\n<%= config.bin %> <%= command.id %> --global target-org=my-scratch-org target-dev-hub=my-dev-hub" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "global": { "char": "g", "name": "global", "summary": "Set the configuration variables globally, so they can be used from any Salesforce DX project.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "config:set", "pluginAlias": "@salesforce/plugin-settings", "pluginName": "@salesforce/plugin-settings", "pluginType": "core", "strict": false, "summary": "Set one or more configuration variables, such as your default org.", "enableJsonFlag": true, "configurationVariablesSection": { "header": "CONFIGURATION VARIABLES", "body": [ { "name": "org-instance-url", "description": "URL of the Salesforce instance hosting your org. Default: https://login.salesforce.com." }, { "name": "org-api-version", "description": "API version of your project. Default: API version of your Dev Hub org." }, { "name": "target-dev-hub", "description": "Username or alias of your default Dev Hub org. (sf only)" }, { "name": "target-org", "description": "Username or alias of the org that all commands run against by default. (sf only)" }, { "name": "org-isv-debugger-sid", "description": "ISV debugger SID." }, { "name": "org-isv-debugger-url", "description": "ISV debugger URL." }, { "name": "org-custom-metadata-templates", "description": "A valid repository URL or directory for the custom org metadata templates." }, { "name": "org-max-query-limit", "description": "Maximum number of Salesforce records returned by a CLI command. Default: 10,000." }, { "name": "org-capitalize-record-types", "description": "Whether record types are capitalized on scratch org creation." } ] }, "isESM": true, "relativePath": [ "lib", "commands", "config", "set.js" ], "aliasPermutations": [ "force:config:set", "config:force:set", "config:set:force", "force:set:config", "set:force:config", "set:config:force" ], "permutations": [ "config:set", "set:config" ] }, "config:unset": { "aliases": [ "force:config:unset" ], "args": {}, "deprecateAliases": true, "description": "Local configuration variables apply only to your current project. Global configuration variables apply in any Salesforce DX project.\n\nFor 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": [ "Unset the local \"target-org\" configuration variable:\n<%= config.bin %> <%= command.id %> target-org", "Unset multiple configuration variables globally:\n<%= config.bin %> <%= command.id %> target-org api-version --global" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "global": { "char": "g", "name": "global", "summary": "Unset the configuration variables globally.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "config:unset", "pluginAlias": "@salesforce/plugin-settings", "pluginName": "@salesforce/plugin-settings", "pluginType": "core", "strict": false, "summary": "Unset local or global configuration variables.", "enableJsonFlag": true, "configurationVariablesSection": { "header": "CONFIGURATION VARIABLES", "body": [ { "name": "org-instance-url", "description": "URL of the Salesforce instance hosting your org. Default: https://login.salesforce.com." }, { "name": "org-api-version", "description": "API version of your project. Default: API version of your Dev Hub org." }, { "name": "target-dev-hub", "description": "Username or alias of your default Dev Hub org. (sf only)" }, { "name": "target-org", "description": "Username or alias of the org that all commands run against by default. (sf only)" }, { "name": "org-isv-debugger-sid", "description": "ISV debugger SID." }, { "name": "org-isv-debugger-url", "description": "ISV debugger URL." }, { "name": "org-custom-metadata-templates", "description": "A valid repository URL or directory for the custom org metadata templates." }, { "name": "org-max-query-limit", "description": "Maximum number of Salesforce records returned by a CLI command. Default: 10,000." }, { "name": "org-capitalize-record-types", "description": "Whether record types are capitalized on scratch org creation." } ] }, "isESM": true, "relativePath": [ "lib", "commands", "config", "unset.js" ], "aliasPermutations": [ "force:config:unset", "config:force:unset", "config:unset:force", "force:unset:config", "unset:force:config", "unset:config:force" ], "permutations": [ "config:unset", "unset:config" ] } }, "version": "2.4.40" }