Skip to content

Commit 7f86e3e

Browse files
committed
@W-22517579 update READMI.md
1 parent 12285cd commit 7f86e3e

1 file changed

Lines changed: 4 additions & 52 deletions

File tree

README.md

Lines changed: 4 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,6 @@
11
# plugin-data-setup-transfer
22

3-
[![NPM](https://img.shields.io/npm/v/plugin-data-setup-transfer.svg?label=plugin-data-setup-transfer)](https://www.npmjs.com/package/plugin-data-setup-transfer) [![Downloads/week](https://img.shields.io/npm/dw/plugin-data-setup-transfer.svg)](https://npmjs.org/package/plugin-data-setup-transfer) [![License](https://img.shields.io/badge/License-BSD%203--Clause-brightgreen.svg)](https://raw.githubusercontent.com/salesforcecli/plugin-data-setup-transfer/main/LICENSE.txt)
4-
5-
## Using the template
6-
7-
This repository provides a template for creating a plugin for the Salesforce CLI. To convert this template to a working plugin:
8-
9-
1. Please get in touch with the Platform CLI team. We want to help you develop your plugin.
10-
2. Generate your plugin:
11-
12-
```
13-
sf plugins install dev
14-
sf dev generate plugin
15-
16-
git init -b main
17-
git add . && git commit -m "chore: initial commit"
18-
```
19-
20-
3. Create your plugin's repo in the salesforcecli github org
21-
4. When you're ready, replace the contents of this README with the information you want.
22-
23-
## Learn about `sf` plugins
24-
25-
Salesforce CLI plugins are based on the [oclif plugin framework](<(https://oclif.io/docs/introduction.html)>). Read the [plugin developer guide](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_plugins.meta/sfdx_cli_plugins/cli_plugins_architecture_sf_cli.htm) to learn about Salesforce CLI plugin development.
26-
27-
This repository contains a lot of additional scripts and tools to help with general Salesforce node development and enforce coding standards. You should familiarize yourself with some of the [node developer packages](#tooling) used by Salesforce.
28-
29-
Additionally, there are some additional tests that the Salesforce CLI will enforce if this plugin is ever bundled with the CLI. These test are included by default under the `posttest` script and it is required to keep these tests active in your plugin if you plan to have it bundled.
30-
31-
### Tooling
32-
33-
- [@salesforce/core](https://github.com/forcedotcom/sfdx-core)
34-
- [@salesforce/kit](https://github.com/forcedotcom/kit)
35-
- [@salesforce/sf-plugins-core](https://github.com/salesforcecli/sf-plugins-core)
36-
- [@salesforce/ts-types](https://github.com/forcedotcom/ts-types)
37-
- [@salesforce/ts-sinon](https://github.com/forcedotcom/ts-sinon)
38-
- [@salesforce/dev-config](https://github.com/forcedotcom/dev-config)
39-
- [@salesforce/dev-scripts](https://github.com/forcedotcom/dev-scripts)
40-
41-
### Hooks
42-
43-
For cross clouds commands, e.g. `sf env list`, we utilize [oclif hooks](https://oclif.io/docs/hooks) to get the relevant information from installed plugins.
44-
45-
This plugin includes sample hooks in the [src/hooks directory](src/hooks). You'll just need to add the appropriate logic. You can also delete any of the hooks if they aren't required for your plugin.
46-
47-
# Everything past here is only a suggestion as to what should be in your specific plugin's description
3+
[NPM](https://www.npmjs.com/package/plugin-data-setup-transfer) [Downloads/week](https://npmjs.org/package/plugin-data-setup-transfer) [License](https://raw.githubusercontent.com/salesforcecli/plugin-data-setup-transfer/main/LICENSE.txt)
484

495
This plugin is bundled with the [Salesforce CLI](https://developer.salesforce.com/tools/sfdxcli). For more information on the CLI, read the [getting started guide](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_setup_intro.htm).
506

@@ -153,13 +109,11 @@ EXAMPLES
153109
FLAG DESCRIPTIONS
154110
-e, --extended-definition-file=<value> Path to a JSON file containing a complete custom dataset definition.
155111
156-
Path to a JSON file containing a fully custom dataset definition. The file contents are used as the export API payload and the
157-
definition headers are merged into the retrieved data before deploying to the target org.
112+
Path to a JSON file containing a fully custom dataset definition.
158113
159114
-i, --definition-identifier=<value> The definition identifier for the standard dataset.
160115
161-
The unique identifier of the standard setup dataset definition (e.g., 'dipcmlargedefinition'). This value is sent as `dataSetName` in
162-
the export API payload. Required when not using --extended-definition-file.
116+
The unique identifier of the standard setup dataset definition (e.g., 'dipcmlargedefinition'). Required when not using --extended-definition-file.
163117
164118
-o, --target-org=<value> The target org alias or username to deploy data to.
165119
@@ -175,12 +129,10 @@ FLAG DESCRIPTIONS
175129
176130
-x, --filter-value=<value> Comma-separated list of filter values for the export.
177131
178-
Optional comma-separated list of filter values to include in the export (e.g., 'autoSilver, autoRoot'). This value is sent as
179-
`filterValue` in the export API payload.
132+
Optional comma-separated list of filter values to include in the export (e.g., 'autoSilver, autoRoot').
180133
181134
--api-version=<value> API version to use for the connection.
182135
183136
The Salesforce API version to use when connecting to the orgs. If not specified, uses the org's default API version.
184137
```
185138

186-
<!-- commandsstop -->

0 commit comments

Comments
 (0)