scdx v1.2.3

scdx

SFDX plugins designed for Smart Cloud consultants

• Debugging your plugin

$ npm install -g scdx
$ sfdx COMMAND
running command...
$ sfdx (-v|--version|version)
scdx/1.2.3 darwin-x64 node-v16.14.2
$ sfdx --help [COMMAND]
USAGE
  $ sfdx COMMAND
...

• sfdx scdx:executor:execute [-p <string>] [-j <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
• sfdx scdx:installedPackage:clean [-p <string>] [-r <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
• sfdx scdx:label:build [-r <string>] [-c <string>] [-l <string>] [-o <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
• sfdx scdx:label:convert [-r <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
• sfdx scdx:permSet:build [-p <string>] [-r <string>] [-c <string>] [-o <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
• sfdx scdx:permSet:convert [-p <string>] [-r <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
• sfdx scdx:profile:build [-p <string>] [-r <string>] [-c <string>] [-o <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
• sfdx scdx:profile:convert [-p <string>] [-r <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

sfdx scdx:executor:execute [-p <string>] [-j <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

executes a job/plan directly

USAGE
  $ sfdx scdx:executor:execute [-p <string>] [-j <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -j, --job=job                                                                     Name of job to execute as defined in
                                                                                    job configurations and scdx.json

  -p, --plan=plan                                                                   Path to plan

  --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 scdx:executor:execute -p somePlan/.json
  $ sfdx scdx:executor:execute -j testJob1

See code: src/commands/scdx/executor/execute.ts

sfdx scdx:installedPackage:clean [-p <string>] [-r <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Clean Installed package metadata from the activateRss issue

USAGE
  $ sfdx scdx:installedPackage:clean [-p <string>] [-r <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -p, --packagename=packagename                                                     Package name

  -r, --sourcepath=sourcepath                                                       [default: force-app/main/default/ins
                                                                                    talledPackages] Path to installed
                                                                                    package files

  --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 scdx:InstalledPackage:clean

See code: src/commands/scdx/installedPackage/clean.ts

sfdx scdx:label:build [-r <string>] [-c <string>] [-l <string>] [-o <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Convert label xml into small chunks of json files

USAGE
  $ sfdx scdx:label:build [-r <string>] [-c <string>] [-l <string>] [-o <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -c, --components=components                                                       Path to file containing  seperated
                                                                                    paths to labels to be built into
                                                                                    label xml

  -l, --list=list                                                                   Text list of label names to include

  -o, --output=output                                                               Output path to write label xml to.

  -r, --sourcepath=sourcepath                                                       [default:
                                                                                    force-app/main/default/labels] Path
                                                                                    to label files

  --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 scdx:label:build
  $ sfdx scdx:label:build  -r src/labels

See code: src/commands/scdx/label/build.ts

sfdx scdx:label:convert [-r <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Convert Label xml into small chunks of json files

USAGE
  $ sfdx scdx:label:convert [-r <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -r, --sourcepath=sourcepath                                                       [default: force-app/main/default/lab
                                                                                    els/CustomLabels] Path to label file

  --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 scdx:label:convert
  $ sfdx scdx:permissionset:convert -r src/labels

See code: src/commands/scdx/label/convert.ts

sfdx scdx:permSet:build [-p <string>] [-r <string>] [-c <string>] [-o <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Builds small json files into a permission set xml

USAGE
  $ sfdx scdx:permSet:build [-p <string>] [-r <string>] [-c <string>] [-o <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -c, --components=components                                                       Path to file containing  seperated
                                                                                    paths to components to be built into
                                                                                    Permission Set

  -o, --output=output                                                               Output path to write Permission Sets
                                                                                    to.

  -p, --psetname=psetname                                                           Permission Set name to be built

  -r, --sourcepath=sourcepath                                                       [default: force-app/main/default/per
                                                                                    missionsets] Path to Permission Set
                                                                                    files

  --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 scdx:PermissionSet:build
  $ sfdx scdx:PermissionSet:build -p SuperUser -r src/permissionsets
  $ sfdx scdx:PermissionSet:build -p SuperUser -r src/permissionsets -o outputDirectory/permission sets
  $ sfdx scdx:PermissionSet:build -p SuperUser -r src/permissionsets -c aFold/desiredComponents.txt

See code: src/commands/scdx/permSet/build.ts

sfdx scdx:permSet:convert [-p <string>] [-r <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Convert permissionset xml into small chunks of json files

USAGE
  $ sfdx scdx:permSet:convert [-p <string>] [-r <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -p, --psetname=psetname                                                           Permission set name to be converted

  -r, --sourcepath=sourcepath                                                       [default: force-app/main/default/per
                                                                                    missionsets] Path to permission set
                                                                                    files files

  --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 scdx:permissionset:convert
  $ sfdx scdx:permissionset:convert -p SuperUser -r src/permissionsets

See code: src/commands/scdx/permSet/convert.ts

sfdx scdx:profile:build [-p <string>] [-r <string>] [-c <string>] [-o <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Builds into small chunks of json files into a profile xml

USAGE
  $ sfdx scdx:profile:build [-p <string>] [-r <string>] [-c <string>] [-o <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -c, --components=components                                                       Path to file containing  seperated
                                                                                    paths to components to be built into
                                                                                    profile

  -o, --output=output                                                               Output path to write profiles to.

  -p, --profilename=profilename                                                     Profile name to be built

  -r, --sourcepath=sourcepath                                                       [default:
                                                                                    force-app/main/default/profiles]
                                                                                    Path to profile files

  --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 scdx:profile:build
  $ sfdx scdx:profile:build -r src/profiles
  $ sfdx scdx:profile:build -p Admin -r src/profiles
  $ sfdx scdx:profile:build -p Admin -r src/profiles -o outputDirectory/profiles
  $ sfdx scdx:profile:build -p Admin -r src/profiles -o outputDirectory/profiles -c somePath/desiredComponents.txt

See code: src/commands/scdx/profile/build.ts

sfdx scdx:profile:convert [-p <string>] [-r <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Convert profile xml into small chunks of json files

USAGE
  $ sfdx scdx:profile:convert [-p <string>] [-r <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -p, --profilename=profilename                                                     Profile name to be converted

  -r, --sourcepath=sourcepath                                                       [default:
                                                                                    force-app/main/default/profiles]
                                                                                    Path to profile files

  --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 scdx:profile:convert
  $ sfdx scdx:profile:convert -p Admin -r src/profiles

See code: src/commands/scdx/profile/convert.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 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!