You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
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
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).
50
6
@@ -153,13 +109,11 @@ EXAMPLES
153
109
FLAG DESCRIPTIONS
154
110
-e, --extended-definition-file=<value> Path to a JSON file containing a complete custom dataset definition.
155
111
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.
158
113
159
114
-i, --definition-identifier=<value> The definition identifier for the standard dataset.
160
115
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.
163
117
164
118
-o, --target-org=<value> The target org alias or username to deploy data to.
165
119
@@ -175,12 +129,10 @@ FLAG DESCRIPTIONS
175
129
176
130
-x, --filter-value=<value> Comma-separated list of filter values for the export.
177
131
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').
180
133
181
134
--api-version=<value> API version to use for the connection.
182
135
183
136
The Salesforce API version to use when connecting to the orgs. If not specified, uses the org's default API version.
0 commit comments