comparinator
I'll be back
$ npm install -g sfdx-plugin-comparinator
$ sfdx COMMAND
running command...
$ sfdx (-v|--version|version)
sfdx-plugin-comparinator/0.0.4 linux-x64 node-v12.18.0
$ sfdx --help [COMMAND]
USAGE
$ sfdx COMMAND
...sfdx comparinator:perms:compare -s <array> -t <array> [-g] [-d] [-f <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx comparinator:perms:make -o [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx comparinator:perms:merge -p <array> [-l] [-g] [-d] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx comparinator:perms:compare -s <array> -t <array> [-g] [-d] [-f <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Compares aggregate permisisons from source list against and target list writing higher permissions contained in target list to stdout
USAGE
$ sfdx comparinator:perms:compare -s <array> -t <array> [-g] [-d] [-f <string>] [-u <string>] [--apiversion <string>]
[--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-d, --getpermsdir look for permission sets in the sfdx
project permissions folder
-f, --tofile=tofile write differences to file in xml
format
-g, --getorg look for permission sets on
Salesforce org
-s, --sourceperms=sourceperms (required) Source list of permission
set files to be compared against
target (use permission set names
when using -g or -d); list is comma
separated
-t, --targetperms=targetperms (required) Target list of permission
set files to be compared against
target (use permission set names
when using -g or -d); list is comma
separated
-u, --targetusername=targetusername username or alias for the target
org; overrides default target 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 comparinator:perms:compare -s permset1.xml,permset2.xml -t permset3.xml,permset4.xml -f differences.xml
$ sfdx comparinator:perms:compare -s permset1 -t permset2,permset3 -g
sfdx comparinator:perms:make -o [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Makes a permission set file containing permissions as set by other flags
USAGE
$ sfdx comparinator:perms:make -o [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-o, --makeobjects (required) grant read only access to
all custom objects in org
-u, --targetusername=targetusername username or alias for the target
org; overrides default target 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 comparinator:perms:make -o
$ sfdx comparinator:perms:make -o --json
sfdx comparinator:perms:merge -p <array> [-l] [-g] [-d] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Merges permission sets and writes to stdout
USAGE
$ sfdx comparinator:perms:merge -p <array> [-l] [-g] [-d] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-d, --getpermsdir look for permission sets in the sfdx
project permissions folder
-g, --getorg look for permission sets on
Salesforce org
-l, --formatasprofile format output as profile metadata
(default is permission set)
-p, --permissionsets=permissionsets (required) list of permission set
files to merge (or names when using
-g or -d); list is comma separated
-u, --targetusername=targetusername username or alias for the target
org; overrides default target 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 comparinator:perms:merge -p permset1.xml,permset2.xml,permset3.xml
$ sfdx comparinator:perms:merge -p permset1,permset2,permset3 -g
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:
- 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-suspendAlternatively, 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- Set some breakpoints in your command code
- Click on the Debug icon in the Activity Bar on the side of VS Code to open up the Debug view.
- In the upper left hand corner of VS Code, verify that the "Attach to Remote" launch configuration has been chosen.
- 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.
- 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!