@pmalicki/sforce-summit-plugin
v0.0.1
Published
SF CLI Plug-In demo
Downloads
43
Readme
@pmalicki/sforce-summit-plugin
SF CLI Plug-In demo
$ npm install -g @pmalicki/sforce-summit-plugin
$ sfdx COMMAND
running command...
$ sfdx (--version)
@pmalicki/sforce-summit-plugin/0.0.1 darwin-arm64 node-v18.0.0
$ sfdx --help [COMMAND]
USAGE
$ sfdx COMMAND
...
sfdx hello:org [-n <string>] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx sforce:org:setup -c <directory> -m <directory> [-a <string>] [-d] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx hello:org [-n <string>] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
print a greeting and your org IDs
USAGE
$ sfdx hello:org [-n <string>] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-f, --force example boolean flag
-n, --name=<value> name to print
-u, --targetusername=<value> username or alias for the target
org; overrides default target org
-v, --targetdevhubusername=<value> username or alias for the dev hub
org; overrides default dev hub org
--apiversion=<value> 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
DESCRIPTION
print a greeting and your org IDs
EXAMPLES
$ sfdx hello:org --targetusername [email protected] --targetdevhubusername [email protected]
$ sfdx hello:org --name myname --targetusername [email protected]
See code: src/commands/hello/org.ts
sfdx sforce:org:setup -c <directory> -m <directory> [-a <string>] [-d] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
set up new org
USAGE
$ sfdx sforce:org:setup -c <directory> -m <directory> [-a <string>] [-d] [-v <string>] [--apiversion <string>]
[--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-a, --alias=<value> scratch org alias
-c, --configfile=<value> (required) [default:
config/project-scratch-def.json]
path to scratch org configuration
-d, --defautl set an org as default
-m, --metadata=<value> (required) [default: force-app]
metadata directory
-v, --targetdevhubusername=<value> username or alias for the dev hub
org; overrides default dev hub org
--apiversion=<value> 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
DESCRIPTION
set up new org
EXAMPLES
$ sfdx sforce:org:setup
$ sfdx sforce:org:setup -a my-new-org -m force-app -c config/project-scratch-def.json -v DevHub
See code: src/commands/sforce/org/setup.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:
- 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!