- [sfdx-djc-plugin
](#sfdx-djc-plugin--build-statushttpstravis-ciorgdcarrollsfdx-djc-pluginsvgbranchmasterhttpstravis-ciorgdcarrollsfdx-djc-plugin)
A plugin for the Salesforce CLI built by Dave Carroll and containing a few of helpful commands.
-
Install the SDFX CLI.
-
Clone the repository:
git clone git@github.com:wadewegner/sfdx-djc-plugin.git -
Install npm modules:
yarn -
Link the plugin:
sfdx plugins:link .
- Install plugin:
sfdx plugins:install sfdx-tohoom-plugin
$ npm install -g sfdx-djc-plugin
$ sfdx-djc-plugin COMMAND
running command...
$ sfdx-djc-plugin (-v|--version|version)
sfdx-djc-plugin/0.0.32 darwin-x64 node-v14.15.0
$ sfdx-djc-plugin --help [COMMAND]
USAGE
$ sfdx-djc-plugin COMMAND
...sfdx-djc-plugin djc:cleardata -o <string> [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx-djc-plugin djc:export [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx-djc-plugin djc:import [-x] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx-djc-plugin tohoom:data:export -o <string> -t <string> [-n <string>] [-m <integer>] [-s] [-p] [-e] [-b] [-k] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx-djc-plugin tohoom:data:split [-n <string>] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx-djc-plugin djc:cleardata -o <string> [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Delete data from a scratch org.
USAGE
$ sfdx-djc-plugin djc:cleardata -o <string> [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-o, --sobject=sobject (required) Object to delete all
records for
-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|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
EXAMPLE
$ sfdx djc:cleardata -o Account
See code: src/commands/djc/cleardata.ts
sfdx-djc-plugin djc:export [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Import data to an org to use in a scratch org.
USAGE
$ sfdx-djc-plugin djc:export [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-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|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
EXAMPLE
$ sfdx djc:import -p directory
See code: src/commands/djc/export.ts
sfdx-djc-plugin djc:import [-x] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Import data to an org to use in a scratch org.
USAGE
$ sfdx-djc-plugin djc:import [-x] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-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
-x, --xfiles Use the limited size files instead
of full size files
--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
EXAMPLE
$ sfdx djc:import -p directory
See code: src/commands/djc/import.ts
sfdx-djc-plugin tohoom:data:export -o <string> -t <string> [-n <string>] [-m <integer>] [-s] [-p] [-e] [-b] [-k] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Extract data from an org to use in a scratch org. Just supply a list of SObjects and you should end up with a dataset and data plan that can be used with the official force:data:tree:import command
USAGE
$ sfdx-djc-plugin tohoom:data:export -o <string> -t <string> [-n <string>] [-m <integer>] [-s] [-p] [-e] [-b] [-k] [-u
<string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-b, --preserveobjectorder If present, uses the order of the
objects from the command to
determine plan order
-e, --enforcereferences If present, missing child reference
cause the record to be deleted,
otherwise, just the reference field
is removed
-k, --tohoom Special Tohoom processing to handle
self referential relationship
-m, --maxrecords=maxrecords [default: 10] Max number of records
to return in any query
-n, --planname=planname [default: new-data-plan] name of the
data plan to produce, deflaults to
"new-plan"
-o, --objects=objects (required) Comma separated list of
objects to fetch
-p, --spiderreferences Include refereced SObjects
determined by schema examination and
existing data
-s, --savedescribes Save describe results (for
diagnostics)
-t, --targetdir=targetdir (required) target directoy to place
results 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|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
EXAMPLE
$ sfdx tohoom:data:export -o Account,Contact,Case,Opportunity -t data/exported -n my-testplan
See code: src/commands/tohoom/data/export.ts
sfdx-djc-plugin tohoom:data:split [-n <string>] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Extract data from an org to use in a scratch org. Just supply a list of SObjects and you should end up with a dataset and data plan that can be used with the official force:data:tree:import command
USAGE
$ sfdx-djc-plugin tohoom:data:split [-n <string>] [-v <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-n, --planname=planname [default: data-plan] name of the
data plan to use with split
-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|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
EXAMPLE
$ sfdx tohoom:data:export -o Account,Contact,Case,Opportunity -t data/exported -n my-testplan
See code: src/commands/tohoom/data/split.ts