capgemdx
SFDX DevOps Orchestrator
- Facilitates the scratch org creation
- Facilites project deployment for CICD
- Deploy delta changes
- ETL datasets
- capgemdx
- Install plugin via SFDX
- Create a new folder named "gemconfig" to your sfdx project root directory
- gemconfig.json
- gemscoconfig.json: configuration specific to scratch org
- gemsandboxconfig.json: configuration specific to sandbox
- gemprodconfig.json: configuration specific to production
- Configuration Operation list:
- Debugging your plugin
<!-- install -->
You'll be prompted that this, like any plugin, is not officially code-signed by Salesforce. Continue installation
$ npm install -g capgemdx
$ sfdx COMMAND
running command...
$ sfdx (-v|--version|version)
capgemdx/1.3.0 win32-x64 node-v16.13.1
$ sfdx --help [COMMAND]
USAGE
$ sfdx COMMAND
...Install plugin via SFDX
- sfdx plugins:install capgemdx
Create a new folder named "gemconfig" to your sfdx project root directory
- Add the following configuration files
gemconfig.json
- orgmetadatafilepath: holding folder path for processing metadata files
- outputdatafilepath: holding folder path for processing data files
- manualprompt: boolean value indicating whether a manual prompt is required pre-scratchorg deployments
- filesignore: folder or files to ignore when performing branch diff e.g. { "orgmetadatafilepath": "./mdapioutput/orgmetadata/", "outputdatafilepath": "./mdapioutput/data/", "logfile": "./mdapioutput/log/capgemdx.log", "logsize": 102400, "manualprompt": "false", "diffRenameLimit": "10000", "packageWaitTime": 30, "apiversion": "50.0", "filesignore": [ "data/", "scripts/", "config/", "decommissioned/", "force-app/unused/", "jsconfig.json", ".eslintrc.json", "devops/", ".forceignore", ".gitignore", "sfdx-project.json", "gemconfig/*", ".vim-force.com/session.properties", "**.DS_Store" ], "diffsuppressfolders": [], "branching": [ "prototype-", "develop-", "feature-" ] }
gemscoconfig.json: configuration specific to scratch org
-
forceignore: array of relative paths to metadata files to include in .forceignore, include \n for newline
-
postscratchorgcreate: operation to be executed post scratch org create, accepts operation list, see acceptable operation lists
-
predeployment: operation to be executed pre-deployment, accepts operation list, see acceptable operation lists
-
postdeployment: operation to be executed post deployment, accepts operation list, see acceptable operation lists
-
postcleanup: cleanup activities before termination of process
-
e.g. Copy the following json and save in gemscoconfig.json { "forceignore": [ "\n#STARTIGNORE", "\n#ENDIGNORE" ], "postscratchorgcreate": [ { "type": "command", "value": [ "sfdx force:org:open", "sfdx force:data:record:update -s User -w "Name='User User'" -v "UserPermissionsKnowledgeUser=true"" ] }, { "type": "api", "method": "POST", "url": "/services/data/v50.0/sobjects/OrgWideEmailAddress", "body": { "Address": "test@gmail.com", "DisplayName": "displayname", "IsAllowAllProfiles": true } } ], "predeployment": [ { "type": "package", "name": "Salesforce.com CRM Dashboards", "packageid": "04t50000000EcdrAAC" } ], "prepush": [ { "type":"replace", "from": "test-[A-Za-z0-9@.\-]@example.com", "to": "s#test-[A-Za-z0-9@.\-]@example.com#$username#g", "path": ["./force-app/main/default/"] } ], "postdeployment": [ { "type":"command", "value": [ "sfdx force:user:permset:assign --permsetname Manage_Encryption_Keys", "value": "sfdx force:user:permset:assign --permsetname Apex_Debugger" ] } ], "postcleanup": [ { "type":"replace", "from": "test-[A-Za-z0-9@.\-]@example.com", "to": "test-username@example.com", "path": [ "force-app/main/default/settings/Case.settings-meta.xml", "./force-app/main/default/reports/" ] } ] }
gemsandboxconfig.json: configuration specific to sandbox
- forceignore: array of relative paths to metadata files to include in .forceignore, include \n for newline
- predeployment: operation to be executed pre-deployment, accepts operation list, see acceptable operation lists
- postdeployment: operation to be executed post deployment, accepts operation list, see acceptable operation lists
- postcleanup: cleanup activities before termination of process
gemprodconfig.json: configuration specific to production
- forceignore: array of relative paths to metadata files to include in .forceignore, include \n for newline
- predeployment: operation to be executed pre-deployment, accepts operation list, see acceptable operation lists
- postdeployment: operation to be executed post deployment, accepts operation list, see acceptable operation lists
- postcleanup: cleanup activities before termination of process
Configuration Operation list:
- command: any acceptable line command
e.g.
{ "type":"command", "value": "sfdx force:user:permset:assign --permsetname Manage_Encryption_Keys" } - replace: find and replace operation
e.g.
{ "type":"replace", "from": "<name>test-[A-Za-z0-9@.\\-]*@example.com</name>", "to": "s#<name>test-[A-Za-z0-9@.\\-]*@example.com</name>#<name>$username<name>#g", "path":["./force-app/base-objects/main/default/"] } - api: api callout operation
e.g.
{ "type": "api", "method": "POST", "url": "/services/data/v50.0/sobjects/OrgWideEmailAddress", "body": { "Address": "xxx@email.com", "DisplayName": "displayname", "IsAllowAllProfiles": true } } - package: appexchange package installation
e.g.
{ "type": "package", "name": "Salesforce.com CRM Dashboards", "packageid": "04t50000000EcdrAAC" }
sfdx gem:data:delete -q <string> [-o <string>] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx gem:data:etl -n <array> -o <string> -i <string> -a <array> [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx gem:data:scratchOrgInit -c <string> [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx gem:data:substitution -s <string> -t <string> -a <array> [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx gem:data:uploadcontent [-m <string>] [-n <string>] [-r <array>] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx gem:org:backsync -a <array> -o <string> -t <string> [-s <string>] [-d <array>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx gem:org:branching -n <string> [-b <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx gem:org:create -u <array> [-d <number>] [-f] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx gem:org:deploy [-t <string>] [-d <string>] [-l <string>] [-r <string>] [-o <array>] [-i <array>] [-p] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx gem:org:diff -a <string> -b <string> [-t <string>] [-d <string>] [-l <string>] [-r <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx gem:org:disabledeliverability [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx gem:org:execaction [-t <string>] [-a <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx gem:org:push [-p] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx gem:org:sharedactivities [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx gem:org:sharedcontacts [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx gem:org:sharequicktextfolders [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx gem:test:etasks [-t <string>] [-a <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx gem:test:org [-n <string>] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx gem:data:delete -q <string> [-o <string>] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
print a greeting and your org IDs
USAGE
$ sfdx gem:data:delete -q <string> [-o <string>] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json]
[--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-f, --force example boolean flag
-o, --objectname=objectname Object Name
-q, --query=query (required) query
-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
EXAMPLES
$ sfdx gem:data:delete -q "SELECT Id from sobject" -o object -u orgname --json
$ sfdx gem:data:delete -q "SELECT Id,Name from Account" -o Account -u orgname -f --json
See code: src/commands/gem/data/delete.ts
sfdx gem:data:etl -n <array> -o <string> -i <string> -a <array> [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
print a greeting and your org IDs
USAGE
$ sfdx gem:data:etl -n <array> -o <string> -i <string> -a <array> [-f] [-v <string>] [-u <string>] [--apiversion
<string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-a, --objarray=objarray (required) object:Id of master
record
-f, --force example boolean flag
-i, --externalkey=externalkey (required) object external Id field
reference
-n, --name=name (required) name to print
-o, --objectname=objectname (required) Object API name
-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
EXAMPLES
$ sfdx gem:data:etl -n filename -o ObjectName -i Id -a object:MappedField:ExternalId -f -u orgname
$ sfdx gem:data:etl -n ./data/DRS_Specialty__c.csv -o DRS_Specialty__c -i Id -a DRS_Specialty__c:Id:Name -f -u orgname
$ sfdx gem:data:etl -n ./data/DRS_Specialty_Tag__c.csv -o DRS_Specialty_Tag__c -i UniqueKey__c -a
sked__Tag__c:Tag__c:Name,DRS_Specialty__c:Specialty__c:Name -f
$ sfdx gem:data:etl -n ./data/contact.csv -o Contact -i Id -a
contact:Id:Name,recordtype:RecordTypeId:Name,Account:AccountId:Name -u siradrs2 -f
See code: src/commands/gem/data/etl.ts
sfdx gem:data:scratchOrgInit -c <string> [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
print a greeting and your org IDs
USAGE
$ sfdx gem:data:scratchOrgInit -c <string> [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-c, --externalkey=externalkey (required) object external Id field
reference
-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
EXAMPLES
$ sfdx gem:data:scratchOrgInit -u orgname -c checkin/checkout
$ sfdx gem:data:scratchOrgInit -u sirasandbox -c checkin
See code: src/commands/gem/data/scratchOrgInit.ts
sfdx gem:data:substitution -s <string> -t <string> -a <array> [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
print a greeting and your org IDs
USAGE
$ sfdx gem:data:substitution -s <string> -t <string> -a <array> [-f] [-v <string>] [-u <string>] [--apiversion
<string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-a, --objarray=objarray (required) object:Id of master
record
-f, --force example boolean flag
-s, --sourcedirectory=sourcedirectory (required) Source directory
-t, --targetdirectory=targetdirectory (required) Target directory
-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
EXAMPLES
$ sfdx gem:data:substitution -s sourcedirectory -t targetdirectory -a
object:FieldId:FieldName:PrefixSearch:SuffixSearch -f -u orgname
$ sfdx gem:data:substitution -s data/labelpackage/ -t labelpackage/labels/CustomLabels.labels -a
"Entitlement:Id:Name:<value>:</value>"
See code: src/commands/gem/data/substitution.ts
sfdx gem:data:uploadcontent [-m <string>] [-n <string>] [-r <array>] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
print a greeting and your org IDs
USAGE
$ sfdx gem:data:uploadcontent [-m <string>] [-n <string>] [-r <array>] [-f] [-v <string>] [-u <string>] [--apiversion
<string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-f, --updateflag Upload updated=true only
-m, --mappedfile=mappedfile mapped file
-n, --filename=filename file Name
-r, --recordlink=recordlink Salesforce object and unique field
api name
-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
EXAMPLES
$ sfdx gem:data:uploadcontent -n filename -r Object:FieldAPIName:FieldValue -u orgname --json
$ sfdx gem:data:uploadcontent -m ./data/map.json -f -u orgname --json
See code: src/commands/gem/data/uploadcontent.ts
sfdx gem:org:backsync -a <array> -o <string> -t <string> [-s <string>] [-d <array>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
print a greeting and your org IDs
USAGE
$ sfdx gem:org:backsync -a <array> -o <string> -t <string> [-s <string>] [-d <array>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-a, --accesstoken=accesstoken (required) git authentication:
token:access token or
basic:username:password
-d, --destinationbranch=destinationbranch destination branch name
-o, --option=option (required) options: backsync,single
-s, --sourcebranch=sourcebranch source branch name
-t, --type=type (required) types:
pullrequest,mergerequest
--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 gem:org:backsync -a basic:username:password -o single -t pullrequest -s sourcebranch -d destbranch
$ sfdx gem:org:backsync -a token:youraccesstoken -o backsync -t mergerequest
See code: src/commands/gem/org/backsync.ts
sfdx gem:org:branching -n <string> [-b <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
print a greeting and your org IDs
USAGE
$ sfdx gem:org:branching -n <string> [-b <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-b, --sourcebranch=sourcebranch Source branch
-n, --name=name (required) Branch name
--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 gem:org:branching -n branchname -b sourcebranch
See code: src/commands/gem/org/branching.ts
sfdx gem:org:create -u <array> [-d <number>] [-f] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
print a greeting and your org IDs
USAGE
$ sfdx gem:org:create -u <array> [-d <number>] [-f] [-v <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-d, --days=days Scratch org expiration
-f, --force example boolean flag
-u, --name=name (required) name to print
-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
EXAMPLES
$ sfdx gem:org:create -u orgname -d days
$ sfdx gem:org:create -u sconame -d 30
See code: src/commands/gem/org/create.ts
sfdx gem:org:deploy [-t <string>] [-d <string>] [-l <string>] [-r <string>] [-o <array>] [-i <array>] [-p] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
print a greeting and your org IDs
USAGE
$ sfdx gem:org:deploy [-t <string>] [-d <string>] [-l <string>] [-r <string>] [-o <array>] [-i <array>] [-p] [-v
<string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-d, --deploytype=deploytype Deployment options: deploy or
checkonly
-i, --include=include metadata to include
-l, --testoption=testoption test class options: NoTestRun or
RunLocalTests or RunSpecifiedTests
-o, --omit=omit metadata to omit
-p, --withpostdeployment Execute post deployment steps
-r, --testclass=testclass test classes comma separated
-t, --orgtype=orgtype Org Deployment Type: sandbox or
production
-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
EXAMPLES
$ sfdx gem:org:deploy -u orgname -t sandbox -d deploy
$ sfdx gem:org:deploy -u orgname -t sandbox -d deploy -o "path"
$ sfdx gem:org:deploy -u orgname -t sandbox -d deploy -i "force-app/path/tofile/"
$ sfdx gem:org:deploy -u orgname -o "force-app/drs/main/default/entitlementProcesses,force-app/ctp"
See code: src/commands/gem/org/deploy.ts
sfdx gem:org:diff -a <string> -b <string> [-t <string>] [-d <string>] [-l <string>] [-r <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
print a greeting and your org IDs
USAGE
$ sfdx gem:org:diff -a <string> -b <string> [-t <string>] [-d <string>] [-l <string>] [-r <string>] [-v <string>] [-u
<string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-a, --branch1name=branch1name (required) Target branch name to be
compare with
-b, --branch2name=branch2name (required) Local branch name to
compare
-d, --deploytype=deploytype Deployment options: deploy or
checkonly
-l, --testoption=testoption test class options: NoTestRun or
RunLocalTests or RunSpecifiedTests
-r, --testclass=testclass test classes comma separated
-t, --orgtype=orgtype Org Deployment Type: sandbox or
production
-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
EXAMPLES
$ sfdx gem:org:diff -a srcbranch -b targetbranch -u orgname -t sandbox -d checkonly
$ sfdx gem:org:diff -a srcbranch -b targetbranch -u orgname -t sandbox -d checkonly -l NoTestRun|RunLocalTests
$ sfdx gem:org:diff -a srcbranch -b targetbranch -u orgname -t production -d checkonly -l RunSpecifiedTests -r
"xxx_Test.cls"
$ sfdx gem:org:diff -a srcfeature -b targetfeature
See code: src/commands/gem/org/diff.ts
sfdx gem:org:disabledeliverability [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
print a greeting and your org IDs
USAGE
$ sfdx gem:org:disabledeliverability [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-f, --force example boolean flag
-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 gem:org:disabledeliverability -u orgname
See code: src/commands/gem/org/disabledeliverability.ts
sfdx gem:org:execaction [-t <string>] [-a <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
print a greeting and your org IDs
USAGE
$ sfdx gem:org:execaction [-t <string>] [-a <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json]
[--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-a, --actiontype=actiontype Action options: predeployment or
postdeployment
-t, --orgtype=orgtype Org Deployment Type: scratchorg or
sandbox or production
-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 gem:org:execaction -u orgname -t sandbox -a postdeployment
See code: src/commands/gem/org/execaction.ts
sfdx gem:org:push [-p] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
print a greeting and your org IDs
USAGE
$ sfdx gem:org:push [-p] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-f, --force example boolean flag
-p, --withpostdeployment Execute post deployment steps
-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 gem:org:push -u orgname -p
See code: src/commands/gem/org/push.ts
sfdx gem:org:sharedactivities [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
print a greeting and your org IDs
USAGE
$ sfdx gem:org:sharedactivities [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-f, --force example boolean flag
-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 gem:org:sharedactivities -u orgname
See code: src/commands/gem/org/sharedactivities.ts
sfdx gem:org:sharedcontacts [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
print a greeting and your org IDs
USAGE
$ sfdx gem:org:sharedcontacts [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-f, --force example boolean flag
-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 gem:org:sharedcontacts -u orgname
See code: src/commands/gem/org/sharedcontacts.ts
sfdx gem:org:sharequicktextfolders [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
print a greeting and your org IDs
USAGE
$ sfdx gem:org:sharequicktextfolders [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-f, --force example boolean flag
-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 gem:org:sharequicktextfolders -u orgname
See code: src/commands/gem/org/sharequicktextfolders.ts
sfdx gem:test:etasks [-t <string>] [-a <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
print a greeting and your org IDs
USAGE
$ sfdx gem:test:etasks [-t <string>] [-a <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json]
[--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-a, --actiontype=actiontype Actions: predeployment or prepush or
postdeployment
-t, --orgtype=orgtype Org Deployment Type: sandbox or
production
-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 gem:test:etasks -u orgname -t sandbox -a prepush
See code: src/commands/gem/test/etasks.ts
sfdx gem:test:org [-n <string>] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
print a greeting and your org IDs
USAGE
$ sfdx gem:test:org [-n <string>] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-f, --force example boolean flag
-n, --name=name name to print
-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
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/gem/test/org.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:
- 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-suspendAlternatively, 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!
