feat: bump sf-plugins-core

salesforcecli · Mar 25, 2024 · 786f8b5 · 786f8b5
1 parent a2f4fc7
commit 786f8b5
Show file tree

Hide file tree

Showing 4 changed files with 333 additions and 38 deletions.
diff --git a/README.md b/README.md
@@ -74,9 +74,304 @@ sf plugins
 
 <!-- commands -->
 
-# Command Topics
+- [`sf alias list`](#sf-alias-list)
+- [`sf alias set`](#sf-alias-set)
+- [`sf alias unset`](#sf-alias-unset)
+- [`sf config get`](#sf-config-get)
+- [`sf config list`](#sf-config-list)
+- [`sf config set`](#sf-config-set)
+- [`sf config unset`](#sf-config-unset)
 
-- [`sf alias`](docs/alias.md) - Use the alias commands to manage your aliases.
-- [`sf config`](docs/config.md) - Commands to configure Salesforce CLI.
+## `sf alias list`
+
+List all aliases currently set on your local computer.
+
+```
+USAGE
+  $ sf alias list [--json] [--flags-dir <value>]
+
+GLOBAL FLAGS
+  --flags-dir=<value>  Import flag values from a directory.
+  --json               Format output as json.
+
+DESCRIPTION
+  List all aliases currently set on your local computer.
+
+  Aliases are global, which means that you can use all the listed aliases in any Salesforce DX project on your computer.
+
+ALIASES
+  $ sf force alias list
+
+EXAMPLES
+  List all the aliases you've set:
+
+    $ sf alias list
+```
+
+_See code: [src/commands/alias/list.ts](https://github.com/salesforcecli/plugin-settings/blob/2.0.33/src/commands/alias/list.ts)_
+
+## `sf alias set`
+
+Set one or more aliases on your local computer.
+
+```
+USAGE
+  $ sf alias set [--json] [--flags-dir <value>]
+
+GLOBAL FLAGS
+  --flags-dir=<value>  Import flag values from a directory.
+  --json               Format output as json.
+
+DESCRIPTION
+  Set one or more aliases on your local computer.
+
+  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.
+
+  You 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.
+
+  Use 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.
+
+ALIASES
+  $ sf force alias set
+
+EXAMPLES
+  Set an alias for a scratch org username:
+
+    $ sf alias set [email protected]
+
+  Set multiple aliases with a single command:
+
+    $ sf alias set [email protected] [email protected]
+
+  Set an alias that contains spaces:
+
+    $ sf alias set my-alias='alias with spaces'
+
+  Set a single alias without using an equal sign:
+
+    $ sf alias set my-scratch-org [email protected]
+```
+
+_See code: [src/commands/alias/set.ts](https://github.com/salesforcecli/plugin-settings/blob/2.0.33/src/commands/alias/set.ts)_
+
+## `sf alias unset`
+
+Unset one or more aliases that are currently set on your local computer.
+
+```
+USAGE
+  $ sf alias unset [--json] [--flags-dir <value>] [-a] [-p]
+
+FLAGS
+  -a, --all        Unset all currently set aliases.
+  -p, --no-prompt  Don't prompt the user for confirmation when unsetting all aliases.
+
+GLOBAL FLAGS
+  --flags-dir=<value>  Import flag values from a directory.
+  --json               Format output as json.
+
+DESCRIPTION
+  Unset one or more aliases that are currently set on your local computer.
+
+  Aliases are global, so when you unset one it's no longer available in any Salesforce DX project.
+
+ALIASES
+  $ sf force alias unset
+
+EXAMPLES
+  Unset an alias:
+
+    $ sf alias unset my-alias
+
+  Unset multiple aliases with a single command:
+
+    $ sf alias unset my-alias my-other-alias
+
+  Unset all aliases:
+
+    $ sf alias unset --all [--no-prompt]
+```
+
+_See code: [src/commands/alias/unset.ts](https://github.com/salesforcecli/plugin-settings/blob/2.0.33/src/commands/alias/unset.ts)_
+
+## `sf config get`
+
+Get the value of a configuration variable.
+
+```
+USAGE
+  $ sf config get [--json] [--flags-dir <value>] [--verbose]
+
+FLAGS
+  --verbose  Display whether the configuration variables are set locally or globally.
+
+GLOBAL FLAGS
+  --flags-dir=<value>  Import flag values from a directory.
+  --json               Format output as json.
+
+DESCRIPTION
+  Get the value of a configuration variable.
+
+  Run "sf config list" to see the configuration variables you've already set and their level (local or global).
+
+  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.
+
+ALIASES
+  $ sf force config get
+
+EXAMPLES
+  Get the value of the "target-org" configuration variable.
+
+    $ sf config get target-org
+
+  Get multiple configuration variables and display whether they're set locally or globally:
+
+    $ sf config get target-org api-version --verbose
+```
+
+_See code: [src/commands/config/get.ts](https://github.com/salesforcecli/plugin-settings/blob/2.0.33/src/commands/config/get.ts)_
+
+## `sf config list`
+
+List the configuration variables that you've previously set.
+
+```
+USAGE
+  $ sf config list [--json] [--flags-dir <value>]
+
+GLOBAL FLAGS
+  --flags-dir=<value>  Import flag values from a directory.
+  --json               Format output as json.
+
+DESCRIPTION
+  List the configuration variables that you've previously set.
+
+  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.
+
+ALIASES
+  $ sf force config list
+
+EXAMPLES
+  List the global and local configuration variables that apply to your current context:
+
+    $ sf config list
+```
+
+_See code: [src/commands/config/list.ts](https://github.com/salesforcecli/plugin-settings/blob/2.0.33/src/commands/config/list.ts)_
+
+## `sf config set`
+
+Set one or more configuration variables, such as your default org.
+
+```
+USAGE
+  $ sf config set [--json] [--flags-dir <value>] [-g]
+
+FLAGS
+  -g, --global  Set the configuration variables globally, so they can be used from any Salesforce DX project.
+
+GLOBAL FLAGS
+  --flags-dir=<value>  Import flag values from a directory.
+  --json               Format output as json.
+
+DESCRIPTION
+  Set one or more configuration variables, such as your default org.
+
+  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.
+
+  Local configuration variables apply only to your current project. Global variables, specified with the --global flag,
+  apply in any Salesforce DX project.
+
+  The resolution order if you've set a flag value in multiple ways is as follows:
+
+  1. Flag value specified at the command line.
+  2. Local (project-level) configuration variable.
+  3. Global configuration variable.
+
+  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.
+
+ALIASES
+  $ sf force config set
+
+EXAMPLES
+  Set the local target-org configuration variable to an org username:
+
+    $ sf config set target-org [email protected]
+
+  Set the local target-org configuration variable to an alias:
+
+    $ sf config set target-org my-scratch-org
+
+  Set the global target-org and target-dev-hub configuration variables using aliases:
+
+    $ sf config set --global target-org=my-scratch-org target-dev-hub=my-dev-hub
+```
+
+_See code: [src/commands/config/set.ts](https://github.com/salesforcecli/plugin-settings/blob/2.0.33/src/commands/config/set.ts)_
+
+## `sf config unset`
+
+Unset local or global configuration variables.
+
+```
+USAGE
+  $ sf config unset [--json] [--flags-dir <value>] [-g]
+
+FLAGS
+  -g, --global  Unset the configuration variables globally.
+
+GLOBAL FLAGS
+  --flags-dir=<value>  Import flag values from a directory.
+  --json               Format output as json.
+
+DESCRIPTION
+  Unset local or global configuration variables.
+
+  Local configuration variables apply only to your current project. Global configuration variables apply in any
+  Salesforce DX project.
+
+  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.
+
+ALIASES
+  $ sf force config unset
+
+EXAMPLES
+  Unset the local "target-org" configuration variable:
+
+    $ sf config unset target-org
+
+  Unset multiple configuration variables globally:
+
+    $ sf config unset target-org api-version --global
+```
+
+_See code: [src/commands/config/unset.ts](https://github.com/salesforcecli/plugin-settings/blob/2.0.33/src/commands/config/unset.ts)_
 
 <!-- commandsstop -->
diff --git a/command-snapshot.json b/command-snapshot.json
@@ -1,58 +1,58 @@
 [
   {
-    "command": "alias:list",
-    "plugin": "@salesforce/plugin-settings",
-    "flags": ["json", "loglevel"],
     "alias": ["force:alias:list"],
+    "command": "alias:list",
+    "flagAliases": [],
     "flagChars": [],
-    "flagAliases": []
+    "flags": ["flags-dir", "json", "loglevel"],
+    "plugin": "@salesforce/plugin-settings"
   },
   {
-    "command": "alias:set",
-    "plugin": "@salesforce/plugin-settings",
-    "flags": ["json", "loglevel"],
     "alias": ["force:alias:set"],
+    "command": "alias:set",
+    "flagAliases": [],
     "flagChars": [],
-    "flagAliases": []
+    "flags": ["flags-dir", "json", "loglevel"],
+    "plugin": "@salesforce/plugin-settings"
   },
   {
-    "command": "alias:unset",
-    "plugin": "@salesforce/plugin-settings",
-    "flags": ["all", "json", "loglevel", "no-prompt"],
     "alias": ["force:alias:unset"],
+    "command": "alias:unset",
+    "flagAliases": [],
     "flagChars": ["a", "p"],
-    "flagAliases": []
+    "flags": ["all", "flags-dir", "json", "loglevel", "no-prompt"],
+    "plugin": "@salesforce/plugin-settings"
   },
   {
-    "command": "config:get",
-    "plugin": "@salesforce/plugin-settings",
-    "flags": ["json", "loglevel", "verbose"],
     "alias": ["force:config:get"],
+    "command": "config:get",
+    "flagAliases": [],
     "flagChars": [],
-    "flagAliases": []
+    "flags": ["flags-dir", "json", "loglevel", "verbose"],
+    "plugin": "@salesforce/plugin-settings"
   },
   {
-    "command": "config:list",
-    "plugin": "@salesforce/plugin-settings",
-    "flags": ["json", "loglevel"],
     "alias": ["force:config:list"],
+    "command": "config:list",
+    "flagAliases": [],
     "flagChars": [],
-    "flagAliases": []
+    "flags": ["flags-dir", "json", "loglevel"],
+    "plugin": "@salesforce/plugin-settings"
   },
   {
-    "command": "config:set",
-    "plugin": "@salesforce/plugin-settings",
-    "flags": ["global", "json", "loglevel"],
     "alias": ["force:config:set"],
+    "command": "config:set",
+    "flagAliases": [],
     "flagChars": ["g"],
-    "flagAliases": []
+    "flags": ["flags-dir", "global", "json", "loglevel"],
+    "plugin": "@salesforce/plugin-settings"
   },
   {
-    "command": "config:unset",
-    "plugin": "@salesforce/plugin-settings",
-    "flags": ["global", "json", "loglevel"],
     "alias": ["force:config:unset"],
+    "command": "config:unset",
+    "flagAliases": [],
     "flagChars": ["g"],
-    "flagAliases": []
+    "flags": ["flags-dir", "global", "json", "loglevel"],
+    "plugin": "@salesforce/plugin-settings"
   }
 ]