From a186b79d3bf008aedf1fd19ee30b7e5a9eaa8e6d Mon Sep 17 00:00:00 2001 From: John Chen Date: Thu, 18 Jun 2026 18:21:30 -0700 Subject: [PATCH] chore: W-23006506 Update README.md --- README.md | 85 ++++++------------------------------------------------- 1 file changed, 9 insertions(+), 76 deletions(-) diff --git a/README.md b/README.md index 9e0db9a..3f8195a 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,8 @@ We always recommend using the latest version of these commands bundled with the ## Install ```bash -sf plugins install plugin-data-setup-transfer@x.y.z +sf plugins install @salesforce/plugin-data-setup-transfer (latest version) +sf plugins install @salesforce/plugin-data-setup-transfer@x.y.z (specific version) ``` ## Issues @@ -25,7 +26,7 @@ Please report any issues at https://github.com/forcedotcom/cli/issues let you know if there is already an effort in progress. 3. Fork this repository. 4. [Build the plugin locally](#build) -5. Create a _topic_ branch in your fork. Note, this step is recommended but technically not required if contributing using a fork. +5. Create a *topic* branch in your fork. Note, this step is recommended but technically not required if contributing using a fork. 6. Edit the code in your fork. 7. Write appropriate tests for your changes. Try to achieve at least 95% code coverage on any new code. No pull request will be accepted without unit tests. 8. Sign CLA (see [CLA](#cla) below). @@ -66,9 +67,6 @@ sf plugins ## Commands - -* [`sf data setup transfer`](#sf-data-setup-transfer) - ## `sf data setup transfer` Retrieve setup data from one org and deploy it to another in a single step. @@ -135,80 +133,15 @@ FLAG DESCRIPTIONS -x, --filter-value= Comma-separated list of filter values for the export. - Optional comma-separated list of filter values to include in the export (e.g., 'autoSilver, autoRoot'). This value - is sent as `filterValue` in the export API payload. + Comma-separated list of filter values to include in the export (e.g., 'autoSilver, autoRoot'). + This value is sent as `filterValue` in the export API payload. + The {SET_FILTER} placeholder is a special token in the filter criteria in the dataset definition. + Behavior: + Without {SET_FILTER}: This flag is optional + With {SET_FILTER}: This flag becomes required --api-version= API version to use for the connection. The Salesforce API version to use when connecting to the orgs. If not specified, uses the org's default API version. ``` - - -- [`sf data setup transfer`](#sf-data-setup-transfer) - -## `sf data setup transfer` - -Retrieve setup data from one org and deploy it to another in a single step. - -``` -USAGE - $ sf data setup transfer -s -o [--json] [--flags-dir ] [-i ] [-v ] [-e - ] [-x ] [--api-version ] - -FLAGS - -e, --extended-definition-file= Path to a JSON file containing a complete custom dataset definition. - -i, --definition-identifier= The definition identifier for the standard dataset. - -o, --target-org= (required) The target org alias or username to deploy data to. - -s, --source-org= (required) The source org alias or username to retrieve data - from. - -v, --version= The version of the standard dataset. - -x, --filter-value= Comma-separated list of filter values for the export. - --api-version= API version to use for the connection. - -GLOBAL FLAGS - --flags-dir= Import flag values from a directory. - --json Format output as json. - -DESCRIPTION - Retrieve setup data from one org and deploy it to another in a single step. - - Combines retrieve and deploy into one command: exports setup data from a source org using the Connect API, then imports it into a target - org. Supports two modes: (1) Standard dataset definition — provide a definition identifier and version. (2) Custom dataset definition — - provide a complete custom definition file via --extended-definition-file. - -EXAMPLES - Retrieve and deploy using a standard dataset definition: - $ sf data setup transfer --definition-identifier dipcmlargedefinition --version 1.0.0 --source-org sourceOrg --filter-value 'autoSilver' --target-org targetOrg - Retrieve and deploy using a custom dataset definition file: - $ sf data setup transfer --extended-definition-file definition/dipcmlargedefinition-extension.json --source-org sourceOrg --filter-value 'autoSilver' --target-org targetOrg - -FLAG DESCRIPTIONS - -e, --extended-definition-file= Path to a JSON file containing a complete custom dataset definition. - - Path to a JSON file containing a fully custom dataset definition. - - -i, --definition-identifier= The definition identifier for the standard dataset. - - The unique identifier of the standard setup dataset definition (e.g., 'dipcmlargedefinition'). Required when not using --extended-definition-file. - - -o, --target-org= The target org alias or username to deploy data to. - - The Salesforce org where the setup data will be deployed. Can be an org alias or username. - - -s, --source-org= The source org alias or username to retrieve data from. - - The Salesforce org from which to retrieve the setup data. Can be an org alias or username. - - -v, --version= The version of the standard dataset. - - The version string for the standard dataset definition (e.g., '1.0.0'). Required when not using --extended-definition-file. - - -x, --filter-value= Comma-separated list of filter values for the export. - - Optional comma-separated list of filter values to include in the export (e.g., 'autoSilver, autoRoot'). - - --api-version= API version to use for the connection. - - The Salesforce API version to use when connecting to the orgs. If not specified, uses the org's default API version. -```