@hiregenius/sfcitools v0.5.1

sfcitools

Tools to streamline your development and CI/CD

• Debugging your plugin

$ npm install -g @hiregenius/sfcitools
$ sfdx COMMAND
running command...
$ sfdx (-v|--version|version)
@hiregenius/sfcitools/0.5.1 darwin-x64 node-v14.17.0
$ sfdx --help [COMMAND]
USAGE
  $ sfdx COMMAND
...

• sfdx sfcitools:ci:buildcheck -p <string> -k <string> [-a <string>] [-f <string>] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
• sfdx sfcitools:ci:deploy -p <string> -k <string> [--promote] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
• sfdx sfcitools:ci:validate [-a <string>] [-f <string>] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
• sfdx sfcitools:dev:prepare [-a <string>] [-f <string>] [-d <number>] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
• sfdx sfcitools:qa:prepare -b <string> [-f <string>] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

sfdx sfcitools:ci:buildcheck -p <string> -k <string> [-a <string>] [-f <string>] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Check package creation and installation

Check package creation and installation

USAGE
  $ sfdx sfcitools:ci:buildcheck -p <string> -k <string> [-a <string>] [-f <string>] [-v <string>] [--apiversion 
  <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -a, --setalias=setalias                                                           [default: qa] set scratch org alias

  -f, --definitionfile=definitionfile                                               [default:
                                                                                    config/project-scratch.json] path to
                                                                                    an org definition file

  -k, --installationkey=installationkey                                             (required) installation key for
                                                                                    key-protected package

  -p, --package=package                                                             (required) Packge to run build check
                                                                                    against

  -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|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLE
  $ sfdx sfcitools:ci:buildcheck

See code: lib/commands/sfcitools/ci/buildcheck.js

sfdx sfcitools:ci:deploy -p <string> -k <string> [--promote] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

deploy package in an org

deploy package in an org

USAGE
  $ sfdx sfcitools:ci:deploy -p <string> -k <string> [--promote] [-v <string>] [-u <string>] [--apiversion <string>] 
  [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -k, --installationkey=installationkey                                             (required) installation key for
                                                                                    key-protected package

  -p, --package=package                                                             (required) Packge to deploy

  -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|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

  --promote                                                                         promote package before installation

EXAMPLE
  $ sfdx sfcitools:ci:deploy -v devhub -u org -k abc123 -p package --promote

See code: lib/commands/sfcitools/ci/deploy.js

sfdx sfcitools:ci:validate [-a <string>] [-f <string>] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

run CI pipeline

run CI pipeline

USAGE
  $ sfdx sfcitools:ci:validate [-a <string>] [-f <string>] [-v <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -a, --setalias=setalias                                                           [default: ci] set scratch org alias

  -f, --definitionfile=definitionfile                                               [default:
                                                                                    config/project-scratch.json] path to
                                                                                    an org definition file

  -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|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLES
  $ sfdx sfcitools:ci:validate
  $ sfdx sfcitools:ci:validate -a ci-org -v devhub -f config/project-scratch.json

See code: lib/commands/sfcitools/ci/validate.js

sfdx sfcitools:dev:prepare [-a <string>] [-f <string>] [-d <number>] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

run CI pipeline

run CI pipeline

USAGE
  $ sfdx sfcitools:dev:prepare [-a <string>] [-f <string>] [-d <number>] [-v <string>] [--apiversion <string>] [--json] 
  [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -a, --setalias=setalias                                                           [default: dev] set scratch org alias

  -d, --durationdays=durationdays                                                   [default: 7] duration of the scratch
                                                                                    org (in days) (default:7, min:1,
                                                                                    max:30)

  -f, --definitionfile=definitionfile                                               [default:
                                                                                    config/project-scratch.json] path to
                                                                                    an org definition file

  -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|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLES
  $ sfdx sfcitools:dev:prepare
  $ sfdx sfcitools:dev:prepare -a ci-org -v devhub -f config/project-scratch.json -d 1

See code: lib/commands/sfcitools/dev/prepare.js

sfdx sfcitools:qa:prepare -b <string> [-f <string>] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

creates a 1 day QA scratch org named qa based on the targeted branch

creates a 1 day QA scratch org named qa based on the targeted branch

USAGE
  $ sfdx sfcitools:qa:prepare -b <string> [-f <string>] [-v <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -b, --branch=branch                                                               (required) target branch

  -f, --definitionfile=definitionfile                                               [default:
                                                                                    config/project-scratch.json] path to
                                                                                    an org definition file

  -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|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLES
  $ sfdx sfcitools:dev:qa -b feature-branch-name
  $ sfdx sfcitools:dev:prepare -b feature-branch-name -v devhub -f

See code: lib/commands/sfcitools/qa/prepare.js

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 myOrg@example.com --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 myOrg@example.com

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!