sfdx-nforce
===========

Plugin that enhances sfdx. Most of the comands will be deprecated as DX matures.


* Debugging your plugin



``sh-session
$ npm install -g sfdx-nforce
$ sfdx-nforce COMMAND
running command...
$ sfdx-nforce (-v|--version|version)
sfdx-nforce/0.0.4 darwin-x64 node-v11.10.1
$ sfdx-nforce --help [COMMAND]
USAGE
$ sfdx-nforce COMMAND
...
`


* sfdx-nforce nforce
* sfdx-nforce nforce:auth:connectapp:create
* sfdx-nforce nforce:auth:user:create
* sfdx-nforce nforce:org:share
* sfdx-nforce nforce:profiles:fix
* sfdx-nforce nforce:profiles:retrieve

sfdx-nforce nforce

print a greeting and your org IDs

`
USAGE
$ sfdx-nforce nforce

OPTIONS
-f, --force example boolean flag
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal) logging level for this command invocation

EXAMPLES
$ sfdx hello:org --targetusername myOrg@example.com --targetdevhubusername devhub@org.com
Hello world! This is org: MyOrg and I will be around until Tue Mar 20 2018!
My hub org id is: 00Dxx000000001234

$ sfdx hello:org --name myname --targetusername myOrg@example.com
Hello myname! This is org: MyOrg and I will be around until Tue Mar 20 2018!
`

_See code: src/commands/nforce.ts_

sfdx-nforce nforce:auth:connectapp:create

Create a connected app in your scratch org

`
USAGE
$ sfdx-nforce nforce:auth:connectapp:create

OPTIONS
-c, --calbackurl=calbackurl Url for callback (default will be sfdx://success
-d, --description=description Description of the connected app that you want to create
-l, --label=label Label of the connected app that you want to create
-n, --name=name (required) Name of the connected app that you want to create
-s, --scopes=scopes Scopes that you want to use. (comma delimited)
-u, --targetusername=targetusername username or alias for the target org; overrides default target org
-w, --cert Create an register cert
--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 nforce:auth:connectapp:create -n "Connected App Name"
Creating app....
App created, Id: {}
$ sfdx nforce:auth:connectapp:create -n "Connected App Name" -l "My label" -w -c "https://somethignelse.com", -s
"Api,web"
Creating app....
App created, Id: {}
`

_See code: src/commands/nforce/auth/connectapp/create.ts_

sfdx-nforce nforce:auth:user:create

Create an user with role and authenticate app.

`
USAGE
$ sfdx-nforce nforce:auth:user:create

OPTIONS
-a, --auth Authenticat user to app ?
-c, --newapp create a new app ?
-f, --definitionfile=definitionfile file path to a user definition
-n, --appname=appname name o the app that you want to use to log-in
-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) logging level for this command invocation
`

_See code: src/commands/nforce/auth/user/create.ts_

sfdx-nforce nforce:org:share

Sends an email with your org information.

`
USAGE
$ sfdx-nforce nforce:org:share

OPTIONS
-a, --all=all test
-u, --targetusername=targetusername username or alias for the target org; overrides default target org
-u, --url=url test
--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 nforce:org:share
$ sfdx nforce:org:share -u -a
`

_See code: src/commands/nforce/org/share.ts_

sfdx-nforce nforce:profiles:fix

Run Operations against profiles

`
USAGE
$ sfdx-nforce nforce:profiles:fix

OPTIONS
-n, --name=name name to print
-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) logging level for this command invocation

EXAMPLES
$ sfdx nforce:profiles:fix
$ sfdx nforce:profiles:fix -n SystemProfile
`

_See code: src/commands/nforce/profiles/fix.ts_

sfdx-nforce nforce:profiles:retrieve

Run Operations against profiles

`
USAGE
$ sfdx-nforce nforce:profiles:retrieve

OPTIONS
-c, --clean Run clean on the profile(s)
-n, --name=name name to print
-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) logging level for this command invocation

EXAMPLES
$ sfdx nforce:profiles:retrieve
$ sfdx nforce:profiles:retrieve -n SystemProfile
`

_See code: src/commands/nforce/profiles/retrieve.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:
`sh-session
$ 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:
`sh-session
$ 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!