Skip to content

Commit e6b6271

Browse files
authored
chore: W-23006506 Update README.md (#19)
1 parent 9915c53 commit e6b6271

1 file changed

Lines changed: 9 additions & 76 deletions

File tree

README.md

Lines changed: 9 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ We always recommend using the latest version of these commands bundled with the
1010
## Install
1111

1212
```bash
13-
sf plugins install plugin-data-setup-transfer@x.y.z
13+
sf plugins install @salesforce/plugin-data-setup-transfer (latest version)
14+
sf plugins install @salesforce/plugin-data-setup-transfer@x.y.z (specific version)
1415
```
1516

1617
## Issues
@@ -25,7 +26,7 @@ Please report any issues at https://github.com/forcedotcom/cli/issues
2526
let you know if there is already an effort in progress.
2627
3. Fork this repository.
2728
4. [Build the plugin locally](#build)
28-
5. Create a _topic_ branch in your fork. Note, this step is recommended but technically not required if contributing using a fork.
29+
5. Create a *topic* branch in your fork. Note, this step is recommended but technically not required if contributing using a fork.
2930
6. Edit the code in your fork.
3031
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.
3132
8. Sign CLA (see [CLA](#cla) below).
@@ -66,9 +67,6 @@ sf plugins
6667

6768
## Commands
6869

69-
<!-- commands -->
70-
* [`sf data setup transfer`](#sf-data-setup-transfer)
71-
7270
## `sf data setup transfer`
7371

7472
Retrieve setup data from one org and deploy it to another in a single step.
@@ -135,80 +133,15 @@ FLAG DESCRIPTIONS
135133
136134
-x, --filter-value=<value> Comma-separated list of filter values for the export.
137135
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.
136+
Comma-separated list of filter values to include in the export (e.g., 'autoSilver, autoRoot').
137+
This value is sent as `filterValue` in the export API payload.
138+
The {SET_FILTER} placeholder is a special token in the filter criteria in the dataset definition.
139+
Behavior:
140+
Without {SET_FILTER}: This flag is optional
141+
With {SET_FILTER}: This flag becomes required
140142
141143
--api-version=<value> API version to use for the connection.
142144
143145
The Salesforce API version to use when connecting to the orgs. If not specified, uses the org's default API version.
144146
```
145-
<!-- commandsstop -->
146-
147-
- [`sf data setup transfer`](#sf-data-setup-transfer)
148-
149-
## `sf data setup transfer`
150-
151-
Retrieve setup data from one org and deploy it to another in a single step.
152-
153-
```
154-
USAGE
155-
$ sf data setup transfer -s <value> -o <value> [--json] [--flags-dir <value>] [-i <value>] [-v <value>] [-e
156-
<value>] [-x <value>] [--api-version <value>]
157-
158-
FLAGS
159-
-e, --extended-definition-file=<value> Path to a JSON file containing a complete custom dataset definition.
160-
-i, --definition-identifier=<value> The definition identifier for the standard dataset.
161-
-o, --target-org=<value> (required) The target org alias or username to deploy data to.
162-
-s, --source-org=<value> (required) The source org alias or username to retrieve data
163-
from.
164-
-v, --version=<value> The version of the standard dataset.
165-
-x, --filter-value=<value> Comma-separated list of filter values for the export.
166-
--api-version=<value> API version to use for the connection.
167-
168-
GLOBAL FLAGS
169-
--flags-dir=<value> Import flag values from a directory.
170-
--json Format output as json.
171-
172-
DESCRIPTION
173-
Retrieve setup data from one org and deploy it to another in a single step.
174-
175-
Combines retrieve and deploy into one command: exports setup data from a source org using the Connect API, then imports it into a target
176-
org. Supports two modes: (1) Standard dataset definition — provide a definition identifier and version. (2) Custom dataset definition —
177-
provide a complete custom definition file via --extended-definition-file.
178-
179-
EXAMPLES
180-
Retrieve and deploy using a standard dataset definition:
181-
$ sf data setup transfer --definition-identifier dipcmlargedefinition --version 1.0.0 --source-org sourceOrg --filter-value 'autoSilver' --target-org targetOrg
182147

183-
Retrieve and deploy using a custom dataset definition file:
184-
$ sf data setup transfer --extended-definition-file definition/dipcmlargedefinition-extension.json --source-org sourceOrg --filter-value 'autoSilver' --target-org targetOrg
185-
186-
FLAG DESCRIPTIONS
187-
-e, --extended-definition-file=<value> Path to a JSON file containing a complete custom dataset definition.
188-
189-
Path to a JSON file containing a fully custom dataset definition.
190-
191-
-i, --definition-identifier=<value> The definition identifier for the standard dataset.
192-
193-
The unique identifier of the standard setup dataset definition (e.g., 'dipcmlargedefinition'). Required when not using --extended-definition-file.
194-
195-
-o, --target-org=<value> The target org alias or username to deploy data to.
196-
197-
The Salesforce org where the setup data will be deployed. Can be an org alias or username.
198-
199-
-s, --source-org=<value> The source org alias or username to retrieve data from.
200-
201-
The Salesforce org from which to retrieve the setup data. Can be an org alias or username.
202-
203-
-v, --version=<value> The version of the standard dataset.
204-
205-
The version string for the standard dataset definition (e.g., '1.0.0'). Required when not using --extended-definition-file.
206-
207-
-x, --filter-value=<value> Comma-separated list of filter values for the export.
208-
209-
Optional comma-separated list of filter values to include in the export (e.g., 'autoSilver, autoRoot').
210-
211-
--api-version=<value> API version to use for the connection.
212-
213-
The Salesforce API version to use when connecting to the orgs. If not specified, uses the org's default API version.
214-
```

0 commit comments

Comments
 (0)