@nreshef/sfdx-plugin
v0.0.1
Published
foresight sfdx cli plugin
Downloads
47
Readme
foresight-sfdx-plugin
foresight sfdx cli plugin
$ npm install -g @nreshef/sfdx-plugin
$ sfdx COMMAND
running command...
$ sfdx (-v|--version|version)
@nreshef/sfdx-plugin/0.0.1 win32-x64 node-v12.19.0
$ sfdx --help [COMMAND]
USAGE
$ sfdx COMMAND
...
sfdx foresight:analyze [-t <string>] [-p <number>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx foresight:config [-t <string>] [-u <string>] [-d <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx foresight:analyze [-t <string>] [-p <number>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
create new ForeSight analysis
create new ForeSight analysis
USAGE
$ sfdx foresight:analyze [-t <string>] [-p <number>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-p, --projectid=projectid foresight projectId
-t, --title=title new analysis title
--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 foresight:analyze --title mytitle
Creating mytitle analysis
See code: lib/commands/foresight/analyze.js
sfdx foresight:config [-t <string>] [-u <string>] [-d <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sets ForeSight configuration like refresh token
sets ForeSight configuration like refresh token
USAGE
$ sfdx foresight:config [-t <string>] [-u <string>] [-d <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-d, --domain=domain Panaya ForeSight domain name
-t, --token=token Panaya ForeSight refresh token
-u, --username=username Panaya ForeSight user email
--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 foresight:config -u [email protected] -t 0899e9fdeaad630bbf8da90e79fa8471 -d my.panaya.com
See code: lib/commands/foresight/config.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:
- 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]
- 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!