@@ -67,6 +67,82 @@ sf plugins
6767## Commands
6868
6969<!-- commands -->
70+ * [ ` sf data setup transfer ` ] ( #sf-data-setup-transfer )
71+
72+ ## ` sf data setup transfer `
73+
74+ Retrieve setup data from one org and deploy it to another in a single step.
75+
76+ ```
77+ USAGE
78+ $ sf data setup transfer -s <value> -o <value> [--json] [--flags-dir <value>] [-i <value>] [-v <value>] [-e <value>]
79+ [-x <value>] [--api-version <value>]
80+
81+ FLAGS
82+ -e, --extended-definition-file=<value> Path to a JSON file containing a complete custom dataset definition.
83+ -i, --definition-identifier=<value> The definition identifier for the standard dataset.
84+ -o, --target-org=<value> (required) The target org alias or username to deploy data to.
85+ -s, --source-org=<value> (required) The source org alias or username to retrieve data from.
86+ -v, --version=<value> The version of the standard dataset.
87+ -x, --filter-value=<value> Comma-separated list of filter values for the export.
88+ --api-version=<value> API version to use for the connection.
89+
90+ GLOBAL FLAGS
91+ --flags-dir=<value> Import flag values from a directory.
92+ --json Format output as json.
93+
94+ DESCRIPTION
95+ Retrieve setup data from one org and deploy it to another in a single step.
96+
97+ Combines retrieve and deploy into one command: exports setup data from a source org using the Connect API, then
98+ imports it into a target org. Supports two modes: (1) Standard dataset definition — provide a definition identifier
99+ and version. (2) Custom dataset definition — provide a complete custom definition file via --extended-definition-file.
100+
101+ EXAMPLES
102+ Retrieve and deploy using a standard dataset definition:
103+
104+ $ sf data setup transfer --definition-identifier dipcmlargedefinition --version 1.0.0 --source-org sourceOrg \
105+ --filter-value 'autoSilver' --target-org targetOrg
106+
107+ Retrieve and deploy using a custom dataset definition file:
108+
109+ $ sf data setup transfer --extended-definition-file definition/dipcmlargedefinition-extension.json --source-org \
110+ sourceOrg --filter-value 'autoSilver' --target-org targetOrg
111+
112+ FLAG DESCRIPTIONS
113+ -e, --extended-definition-file=<value> Path to a JSON file containing a complete custom dataset definition.
114+
115+ Path to a JSON file containing a fully custom dataset definition. The file contents are used as the export API
116+ payload and the definition headers are merged into the retrieved data before deploying to the target org.
117+
118+ -i, --definition-identifier=<value> The definition identifier for the standard dataset.
119+
120+ The unique identifier of the standard setup dataset definition (e.g., 'dipcmlargedefinition'). This value is sent as
121+ `dataSetName` in the export API payload. Required when not using --extended-definition-file.
122+
123+ -o, --target-org=<value> The target org alias or username to deploy data to.
124+
125+ The Salesforce org where the setup data will be deployed. Can be an org alias or username.
126+
127+ -s, --source-org=<value> The source org alias or username to retrieve data from.
128+
129+ The Salesforce org from which to retrieve the setup data. Can be an org alias or username.
130+
131+ -v, --version=<value> The version of the standard dataset.
132+
133+ The version string for the standard dataset definition (e.g., '1.0.0'). Required when not using
134+ --extended-definition-file.
135+
136+ -x, --filter-value=<value> Comma-separated list of filter values for the export.
137+
138+ Optional comma-separated list of filter values to include in the export (e.g., 'autoSilver, autoRoot'). This value
139+ is sent as `filterValue` in the export API payload.
140+
141+ --api-version=<value> API version to use for the connection.
142+
143+ The Salesforce API version to use when connecting to the orgs. If not specified, uses the org's default API version.
144+ ```
145+ <!-- commandsstop -->
70146
71147- [ ` sf data setup transfer ` ] ( #sf-data-setup-transfer )
72148
@@ -136,4 +212,3 @@ FLAG DESCRIPTIONS
136212
137213 The Salesforce API version to use when connecting to the orgs. If not specified, uses the org's default API version.
138214```
139-
0 commit comments