Introduction

Extending the Salesforce CLI by Writing Custom Plugins

Learn how to build custom Salesforce CLI plugins using by using Node.js and the Salesforce CLI plugin development framework based in oclif @salesforce/plugin-dev.

Prerequisites

Please make sure you have the following before starting the workshop:

• Basic understanding of JavaScript, Node.js, and how to use a terminal

• Basic experience with the Salesforce CLI (sfdx or sf)

• Node.js (v18 LTS Recommended)

  You can install it using:

  • Official Binaries

  • nvm

  • Volta (Recommended)

• Git/GitHub

• Salesforce CLI Installed (latest version)

  • If you already have it installed please run: sfdx update

• Visual Studio Code with Salesforce Extensions (Recommended)

• A Salesforce Org (Developer Edition is encouraged)

Learning Resources

• [BLOG] Building a Salesforce CLI Plug-In

• [BLOG] Building a CLI Application with oclif

• [VIDEO] codeLive: How to Build a Salesforce CLI Plug-In?

• [VIDEO] codeLive: How to Write NUTS Test Cases for Salesforce CLI Plug-In

• [VIDEO] codeLive: Building a CLI Application with oclif

• [VIDEO] Build a Salesforce Unified CLI Plugin that generates zen quotes | Mini Hacks Solved

• [VIDEO] Build a Salesforce CLI plugin to invoke static methods of an Apex class | Mini Hacks Solved

• [VIDEO] codeLive: Build and Design a CLI Plugin for working with Salesforce Bulk API v2.0

• [VIDEO] Exploring the sf CLI | Developer Quick Takes

• [PODCAST] Salesforce CLI Plugins with Shane McLaughlin | Episode 71

• [DOCS] Quick Introduction to Developing sf Plugins

• [CODE EXAMPLE] rest-api plugin