Forg-sandbox-refresh NPM

forg-sandbox-refresh

a plugin to help deploying to new sandboxes

Debugging your plugin

$ npm install -g forg-sandbox-refresh
$ sfdx COMMAND
running command...
$ sfdx (-v|--version|version)
forg-sandbox-refresh/0.0.9 darwin-x64 node-v12.16.3
$ sfdx --help [COMMAND]
USAGE
  $ sfdx COMMAND
...

`sfdx forg:login -u <string> -p <string> [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

Log into an Org with Username and Password

USAGE
  $ sfdx forg:login -u <string> -p <string> [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -p, --password=password                                                           (required) your password
  -u, --username=username                                                           (required) your username
  --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 forg:login -u username@salesforce.org -p password123

See code: lib/commands/forg/login.js

`sfdx forg:runapex -u <string> -f <string> [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

Read connected app information

USAGE
  $ sfdx forg:runapex -u <string> -f <string> [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -f, --apexname=apexname                                                           (required) local apex file location
                                                                                    and name to be run

  -u, --username=username                                                           (required) your org username

  --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 forg:runapex -u username@salesforce.org -f ./scripts/apex/myscript.apex

See code: lib/commands/forg/runapex.js

`sfdx forg:runfile -f <string> [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

Run a local file

USAGE
  $ sfdx forg:runfile -f <string> [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -f, --file=file                                                                   (required) location and file to be
                                                                                    run

  --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 forg:runfile -f ./bin/do-the-things.sh

See code: lib/commands/forg/runfile.js

`sfdx forg:upsertdata -u <string> -d <string> [-f <string>] [-a] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

Use the Bulk API to upsert records from CSVs. File name format should be order-name-object-externalIdField.csv, e.g. 01-ParentAccounts-Account-ExternalId__c.csv

USAGE
  $ sfdx forg:upsertdata -u <string> -d <string> [-f <string>] [-a] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -a, --upsertall                                                                   upsert all CSVs in the passed
                                                                                    directory

  -d, --directory=directory                                                         (required) directory locations of
                                                                                    your CSV files to upsert

  -f, --file=file                                                                   name of CSV to upsert

  -u, --username=username                                                           (required) your org username

  --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 forg:insertdata -u username@salesforce.org -d ./data -f 01-Accounts-Account-ExternalId__c.csv
  $ sfdx forg:insertdata -u username@salesforce.org -d ./data -a

See code: lib/commands/forg/upsertdata.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: 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

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!

sfdx-plugin

@oclif/command @oclif/config @oclif/errors @salesforce/command @salesforce/core help sinon tslib

@everything-registry/sub-chunk-1693

4 years ago

4 years ago

4 years ago

4 years ago