https://github.com/salesforcecli/plugin-template-sf
https://github.com/salesforcecli/plugin-template-sf
Last synced: 27 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/salesforcecli/plugin-template-sf
- Owner: salesforcecli
- License: apache-2.0
- Created: 2021-09-15T21:41:19.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2026-03-29T11:52:45.000Z (3 months ago)
- Last Synced: 2026-04-03T01:43:02.861Z (3 months ago)
- Language: TypeScript
- Size: 5.53 MB
- Stars: 2
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
**NOTE: This template for sf plugins is not yet official. Please consult with the Platform CLI team before using this template.**
# plugin-template-sf
[](https://www.npmjs.com/package/@salesforce/plugin-template-sf) [](https://npmjs.org/package/@salesforce/plugin-template-sf) [](https://opensource.org/license/apache-2-0)
## 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/plugin-template-sf@x.y.z
```
## Issues
Please report any issues at https://github.com/forcedotcom/cli/issues
## Contributing
1. Please read our [Code of Conduct](CODE_OF_CONDUCT.md)
2. Create a new issue before starting your project so that we can keep track of
what you are trying to add/fix. That way, we can also offer suggestions or
let you know if there is already an effort in progress.
3. Fork this repository.
4. [Build the plugin locally](#build)
5. Create a _topic_ branch in your fork. Note, this step is recommended but technically not required if contributing using a fork.
6. Edit the code in your fork.
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.
8. Sign CLA (see [CLA](#cla) below).
9. Send us a pull request when you are done. We'll review your code, suggest any needed changes, and merge it in.
### CLA
External contributors will be required to sign a Contributor's License
Agreement. You can do so by going to https://cla.salesforce.com/sign-cla.
### Build
To build the plugin locally, make sure to have yarn installed and run the following commands:
```bash
# Clone the repository
git clone git@github.com:salesforcecli/plugin-template-sf
# Install the dependencies and compile
yarn && yarn build
```
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
```
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.
```bash
# Link your plugin to the sf cli
sf plugins link .
# To verify
sf plugins
```
## Commands
- [`sf hello world`](#sf-hello-world)
## `sf hello world`
Say hello.
```
USAGE
$ sf hello world [--json] [--flags-dir ] [-n ]
FLAGS
-n, --name= [default: World] The name of the person you'd like to say hello to.
GLOBAL FLAGS
--flags-dir= Import flag values from a directory.
--json Format output as json.
DESCRIPTION
Say hello.
Say hello either to the world or someone you know.
EXAMPLES
Say hello to the world:
$ sf hello world
Say hello to someone you know:
$ sf hello world --name Astro
FLAG DESCRIPTIONS
-n, --name= The name of the person you'd like to say hello to.
This person can be anyone in the world!
```
_See code: [src/commands/hello/world.ts](https://github.com/salesforcecli/plugin-template-sf/blob/1.1.94/src/commands/hello/world.ts)_