Skip to content

Latest commit

 

History

History
84 lines (71 loc) · 4.62 KB

README.md

File metadata and controls

84 lines (71 loc) · 4.62 KB
Raw

sfdx-rusl-plugin

The plugin to manage sfdx project sources

Version CircleCI Appveyor CI Codecov Greenkeeper Known Vulnerabilities Downloads/week License

$ npm install -g sfdx-rusl-plugin
$ sfdx-rusl-plugin COMMAND
running command...
$ sfdx-rusl-plugin (-v|--version|version)
sfdx-rusl-plugin/0.0.1 darwin-x64 node-v10.13.0
$ sfdx-rusl-plugin --help [COMMAND]
USAGE
  $ sfdx-rusl-plugin COMMAND
...

sfdx-rusl-plugin rusl:mdapi:package:install

install a package with its dependencies using Metadata API

USAGE
  $ sfdx-rusl-plugin rusl:mdapi:package:install

OPTIONS
  -d, --outputdir=outputdir                        [default: mdapiout] a directory name to store converted sources
  -n, --packagename=packagename                    (required) a name of the package to install
  -s, --savesources                                a flag to save or release the package converted metadata
  -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)   logging level for this command invocation

EXAMPLES
  $ sfdx rusl:mdapi:package:install --targetusername myOrg@example.com --packagename myPackage
  $ sfdx rusl:mdapi:package:install --targetusername myOrg --packagename myPackage --outputdir mdsource
  $ sfdx rusl:mdapi:package:install --targetusername myOrg --packagename myPackage --savesources

See code: src/commands/rusl/mdapi/package/install.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
  1. Set some breakpoints in your command code
  2. Click on the Debug icon in the Activity Bar on the side of VS Code to open up the Debug view.
  3. In the upper left hand corner of VS Code, verify that the "Attach to Remote" launch configuration has been chosen.
  4. 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.
  5. 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!