@salesforce/cli 1.42.0 → 1.43.0

package/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [1.43.0](https://github.com/salesforcecli/cli/compare/v1.42.0...v1.43.0) (2022-08-24)
+
 ## [1.42.0](https://github.com/salesforcecli/cli/compare/v1.41.0...v1.42.0) (2022-08-17)
 
 ## [1.41.0](https://github.com/salesforcecli/cli/compare/v1.40.0...v1.41.0) (2022-08-10)

package/README.md

@@ -32,7 +32,7 @@ $ npm install -g @salesforce/cli
 $ sf COMMAND
 running command...
 $ sf (--version|-v)
-@salesforce/cli/1.42.0 linux-x64 node-v14.20.0
+@salesforce/cli/1.43.0 linux-x64 node-v14.20.0
 $ sf --help [COMMAND]
 USAGE
   $ sf COMMAND
@@ -58,6 +58,7 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI.
 - [`sf deploy functions`](#sf-deploy-functions)
 - [`sf deploy metadata`](#sf-deploy-metadata)
 - [`sf deploy metadata cancel`](#sf-deploy-metadata-cancel)
+- [`sf deploy metadata preview`](#sf-deploy-metadata-preview)
 - [`sf deploy metadata quick`](#sf-deploy-metadata-quick)
 - [`sf deploy metadata report`](#sf-deploy-metadata-report)
 - [`sf deploy metadata resume`](#sf-deploy-metadata-resume)
@@ -84,6 +85,10 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI.
 - [`sf env var set`](#sf-env-var-set)
 - [`sf env var unset`](#sf-env-var-unset)
 - [`sf generate function`](#sf-generate-function)
+- [`sf generate metadata field`](#sf-generate-metadata-field)
+- [`sf generate metadata platformevent`](#sf-generate-metadata-platformevent)
+- [`sf generate metadata sobject`](#sf-generate-metadata-sobject)
+- [`sf generate metadata tab`](#sf-generate-metadata-tab)
 - [`sf generate project`](#sf-generate-project)
 - [`sf help [COMMAND]`](#sf-help-command)
 - [`sf info:releasenotes:display [-v <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sf-inforeleasenotesdisplay--v-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
@@ -106,6 +111,7 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI.
 - [`sf plugins:uninstall PLUGIN...`](#sf-pluginsuninstall-plugin-2)
 - [`sf plugins update`](#sf-plugins-update)
 - [`sf retrieve metadata`](#sf-retrieve-metadata)
+- [`sf retrieve metadata preview`](#sf-retrieve-metadata-preview)
 - [`sf run function`](#sf-run-function)
 - [`sf run function start`](#sf-run-function-start)
 - [`sf run function start container`](#sf-run-function-start-container)
@@ -346,7 +352,7 @@ EXAMPLES
     $ sf deploy --interactive
 ```
 
-_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/v1.5.2/src/commands/deploy.ts)_
+_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/v1.5.5/src/commands/deploy.ts)_
 
 ## `sf deploy functions`
 
@@ -407,8 +413,7 @@ FLAGS
   -o, --target-org=<value>     Login username or alias for the target org.
   -r, --ignore-errors          Ignore any errors and don’t roll back deployment.
   -t, --tests=<value>...       Apex tests to run when --test-level is RunSpecifiedTests.
-  -w, --wait=<minutes>         [default: [object Object]] Number of minutes to wait for command to complete and display
-                               results.
+  -w, --wait=<minutes>         Number of minutes to wait for command to complete and display results.
   -x, --manifest=<value>       Full file path for manifest (package.xml) of components to deploy.
   --async                      Run the command asynchronously.
   --concise                    Show concise output of the deploy result.
@@ -476,8 +481,8 @@ EXAMPLES
 FLAG DESCRIPTIONS
   -a, --api-version=<value>  Target API version for the deploy.
 
-    Use this flag to override the default API version, which is the latest version supported the CLI, with the API
-    version of your package.xml file.
+    Use this flag to override the default API version with the API version of your package.xml file. The default API
+    version is the latest version supported by the CLI.
 
   -c, --ignore-conflicts  Ignore conflicts and deploy local files, even if they overwrite changes in the org.
 
@@ -632,6 +637,83 @@ FLAG DESCRIPTIONS
     deploy metadata report".
 ```
 
+## `sf deploy metadata preview`
+
+Preview a deployment to see what will deploy to the org, the potential conflicts, and the ignored files.
+
+```
+USAGE
+  $ sf deploy metadata preview [--json] [-c] [-x <value> | -d <value> | -m <value>] [-o <value>]
+
+FLAGS
+  -c, --ignore-conflicts       Ignore conflicts and deploy local files, even if they overwrite changes in the org.
+  -d, --source-dir=<value>...  Path to the local source files to preview.
+  -m, --metadata=<value>...    Metadata component names to preview.
+  -o, --target-org=<value>     Login username or alias for the target org.
+  -x, --manifest=<value>       Full file path for manifest (package.xml) of components to preview.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Preview a deployment to see what will deploy to the org, the potential conflicts, and the ignored files.
+
+  You must run this command from within a project.
+
+  The command outputs a table that describes what will happen if you run the "sf deploy metadata" command. The table
+  lists the metadata components that will be deployed and deleted. The table also lists the current conflicts between
+  files in your local project and components in the org. Finally, the table lists the files that won't be deployed
+  because they're included in your .forceignore file.
+
+  If your org allows source tracking, then this command considers conflicts between the org and local. Some orgs, such
+  as production orgs, never allow source tracking. Use the "--no-track-source" flag when you create a scratch or sandbox
+  org to disable source tracking.
+
+  To preview the deployment of multiple metadata components, either set multiple --metadata <name> flags or a single
+  --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double
+  quotes. The same syntax applies to --manifest and --source-dir.
+
+EXAMPLES
+  NOTE: The commands to preview a deployment and actually deploy it use similar flags. We provide a few preview examples here, but see the help for "sf deploy metadata" for more examples that you can adapt for previewing.
+
+  Preview the deployment of source files in a directory, such as force-app:
+
+    $ sf deploy metadata preview  --source-dir force-app
+
+  Preview the deployment of all Apex classes:
+
+    $ sf deploy metadata preview --metadata ApexClass
+
+  Preview deployment of a specific Apex class:
+
+    $ sf deploy metadata preview --metadata ApexClass:MyApexClass
+
+  Preview deployment of all components listed in a manifest:
+
+    $ sf deploy metadata preview --manifest path/to/package.xml
+
+FLAG DESCRIPTIONS
+  -c, --ignore-conflicts  Ignore conflicts and deploy local files, even if they overwrite changes in the org.
+
+    This flag applies only to orgs that allow source tracking. It has no effect on orgs that don't allow it, such as
+    production orgs.
+
+  -d, --source-dir=<value>...  Path to the local source files to preview.
+
+    The supplied path can be to a single file (in which case the operation is applied to only one file) or to a folder
+    (in which case the operation is applied to all metadata types in the directory and its subdirectories).
+
+    If you specify this flag, don’t specify --metadata or --manifest.
+
+  -o, --target-org=<value>  Login username or alias for the target org.
+
+    Overrides your default org.
+
+  -x, --manifest=<value>  Full file path for manifest (package.xml) of components to preview.
+
+    All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.
+```
+
 ## `sf deploy metadata quick`
 
 Quickly deploy a validated deployment to an org.
@@ -644,8 +726,7 @@ FLAGS
   -i, --job-id=<value>      Job ID of the deployment you want to quick deploy.
   -o, --target-org=<value>  Login username or alias for the target org.
   -r, --use-most-recent     Use the job ID of the most recently validated deployment.
-  -w, --wait=<minutes>      [default: [object Object]] Number of minutes to wait for the command to complete and display
-                            results.
+  -w, --wait=<minutes>      Number of minutes to wait for the command to complete and display results.
   --async                   Run the command asynchronously.
   --concise                 Show concise output of the deploy result.
   --verbose                 Show verbose output of the deploy result.
@@ -855,8 +936,7 @@ FLAGS
   -m, --metadata=<value>...    Metadata component names to validate for deployment.
   -o, --target-org=<value>     Login username or alias for the target org.
   -t, --tests=<value>...       Apex tests to run when --test-level is RunSpecifiedTests.
-  -w, --wait=<minutes>         [default: [object Object]] Number of minutes to wait for the command to complete and
-                               display results.
+  -w, --wait=<minutes>         Number of minutes to wait for the command to complete and display results.
   -x, --manifest=<value>       Full file path for manifest (package.xml) of components to validate for deployment.
   --async                      Run the command asynchronously.
   --concise                    Show concise output of the validation result.
@@ -907,8 +987,8 @@ EXAMPLES
 FLAG DESCRIPTIONS
   -a, --api-version=<value>  Target API version for the validation.
 
-    Use this flag to override the default API version, which is the latest version supported the CLI, with the API
-    version in your package.xml file.
+    Use this flag to override the default API version with the API version of your package.xml file. The default API
+    version is the latest version supported by the CLI.
 
   -d, --source-dir=<value>...  Path to the local source files to validate for deployment.
 
@@ -1835,6 +1915,167 @@ EXAMPLES
     $ sf generate function --function-name myfunction --language javascript
 ```
 
+## `sf generate metadata field`
+
+Generate metadata source files for a new custom field on a specified object.
+
+```
+USAGE
+  $ sf generate metadata field -l <value> [-o <value>]
+
+FLAGS
+  -l, --label=<value>   (required) The field's label.
+  -o, --object=<value>  The directory that contains the object's source files.
+
+DESCRIPTION
+  Generate metadata source files for a new custom field on a specified object.
+
+  This command is interactive and must be run in a Salesforce DX project directory. You're required to specify the
+  field's label with the "--label" flag. The command uses this label to provide intelligent suggestions for other field
+  properties, such as its API name.
+
+  You can generate a custom field on either a standard object, such as Account, or a custom object. In both cases, the
+  source files for the object must already exist in your local project before you run this command. If you create a
+  relationship field, the source files for the parent object must also exist in your local directory.  Use the command
+  "sf metadata retrieve -m CustomObject:<object>" to retrieve source files for both standard and custom objects from
+  your org.  To create a custom object, run the "sf generate metadata sobject" command or use the Object Manager UI in
+  your Salesforce org.
+
+EXAMPLES
+  Create a field with the specified label; the command prompts you for the object:
+
+    $ sf generate metadata field --label "My Field"
+
+  Specify the local path to the object's folder:
+
+    $ sf generate metadata field --label "My Field" --object force-app/main/default/objects/MyObject__c
+
+FLAG DESCRIPTIONS
+  -o, --object=<value>  The directory that contains the object's source files.
+
+    The object source files in your local project are grouped in a directoy with the same name as the object. Custom
+    object names always end in "__c". An example of the object directory for the Account standard object is
+    "force-app/main/default/objects/Account" An example custom object directory is
+    "force-app/main/default/objects/MyObject__c"
+
+    If you don't specify this flag, the command prompts you to choose from your local objects.
+```
+
+## `sf generate metadata platformevent`
+
+Generate metadata source files for a new platform event.
+
+```
+USAGE
+  $ sf generate metadata platformevent -l <value>
+
+FLAGS
+  -l, --label=<value>  (required) The platform event's label.
+
+DESCRIPTION
+  Generate metadata source files for a new platform event.
+
+  This command is interactive and must be run in a Salesforce DX project directory. You're required to specify the
+  event's label with the "--label" flag. The command uses this label to provide intelligent suggestions for other event
+  properties, such as its API name.
+
+EXAMPLES
+  Create a platform event with the specified label:
+
+    $ sf generate metadata platformevent --label "My Platform Event"
+```
+
+## `sf generate metadata sobject`
+
+Generate metadata source files for a new custom object.
+
+```
+USAGE
+  $ sf generate metadata sobject -l <value> [-f]
+
+FLAGS
+  -f, --use-default-features  Enable all optional features without prompting.
+  -l, --label=<value>         (required) The custom object's label.
+
+DESCRIPTION
+  Generate metadata source files for a new custom object.
+
+  This command is interactive and must be run in a Salesforce DX project directory. You're required to specify the
+  object's label with the "--label" flag. The command uses this label to provide intelligent suggestions for other
+  object properties, such as its API name and plural label.
+
+  All Salesforce objects are required to have a Name field, so this command also prompts you for the label and type of
+  the Name field. Run the "sf metadata generate field" command to create additional fields for the object.
+
+  To reduce the number of prompts, use the "--use-default-features" flag to automatically enable some features, such as
+  reporting and search on the object.
+
+EXAMPLES
+  Create a custom object with the specified label and be prompted for additional information:
+
+    $ sf generate metadata sobject --label "My Object"
+
+  Create a custom object and enable optional features without prompting:
+
+    $ sf generate metadata sobject --label "My Object" --use-default-features
+
+FLAG DESCRIPTIONS
+  -f, --use-default-features  Enable all optional features without prompting.
+
+    Enables these features:
+
+    * Search: Allows users to find the custom object's records when they search, including SOSL.
+    * Feeds: Enables feed tracking.
+    * Reports: Allows reporting of the data in the custom object records.
+    * History: Enables object history tracking.
+    * Activities: Allows users to associate tasks and scheduled calendar events related to the custom object records.
+    * Bulk API: With Sharing and Streaming API, classifies the custom object as an Enterprise Application object.
+    * Sharing: With Bulk API and Streaming API, classifies the custom object as an Enterprise Application object.
+    * Streaming API: With Bulk API and Sharing, classifies the custom object as an Enterprise Application object.
+```
+
+## `sf generate metadata tab`
+
+Generate the metadata source files for a new custom tab on a custom object.
+
+```
+USAGE
+  $ sf generate metadata tab -o <value> -d <value> -i <value> [--json]
+
+FLAGS
+  -d, --directory=<value>  (required) Path to a "tabs" directory that will contain the source files for your new tab.
+  -i, --icon=<value>       (required) [default: 1] Number from 1 to 100 that specifies the color scheme and icon for the
+                           custom tab.
+  -o, --object=<value>     (required) API name of the custom object you're generating a tab for.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Generate the metadata source files for a new custom tab on a custom object.
+
+  Custom tabs let you display custom object data or other web content in Salesforce. Custom tabs appear in Salesforce as
+  an item in the app’s navigation bar and in the App Launcher.
+
+  This command must be run in a Salesforce DX project directory. You must pass all required information to it with the
+  required flags. The source files for the custom object for which you're generating a tab don't need to exist in your
+  local project.
+
+EXAMPLES
+  Create a tab on the MyObject__c custom object:
+
+    $ sf generate metadata tab --object MyObject__c --icon 54 --directory force-app/main/default/tabs
+
+FLAG DESCRIPTIONS
+  -i, --icon=<value>  Number from 1 to 100 that specifies the color scheme and icon for the custom tab.
+
+    See https://lightningdesignsystem.com/icons/\#custom for the available icons.
+
+  -o, --object=<value>  API name of the custom object you're generating a tab for.
+
+    The API name for a custom object always ends in "__c", such as "MyObject__c".
+```
+
 ## `sf generate project`
 
 Generate a Salesforce DX project.
@@ -2617,8 +2858,8 @@ FLAGS
   -m, --metadata=<value>...      Metadata component names to retrieve.
   -n, --package-name=<value>...  Package names to retrieve.
   -o, --target-org=<value>       Login username or alias for the target org.
-  -w, --wait=<value>             [default: [object Object]] Number of minutes to wait for the command to complete and
-                                 display results to the terminal window.
+  -w, --wait=<value>             Number of minutes to wait for the command to complete and display results to the
+                                 terminal window.
   -x, --manifest=<value>         File path for the manifest (package.xml) that specifies the components to retrieve.
 
 GLOBAL FLAGS
@@ -2716,6 +2957,58 @@ ENVIRONMENT VARIABLES
   SF_USE_PROGRESS_BAR  Set to false to disable the progress bar when running the metadata deploy command.
 ```
 
+## `sf retrieve metadata preview`
+
+Preview a retrieval to see what will be retrieved from the org, the potential conflicts, and the ignored files.
+
+```
+USAGE
+  $ sf retrieve metadata preview [--json] [-c] [-o <value>]
+
+FLAGS
+  -c, --ignore-conflicts    Ignore conflicts and preview the retrieve of remote components, even if they will overwrite
+                            local changes.
+  -o, --target-org=<value>  Login username or alias for the target org.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Preview a retrieval to see what will be retrieved from the org, the potential conflicts, and the ignored files.
+
+  You must run this command from within a project.
+
+  The command outputs a table that describes what will happen if you run the "sf retrieve metadata" command. The table
+  lists the metadata components that will be retrieved and deleted. The table also lists the current conflicts between
+  files in your local project and components in the org. Finally, the table lists the files that won't be retrieved
+  because they're included in your .forceignore file.
+
+  If your org allows source tracking, then this command considers conflicts between the org and local. Some orgs, such
+  as production orgs, never allow source tracking. Use the "--no-track-source" flag when you create a scratch or sandbox
+  org to disable source tracking.
+
+EXAMPLES
+  Preview the retrieve of all changes from the org:
+
+    $ sf retrieve metadata preview
+
+  Preview the retrieve when ignoring any conflicts:
+
+    $ sf retrieve metadata preview --ignore-conflicts
+
+FLAG DESCRIPTIONS
+  -c, --ignore-conflicts
+
+    Ignore conflicts and preview the retrieve of remote components, even if they will overwrite local changes.
+
+    This flag applies only to orgs that allow source tracking. It has no effect on orgs that don't allow it, such as
+    production orgs.
+
+  -o, --target-org=<value>  Login username or alias for the target org.
+
+    Overrides your default org.
+```
+
 ## `sf run function`
 
 Send a cloudevent to a function.