Salesforce CPQ CLI

A CLI plugin for Salesforce CLI to push and pull CPQ data

• Debugging your plugin

$ npm install -g cpq-cli
$ cpq-cli COMMAND
running command...
$ cpq-cli (-v|--version|version)
cpq-cli/0.1.0 darwin-x64 node-v11.2.0
$ cpq-cli --help [COMMAND]
USAGE
  $ cpq-cli COMMAND
...

• cpq-cli cpq:pull [FILE]
• cpq-cli cpq:push [FILE]

cpq-cli cpq:pull [FILE]

Pushes all records for the given sObject

USAGE
  $ cpq-cli cpq:pull [FILE]

OPTIONS
  -a, --pullall                                    Pulls all records for all CPQ objects
  -c, --configfile=configfile                      The configuration JSON file location
  -o, --object=object                              The sobject that you wish to interact with
  -u, --targetusername=targetusername              username or alias for the target org; overrides default target org
  -v, --targetdevhubusername=targetdevhubusername  username or alias for the dev hub org; overrides default dev hub org
  --apiversion=apiversion                          override the api version used for api requests made by this command
  --json                                           format output as json
  --loglevel=(trace|debug|info|warn|error|fatal)   logging level for this command invocation

EXAMPLE
  $ sfdx cpq:pull -o Product2 -u myOrg -c config/cpq-cli-def.json
       Requesting data, please wait.... Request completed! Receieved X records.

See code: src/commands/cpq/pull.ts

cpq-cli cpq:push [FILE]

Pulls all records for the given sObject

USAGE
  $ cpq-cli cpq:push [FILE]

OPTIONS
  -a, --pushall                                    Pushes all records for all CPQ objects
  -c, --configfile=configfile                      The configuration JSON file location

  -d, --datadir=datadir                            Path to base directory where cpq data is, by default it looks at
                                                   'data' directory in current directory

  -o, --object=object                              The sobject that you wish to interact with

  -r, --remove                                     Remove objects instead of upsert

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

  -v, --targetdevhubusername=targetdevhubusername  username or alias for the dev hub org; overrides default dev hub org

  --apiversion=apiversion                          override the api version used for api requests made by this command

  --json                                           format output as json

  --loglevel=(trace|debug|info|warn|error|fatal)   logging level for this command invocation

EXAMPLE
  $ sfdx cpq:push -o Product2 -u myOrg -c config/cpq-cli-def.json
       Deploying data, please wait.... Deployment completed!

See code: src/commands/cpq/push.ts

Debugging your plugin

We recommend using the Visual Studio Code (VS Code) IDE for your plugin development. Included in the .vscode directory of this plugin is a launch.json config file, which allows you to attach a debugger to the node process when running your commands.

To debug the hello:org command:

1. Start the inspector

If you linked your plugin to the sfdx cli, call your command with the dev-suspend switch:

$ sfdx hello:org -u [email protected] --dev-suspend

Alternatively, to call your command using the bin/run script, set the NODE_OPTIONS environment variable to --inspect-brk when starting the debugger:

$ NODE_OPTIONS=--inspect-brk bin/run hello:org -u [email protected]

2. Set some breakpoints in your command code
3. Click on the Debug icon in the Activity Bar on the side of VS Code to open up the Debug view.
4. In the upper left hand corner of VS Code, verify that the "Attach to Remote" launch configuration has been chosen.
5. Hit the green play button to the left of the "Attach to Remote" launch configuration window. The debugger should now be suspended on the first line of the program.
6. Hit the green play button at the top middle of VS Code (this play button will be to the right of the play button that you clicked in step #5). Congrats, you are debugging!