{"id":46566928,"url":"https://github.com/salesforcecli/plugin-template-sf","last_synced_at":"2026-05-24T08:06:04.534Z","repository":{"id":57683648,"uuid":"406932083","full_name":"salesforcecli/plugin-template-sf","owner":"salesforcecli","description":null,"archived":false,"fork":false,"pushed_at":"2026-03-29T11:52:45.000Z","size":5802,"stargazers_count":2,"open_issues_count":0,"forks_count":2,"subscribers_count":4,"default_branch":"main","last_synced_at":"2026-04-03T01:43:02.861Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/salesforcecli.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-09-15T21:41:19.000Z","updated_at":"2026-03-29T11:52:48.000Z","dependencies_parsed_at":"2022-09-05T17:31:32.115Z","dependency_job_id":"4d3167d6-951d-463d-80e9-e87517ae7d09","html_url":"https://github.com/salesforcecli/plugin-template-sf","commit_stats":{"total_commits":263,"total_committers":12,"mean_commits":"21.916666666666668","dds":"0.25095057034220536","last_synced_commit":"063b1815fca6045f8badba14ebf4e2688e61ebdf"},"previous_names":[],"tags_count":127,"template":true,"template_full_name":"salesforcecli/plugin-template","purl":"pkg:github/salesforcecli/plugin-template-sf","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/salesforcecli%2Fplugin-template-sf","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/salesforcecli%2Fplugin-template-sf/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/salesforcecli%2Fplugin-template-sf/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/salesforcecli%2Fplugin-template-sf/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/salesforcecli","download_url":"https://codeload.github.com/salesforcecli/plugin-template-sf/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/salesforcecli%2Fplugin-template-sf/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31424932,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-05T02:22:46.605Z","status":"ssl_error","status_checked_at":"2026-04-05T02:22:33.263Z","response_time":75,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-03-07T07:32:22.554Z","updated_at":"2026-05-24T08:06:04.528Z","avatar_url":"https://github.com/salesforcecli.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"**NOTE: This template for sf plugins is not yet official. Please consult with the Platform CLI team before using this template.**\n\n# plugin-template-sf\n\n[![NPM](https://img.shields.io/npm/v/@salesforce/plugin-template-sf.svg?label=@salesforce/plugin-template-sf)](https://www.npmjs.com/package/@salesforce/plugin-template-sf) [![Downloads/week](https://img.shields.io/npm/dw/@salesforce/plugin-template-sf.svg)](https://npmjs.org/package/@salesforce/plugin-template-sf) [![License](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](https://opensource.org/license/apache-2-0)\n\n## Using the template\n\nThis repository provides a template for creating a plugin for the Salesforce CLI. To convert this template to a working plugin:\n\n1. Please get in touch with the Platform CLI team. We want to help you develop your plugin.\n2. Generate your plugin:\n\n   ```\n   sf plugins install dev\n   sf dev generate plugin\n\n   git init -b main\n   git add . \u0026\u0026 git commit -m \"chore: initial commit\"\n   ```\n\n3. Create your plugin's repo in the salesforcecli github org\n4. When you're ready, replace the contents of this README with the information you want.\n\n## Learn about `sf` plugins\n\nSalesforce 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.\n\nThis 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.\n\nAdditionally, 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.\n\n### Tooling\n\n- [@salesforce/core](https://github.com/forcedotcom/sfdx-core)\n- [@salesforce/kit](https://github.com/forcedotcom/kit)\n- [@salesforce/sf-plugins-core](https://github.com/salesforcecli/sf-plugins-core)\n- [@salesforce/ts-types](https://github.com/forcedotcom/ts-types)\n- [@salesforce/ts-sinon](https://github.com/forcedotcom/ts-sinon)\n- [@salesforce/dev-config](https://github.com/forcedotcom/dev-config)\n- [@salesforce/dev-scripts](https://github.com/forcedotcom/dev-scripts)\n\n# Everything past here is only a suggestion as to what should be in your specific plugin's description\n\nThis 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).\n\nWe always recommend using the latest version of these commands bundled with the CLI, however, you can install a specific version or tag if needed.\n\n## Install\n\n```bash\nsf plugins install @salesforce/plugin-template-sf@x.y.z\n```\n\n## Issues\n\nPlease report any issues at https://github.com/forcedotcom/cli/issues\n\n## Contributing\n\n1. Please read our [Code of Conduct](CODE_OF_CONDUCT.md)\n2. Create a new issue before starting your project so that we can keep track of\n   what you are trying to add/fix. That way, we can also offer suggestions or\n   let you know if there is already an effort in progress.\n3. Fork this repository.\n4. [Build the plugin locally](#build)\n5. Create a _topic_ branch in your fork. Note, this step is recommended but technically not required if contributing using a fork.\n6. Edit the code in your fork.\n7. 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.\n8. Sign CLA (see [CLA](#cla) below).\n9. Send us a pull request when you are done. We'll review your code, suggest any needed changes, and merge it in.\n\n### CLA\n\nExternal contributors will be required to sign a Contributor's License\nAgreement. You can do so by going to https://cla.salesforce.com/sign-cla.\n\n### Build\n\nTo build the plugin locally, make sure to have yarn installed and run the following commands:\n\n```bash\n# Clone the repository\ngit clone git@github.com:salesforcecli/plugin-template-sf\n\n# Install the dependencies and compile\nyarn \u0026\u0026 yarn build\n```\n\nTo use your plugin, run using the local `./bin/dev` or `./bin/dev.cmd` file.\n\n```bash\n# Run using local run file.\n./bin/dev hello world\n```\n\nThere 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.\n\n```bash\n# Link your plugin to the sf cli\nsf plugins link .\n# To verify\nsf plugins\n```\n\n## Commands\n\n\u003c!-- commands --\u003e\n\n- [`sf hello world`](#sf-hello-world)\n\n## `sf hello world`\n\nSay hello.\n\n```\nUSAGE\n  $ sf hello world [--json] [--flags-dir \u003cvalue\u003e] [-n \u003cvalue\u003e]\n\nFLAGS\n  -n, --name=\u003cvalue\u003e  [default: World] The name of the person you'd like to say hello to.\n\nGLOBAL FLAGS\n  --flags-dir=\u003cvalue\u003e  Import flag values from a directory.\n  --json               Format output as json.\n\nDESCRIPTION\n  Say hello.\n\n  Say hello either to the world or someone you know.\n\nEXAMPLES\n  Say hello to the world:\n\n    $ sf hello world\n\n  Say hello to someone you know:\n\n    $ sf hello world --name Astro\n\nFLAG DESCRIPTIONS\n  -n, --name=\u003cvalue\u003e  The name of the person you'd like to say hello to.\n\n    This person can be anyone in the world!\n```\n\n_See code: [src/commands/hello/world.ts](https://github.com/salesforcecli/plugin-template-sf/blob/1.1.94/src/commands/hello/world.ts)_\n\n\u003c!-- commandsstop --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsalesforcecli%2Fplugin-template-sf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsalesforcecli%2Fplugin-template-sf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsalesforcecli%2Fplugin-template-sf/lists"}