sfp-cli
[Beta] Developer CLI for Salesforce programs following the DX@Scale model.
Not comfortable with git, SFDX or the command-line? Take advantage of guided workflows provided by the sfp-cli, with its interactive prompt-driven UI.
Installation
Prerequisites
The sfp-cli is dependent on other modules that must be installed in order for it to work:
Install sfp-cli
$ npm install -g @dxatscale/sfp-cli
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.
$ sfp init
running command...
? Default git branch for this repo? main
? Associate a devhub with this project? Yes
? Create a new scratch org? (y/N)
...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.
Commands
sfp init
Intializes the project settings:
- Default branch
- DevHub
- Repo provider
Needs to be run at least once per project, as other commands depend on the project settings.
USAGE
$ sfp init
See code: src/commands/init.ts
sfp org
Guided workflows for working with developer orgs, such as opening, creating and deleting an org.
USAGE
$ sfp org
See code: src/commands/org.ts
sfp package
Helpful utilities for dealing with packages in your project:
- Managing package versions and dependency versions
- Create a new package
USAGE
$ sfp package
See code: src/commands/package.ts
sfp sync
Sync changes effortlessly between source repository and development environment
USAGE
$ sfp sync
See code: src/commands/sync.ts
sfp work
Operations for working with work items:
- Create a new work item
- Switch to an existing work item
- Submit a work item
- Delete a work item
USAGE
$ sfp work
See code: src/commands/work.ts