jonathanrico/generate-plan

plugin-<REPLACE ME>

Change above to generator before finalizing

<REPLACE ME DESCRIPTION START>

This repository provides a template for creating a plugin for the Salesforce CLI. To convert this template to a working plugin:

1. Clone this repo
2. Delete the .git folder
3. Replace filler values a) Every instance of generator can be directly substitued for the name of the new plugin. However beware, things like github paths are for the salesforcecli Github organization b) Search for case-matching REPLACE to find other filler values, such as for the plugin description
4. Use git init to set up the desired git information
5. Follow the getting started steps below until the sfdx generate:plan commmand is functioning

<REPLACE ME DESCRIPTION END>

Build

To build the plugin locally, make sure to have yarn installed and run the following commands:

# Clone the repository
git clone https://github.com/darkacer/generate-plan.git

# Install the dependencies and compile
yarn install
yarn build

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.

# Link your plugin to the sfdx cli
sfdx plugins:link
# To verify
sfdx plugins

Commands

USAGE $ sfdx generate:plan [-u ] [-s ] [-d ]

OPTIONS -s, --source path to pick query JSON -d, --destination=destination path to generate plan files

-u, --targetusername=targetusername username or alias for the target org; overrides default target org