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
# This plugin is under heavy development and does NOT currently have feature parity
4
4
5
-
<REPLACE ME DESCRIPTION START>
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. Clone this repo
10
-
2. Delete the .git folder
11
-
3. Replace filler values
12
-
a) Every instance of `<REPLACE_ME>` can be directly substitued for the name of the new plugin. However beware, things like github paths are for the salesforcecli Github organization
13
-
b) Search for case-matching `REPLACE` to find other filler values, such as for the plugin description
14
-
4. Use `git init` to set up the desired git information
15
-
5. Follow the getting started steps below until the `sfdx hello:org` commmand is functioning
16
-
17
-
<REPLACE ME DESCRIPTION END>
18
-
19
-
## Learn about the plugin-template
20
-
21
-
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.
22
-
23
-
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](https://github.com/forcedotcom/sfdx-dev-packages/) used by Salesforce. There is also a default circleci config using the [release management orb](https://github.com/forcedotcom/npm-release-management-orb) standards.
24
-
25
-
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 recommended to keep these tests active in your plugin, regardless if you plan to have it bundled.
26
-
27
-
# Everything past here is only a suggestion as to what should be in your specific plugin's description
5
+
Source commands for Salesforce CLI
28
6
29
7
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).
30
8
@@ -33,7 +11,7 @@ We always recommend using the latest version of these commands bundled with the
33
11
## Install
34
12
35
13
```bash
36
-
sfdx plugins:install <REPLACE_ME>@x.y.z
14
+
sfdx plugins:install source@x.y.z
37
15
```
38
16
39
17
## Issues
@@ -65,7 +43,7 @@ To build the plugin locally, make sure to have yarn installed and run the follow
@@ -76,7 +54,7 @@ To use your plugin, run using the local `./bin/run` or `./bin/run.cmd` file.
76
54
77
55
```bash
78
56
# Run using local run file.
79
-
./bin/run <REPLACE_ME>
57
+
./bin/run source:
80
58
```
81
59
82
60
There should be no differences when running via the Salesforce CLI or using the local run file. However, it can be useful to link the plugin to do some additional testing or run your commands from anywhere on your machine.
0 commit comments