@eonenergy/eon-sfdx v0.0.1-alpha.4
eon-sfdx
Salesforce DX (SFDX) commands to support salesforce developments & deployments
$ npm install -g @eonenergy/eon-sfdx
$ sfdx COMMAND
running command...
$ sfdx (-v|--version|version)
@eonenergy/eon-sfdx/0.0.1-alpha.4 darwin-x64 node-v16.6.1
$ sfdx --help [COMMAND]
USAGE
$ sfdx COMMAND
...
sfdx eon:commit [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx eon:update:authprovider -n <string> [-a <string>] [-k <string>] [-s <string>] [-t <string>] [-e <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx eon:update:connectedapp -n <string> [-c <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx eon:update:customlabel -n <string> [-c <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx eon:update:custommetadata -n <string> [-k <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx eon:update:customsetting -n <string> [-k <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx eon:update:datasource -n <string> [-e <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx eon:update:namedcredential -n <string> [-e <string>] [-p <string>] [-s <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx eon:update:remotesite -n <string> [-l <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx eon:commit [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Commit changes to a package while maintaining versions
USAGE
$ sfdx eon:commit [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
--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 con242:commit
sfdx con242:commit --updatedependencies
See code: src/commands/eon/commit.ts
sfdx eon:update:authprovider -n <string> [-a <string>] [-k <string>] [-s <string>] [-t <string>] [-e <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Update AuthProvider
USAGE
$ sfdx eon:update:authprovider -n <string> [-a <string>] [-k <string>] [-s <string>] [-t <string>] [-e <string>] [-u
<string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-a, --authorize=authorize Optional Flag For Password Update
-e, --execution=execution Optional Flag For Password Update
-k, --key=key Optional Flag For Password Update
-n, --name=name (required) Required Developer Name
To Select Correct Data For Update
-s, --secret=secret Optional Flag For Password Update
-t, --token=token Optional Flag For Password Update
-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 eon:update:authprovider --targetusername myOrg@example.com --name xx_auth --token xxx
sfdx eon:update:authprovider --targetusername myOrg@example.com -n xx_auth -e mustermann@salesforce.com
See code: src/commands/eon/update/authprovider.ts
sfdx eon:update:connectedapp -n <string> [-c <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Update Connected App Settings
USAGE
$ sfdx eon:update:connectedapp -n <string> [-c <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-c, --callback=callback Optional Flag For Update Callback
Url
-n, --name=name (required) Required Developer Name
To Select Correct Data For Update
-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 eon:update:connectedapp --targetusername myOrg@example.com --name my_app --callback xxx
sfdx eon:update:connectedapp --targetusername myOrg@example.com -n my_app -c https://test.com
See code: src/commands/eon/update/connectedapp.ts
sfdx eon:update:customlabel -n <string> [-c <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Update Custom Label Settings
USAGE
$ sfdx eon:update:customlabel -n <string> [-c <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-c, --value=value Optional Flag For Value Update
-n, --name=name (required) Required Developer Name
To Select Correct Data For Update
-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 eon:update:customlabel --targetusername myOrg@example.com --name my_label --value xxx
sfdx eon:update:customlabel --targetusername myOrg@example.com -n my_label -v XXX
See code: src/commands/eon/update/customlabel.ts
sfdx eon:update:custommetadata -n <string> [-k <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Update Custom Metadata Settings
USAGE
$ sfdx eon:update:custommetadata -n <string> [-k <string>] [-v <string>] [-u <string>] [--apiversion <string>]
[--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-k, --key=key Required Flag For Custom Metadata
Key
-n, --name=name (required) Required Developer Name
To Select Correct Data For Update
-u, --targetusername=targetusername username or alias for the target
org; overrides default target org
-v, --value=value Optional Flag For Custom Metadata
Value Update
--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 eon:update:custommetadata --targetusername myOrg@example.com --name my_label --key my_key --value my_value
sfdx eon:update:custommetadata --targetusername myOrg@example.com -n my_label -k XXX -v xxx
See code: src/commands/eon/update/custommetadata.ts
sfdx eon:update:customsetting -n <string> [-k <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Update Custom Settings
USAGE
$ sfdx eon:update:customsetting -n <string> [-k <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json]
[--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-k, --key=key Required Flag For Custom Setting
Field Key
-n, --name=name (required) Required Developer Name
To Select Correct Data For Update
-u, --targetusername=targetusername username or alias for the target
org; overrides default target org
-v, --value=value Optional Flag For Custom Setting
Value Update
--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 eon:update:customsetting --targetusername myOrg@example.com --name my_object__c --key my_column --value my_value
sfdx eon:update:customsetting --targetusername myOrg@example.com -n my_object__c -k XXX -v xxx
See code: src/commands/eon/update/customsetting.ts
sfdx eon:update:datasource -n <string> [-e <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Update dataSource
USAGE
$ sfdx eon:update:datasource -n <string> [-e <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-e, --endpoint=endpoint Optional Flag For Endpoint Update
-n, --name=name (required) Required Developer Name
To Select Correct Data For Update
-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 eon:update:datasource --targetusername myOrg@example.com --name my_datasource --endpoint xxx
sfdx eon:update:datasource --targetusername myOrg@example.com -n my_source -e https://test.com
See code: src/commands/eon/update/datasource.ts
sfdx eon:update:namedcredential -n <string> [-e <string>] [-p <string>] [-s <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Update NamedCredential
USAGE
$ sfdx eon:update:namedcredential -n <string> [-e <string>] [-p <string>] [-s <string>] [-u <string>] [--apiversion
<string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-e, --endpoint=endpoint Optional Flag For Update Endpoint
-n, --name=name (required) Required Developer Name
To Select Correct Data For Update
-p, --password=password Optional Flag For Password Update
-s, --username=username Optional Flag For Update Username
-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 eon:update:namedcredentials --targetusername myOrg@example.com --name xx_mule --password xxx
sfdx eon:update:namedcredentials --targetusername myOrg@example.com -n xx_base -e https://test.com
See code: src/commands/eon/update/namedcredential.ts
sfdx eon:update:remotesite -n <string> [-l <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Update RemoteSide Settings
USAGE
$ sfdx eon:update:remotesite -n <string> [-l <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-l, --url=url Optional Flag For Update Url
-n, --name=name (required) Required Developer Name
To Select Correct Data For Update
-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 eon:update:remotesite --targetusername myOrg@example.com --name my_page --url xxx
sfdx eon:update:remotesite --targetusername myOrg@example.com -n my_site -l https://test.com
See code: src/commands/eon/update/remotesite.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 eon:update:datasource
command:
1. Start the inspector
If you linked your plugin to the sfdx cli, call your command with the dev-suspend
switch:
$ sfdx eon:update:datasource -u myOrg@example.com --endpoint https://test.com
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 eon:update:datasource -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!