-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
3 additions
and
49 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,61 +1,15 @@ | ||
| **NOTE: This template for sf plugins is not yet official. Please consult with the Platform CLI team before using this template.** | ||
| # plugin-agent - BETA | ||
|
|
||
| # plugin-agent | ||
| ### THIS PLUGIN IS A BETA VERSION AND IS NOT MEANT FOR PRODUCTION USAGE UNTIL ANNOUNCED. | ||
|
|
||
| [](https://www.npmjs.com/package/@salesforce/plugin-agent) [](https://npmjs.org/package/@salesforce/plugin-agent) [](https://raw.githubusercontent.com/salesforcecli/plugin-agent/main/LICENSE.txt) | ||
|
|
||
| ## Using the template | ||
|
|
||
| This repository provides a template for creating a plugin for the Salesforce CLI. To convert this template to a working plugin: | ||
|
|
||
| 1. Please get in touch with the Platform CLI team. We want to help you develop your plugin. | ||
| 2. Generate your plugin: | ||
|
|
||
| ``` | ||
| sf plugins install dev | ||
| sf dev generate plugin | ||
| git init -b main | ||
| git add . && git commit -m "chore: initial commit" | ||
| ``` | ||
|
|
||
| 3. Create your plugin's repo in the salesforcecli github org | ||
| 4. When you're ready, replace the contents of this README with the information you want. | ||
|
|
||
| ## Learn about `sf` plugins | ||
|
|
||
| Salesforce CLI plugins are based on the [oclif plugin framework](https://oclif.io/docs/introduction). 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. | ||
|
|
||
| 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. There is also a default circleci config using the [release management orb](https://github.com/forcedotcom/npm-release-management-orb) standards. | ||
|
|
||
| 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. | ||
|
|
||
| ### Tooling | ||
|
|
||
| - [@salesforce/core](https://github.com/forcedotcom/sfdx-core) | ||
| - [@salesforce/kit](https://github.com/forcedotcom/kit) | ||
| - [@salesforce/sf-plugins-core](https://github.com/salesforcecli/sf-plugins-core) | ||
| - [@salesforce/ts-types](https://github.com/forcedotcom/ts-types) | ||
| - [@salesforce/ts-sinon](https://github.com/forcedotcom/ts-sinon) | ||
| - [@salesforce/dev-config](https://github.com/forcedotcom/dev-config) | ||
| - [@salesforce/dev-scripts](https://github.com/forcedotcom/dev-scripts) | ||
|
|
||
| # 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). | ||
|
|
||
| We always recommend using the latest version of these commands bundled with the CLI, however, you can install a specific version or tag if needed. | ||
|
|
||
| ## Install | ||
|
|
||
| ```bash | ||
| sf plugins install @salesforce/[email protected] | ||
| ``` | ||
|
|
||
| ## Issues | ||
|
|
||
| Please report any issues at https://github.com/forcedotcom/cli/issues | ||
|
|
||
| ## Contributing | ||
|
|
||
| 1. Please read our [Code of Conduct](CODE_OF_CONDUCT.md) | ||
|
|
@@ -91,7 +45,7 @@ To use your plugin, run using the local `./bin/dev` or `./bin/dev.cmd` file. | |
|
|
||
| ```bash | ||
| # Run using local run file. | ||
| ./bin/dev hello world | ||
| ./bin/dev agent | ||
| ``` | ||
|
|
||
| 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. | ||
|
|
||