sfp-cli

Installation
Prerequisites
The sfp-cli is dependent on other modules that must be installed in order for it to work:
​Salesforce CLI​
​sfpowerkit​
Install sfp-cli
1
$ npm install -g @dxatscale/sfp-cli
Copied!
Usage
The sfp-cli may be slightly different than the CLI's that you are accustomed to using. Firstly, the sfp-cli is its own CLI, and not a plugin of the Salesforce CLI, which means that to start using it all you have to type into the terminal is $ sfp. The other key difference is that the commands do not accept any flags or arguments. Sfp-cli is designed with an interactive prompt-based UI, which is as simple as following the instruction on the screen. Try it out for yourself by typing $ sfp [COMMAND] in the terminal, substituting [COMMAND] for one of the commands listed below.
1
$ sfp init
2
running command...
3
? Default git branch for this repo? main
4
? Associate a devhub with this project? Yes
5
? Create a new scratch org? (y/N)
6
...
Copied!
Work Items
The sfp-cli is built around the idea of work items, which are units of work usually defined on an issue tracking system like Jira. Instead of using git directly to create a new branch, in which to do development work, use $ sfp work to create or switch between work items, which have their own associated branch as well as development org.
Syncing changes
The $ sfp sync command allows you to effortlessly sync changes between your source repository and development org. It abstracts the nitty-gritty details of git and SFDX commands into simple prompt-driven workflows, while also providing augmented functionality such as moving pulled components into packages and recommendations for packaging.\

Environment Variables

Command Glossary

Last modified 1mo ago

Export as PDF

Copy link

Edit on GitHub

Contents