A Salesforce DX Plugin with multiple functionalities aimed at improving development and operational workflows Read the blog here https://accenture.github.io/blog/2019/06/27/sfpowerkit.html
To install the stable version from the release branch, use the following command
$ sfdx plugins:install sfpowerkit
If you need to install automatically the plugin, via a CI process or Dockerfile, use the following line:
$ echo 'y' | sfdx plugins:install sfpowerkit
Beta versions are the latest versions that are in being reviewed/ undergoing testing etc and built from the master branch and can be downloaded using the following command
$ sfdx plugins:install sfpowerkit@beta
To review a pull request (for contributors/reviewers), the best option is to clone the repository, checkout to the particular branch and utilize the following command from the project directory
$ sfdx plugins:link
These commands manipulate the metadata configuration/code locally or during the packaging process.
This command is a wrapper around PMD ( downloads PMD for the first time) with some predefined defaults, such as ruleset, output format, output file. The command is to be run from the project directory
USAGE
$ sfdx sfpowerkit:source:pmd [-d <string>] [-r <string>] [-f <string>] [-o <string>] [--javahome <string>] [--supressoutput] [--version <string> [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-d, --directory=directory [default: Default project directory as mentioned in sfdx-project.json ] Override this to set a different directory in the project folder
-f, --format=format [default: text] The format for the pmd output, Possible values are available at https://pmd.github.io/latest/pmd_userdocs_cli_reference.html#available-report-formats
-o, --report=report [default: pmd-output] The path to where the output of the analysis should be written
-r, --ruleset=ruleset [default: [sfpowerkit](https://github.com/Accenture/sfpowerkit/blob/master/resources/pmd-ruleset.xml)] The pmd ruleset that will be utilzied for analyzing the apex classes, Checkout https://pmd.github.io/pmd_userdocs_making_rulesets.html to create your own ruleset
--javahome=javahome The command will try to locate the javahome path to execute PMD automatically, set this flag to override it to another javahome path
--supressoutput [default: false] Supress the ouptut of the analysis to be displayed in the console
--version=version [default: 6.18.0] [default: 6.18.0] The version of the pmd to be utilized for the analysis, this version will be downloaded to sfpowerkit's cache directory
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for this command invocation
EXAMPLE
$ sfdx sfpowerkit:source:pmd
See code: src\commands\sfpowerkit\source\pmd.ts
Retrieve profiles from the salesforce org with all its associated permissions. Common use case for this command is to migrate profile changes from a integration environment to other higher environments [overcomes SFDX CLI Profile retrieve issue where it doesnt fetch the full profile unless the entire metadata is present in source], or retrieving profiles from production to lower environments for testing.
This command is of sufficient quality, however proceed with caution while adopting in your workflow
USAGE
$ sfdx sfpowerkit:source:profile:retrieve [-f <array>] [-n <array>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-f, --folder=folder retrieve only updated versions of profiles found in this directory, If ignored, all profiles will be retrieved.
-n, --profilelist=profilelist comma separated list of profiles to be retrieved. Use it for selectively retrieving an existing profile or retrieving a new profile
-d, --delete set this flag to delete profile files that does not exist in the org, when retrieving in bulk
-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 sfpowerkit:source:profile:retrieve -u prod
$ sfdx sfpowerkit:source:profile:retrieve -f force-app -n "My Profile" -u prod
$ sfdx sfpowerkit:source:profile:retrieve -f "module1, module2, module3" -n "My Profile1, My profile2" -u prod
See code: src\commands\sfpowerkit\profile\retrieve.ts
This command is used in the lower environments such as ScratchOrgs , Development / System Testing Sandboxes, where a retrieved profile from production has to be cleaned up only for the metadata that is contained in the environment or base it only as per the metadata that is contained in the packaging directory.
This command is of sufficient quality, however proceed with caution while adopting in your workflow
USAGE
$ sfdx sfpowerkit:source:profile:reconcile [-f <array>] [-n <array>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-f, --folder=folder path to the project folder, if the profiles are reconciled in source only mode
-d, --destfolder=destfolder the destination folder for reconciled profiles, if omitted existing profiles will be reconciled and will be rewritten in the current location
-n, --profilelist=profilelist list of profiles to be reconciled. If ommited, all the profiles components will be reconciled.
-s, --sourceonly set this flag to reconcile profiles only against component available in the project only. Configure ignored perissions in sfdx-project.json file in the array plugins->sfpowerkit->ignoredPermissions.
-u, --targetorg=targetorg org against which profiles will be reconciled. this parameter can be ommited if sourceonly flag is used.
--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 sfpowerkit:source:profile:reconcile --folder force-app -d destfolder -s
$ sfdx sfpowerkit:source:profile:reconcile --folder force-app,module2,module3 -u sandbox -d destfolder
$ sfdx sfpowerkit:source:profile:reconcile -u myscratchorg -d destfolder
See code: src\commands\sfpowerkit\profile\reconcile.ts
This command is used in the lower environments such as ScratchOrgs , Development / System Testing Sandboxes, inorder to apply the changes made in the environment to retrieved profile, so that it can be deployed to the higher environments
This command is of sufficient quality, however proceed with caution while adopting in your workflow
USAGE
$ sfdx sfpowerkit:source:profile:merge [-f <array>] [-n <array>] [-m <array>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-f, --folder=folder path to the folder which contains the profiles to be merged,if project contain multiple package directories, please provide a comma seperated list, if omitted, all the package directories will be checked for profiles
-m, --metadata=metadata comma separated list of metadata for which the permissions will be retrieved.
-n, --profilelist=profilelist comma separated list of profiles. If ommited, all the profiles found in the folder(s) will be merged
-d, --delete set this flag to delete profile files that does not exist in the org.
-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 sfpowerkit:source:profile:merge -u sandbox
$ sfdx sfpowerkit:source:profile:merge -f force-app -n "My Profile" -r -u sandbox
$ sfdx sfpowerkit:source:profile:merge -f "module1, module2, module3" -n "My Profile1, My profile2" -u sandbox
See code: src\commands\sfpowerkit\profile\merge.ts
Custom Labels are org wide, hence when the metadata is pulled down from scratch org, the entire custom label metadata file is pulled down in a package repo. This results in often packaging failures, when developers forget to clean the customlabels only to contain what the package needs, as unlocked package does not support duplicate items.The custom labels has to be then cleaned up per package.
This command is a helper command to create customlabel with pacakage names prepended for easy reconcilation.
USAGE
$ sfdx sfpowerkit:source:customlabel:create -n <string> -v <string> -s <string> [-c <string>] [-l <string>] [-p <string>] [-i] [-u <string>]
[--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-c, --categories=categories Comma Separated Category Values
-l, --language=language Language of the custom label (Default: en_US)
-n, --fullname=fullname (required) Name of the custom label (API Name)
-p, --protected=protected Protected State of the custom label (Default: false)
-s, --shortdescription=shortdescription (required) Short Description of the custom label
-u, --targetusername=targetusername username or alias for the target org; overrides default
target org
-v, --value=value (required) Value of the custom label
--package Name of the package that needs to be appended, omit this if ignore namespace is used
-i, --ignorepackage Ignores the addition of the namespace into the fullname
(API Name)
--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 sfpowerkit:source:customlabel:create -u fancyScratchOrg1 -n FlashError -v "Memory leaks aren't for the faint hearted" -s "A flashing
error" --package core
Created CustomLabel FlashError in target org with core_ prefix, You may now pull and utilize the customlabel:reconcile command
Custom Labels are org wide, hence when the metadata is pulled down from scratch org, the entire custom label metadata file is pulled down in a package repo. This results in often packaging failures, when developers forget to clean the customlabels only to contain what the package needs, as unlocked package does not support duplicate items.The custom labels has to be then cleaned up per package.
This command reconcile the updated custom labels to include only the labels that have the API name starting with package name (packagename_ ) or created using the custom label create command
USAGE
$ sfdx sfpowerkit:source:customlabel:reconcile -d <string> -p <string> [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-d, --path=path (required) Path to the CustomLabels.labels-meta.xml file
-p, --package (required) Name of the package
--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 sfpowerkit:source:customlabel:reconcile -p path/to/customlabelfile.xml -d core
Package ::: core
Reconciled The Custom Labels, only to have core labels (labels with full name beginning with core_)
``
Converts an apex test suite to its consituent apex classes as a single line separated by commas, so that it can be used along with metadata validate only deployment
USAGE
$ sfdx sfpowerkit:source:apextestsuite:convert -n <string> [ -p <string> ] [ -o <string> ] [--json] [--loglevel trace|debug|info|warn|error|fatal]
OPTIONS
-n, --name=name (required) the name of the apextestsuite (the file name minus the apex test suite)
-p, --package=package [default:picks up the default package] The package where the apex test suite exists
-o, --pathoverride=pathoverride [default:/main/default] Use this if your path to test suite is in a different folder location
within the package directory
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this command invocation
EXAMPLE
$ sfdx sfpowerkit:source:apextestsuite:convert -n MyApexTestSuite
"ABC2,ABC1Test"
Generate a delta 'changeset' between two diff commits so that the incremental changes can be deployed to the target org.To be used for an org based deployment when the size of the metadata is large that the project cannot not be deployed in a single attempt.
This command works with a source format based repository only. Utilize the command during a transition phase where an org is transformed to a modular architecture composing of multiple projects.
USAGE
$ sfdx sfpowerkit:project:diff -d <string> [-f <string>] [ -e <string> ] [ -r <string> ] [ -t <string> ] [--json] [--loglevel trace|debug|info|warn|error|fatal]
OPTIONS
-d, --output=output (required) The output dir where the incremental project will be created
-f, --difffile=difffile The diff file from which the incremental project should be generated [git diff --raw]. Its an optional parameter, you can skip this parameter and set the revisionfrom and revisionto parameter instead
-e, --encoding=encoding [default:utf8] Diff file encoding
-r, --revisionfrom=revisionfrom Base revision from where diff is to be generated, required if diff file is ommited
-t, --revisionto=revisionto [default:HEAD]Target revision to generate the diff
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this command invocation
EXAMPLE
$ sfdx sfpowerkit:project:diff --revisionfrom revisionfrom --revisionto revisionto --output OutputFolder
{
"status": 0,
"result": {
"deleted": [],
"addedEdited": [
"scripts\\Alias.sh",
"sfdx-project.json",
]
}
}
Various helper commands in aiding with Salesforce DX Unlocked Package Development
Install unlocked package dependencies of a package
USAGE
$ sfdx sfpowerkit:package:dependencies:install [-p <string>] [-k <string>] [-b <string>] [-w <string>] [-r] [-v
<string>] [-a] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]
OPTIONS
-b, --branch=branch the package version’s branch
-k, --installationkeys=installationkeys installation key for key-protected packages (format is
1:MyPackage1Key 2: 3:MyPackage3Key... to allow some packages without
installation key)
-p, --individualpackage=individualpackage Installs a specific package especially for upgrade scenario
-r, --noprompt allow Remote Site Settings and Content Security Policy websites to
send or receive data without confirmation
-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
-w, --wait=wait number of minutes to wait for installation status (also used for
publishwait). Default is 10
-a, --apexcompileonlypackage=apexcompileonlypackage Compile the apex only in the package, by default only the
compilation of the apex in the entire org is triggered
--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) [default: warn] logging level for this command invocation
EXAMPLE
$ sfpowerkit package:dependencies:install -u MyScratchOrg -v MyDevHub -k "1:MyPackage1Key 2: 3:MyPackage3Key" -b "DEV"
See code: src\commands\sfpowerkit\package\dependencies\install.ts
This command generates a patch in the format of a metadata packed together as a static resource with the intent of solving the following issues.
- Changes to picklist values are not updated in the target org through a unlocked package upgrade.
- Standard Value are non packageable, hence any picklist that has a modified standardvalueset as the controlling field will fail to package, The optional fixstandardvalueset flag will strip of the controlling field and puts the original code into the patch
- Fix for business process and recordtype, that depend on a modified standard valueset and fail to package.
These command is to be run just before the package:version: create command and any changes made by the command should not be committed to the repo. Once a patch is generated and the package is installed in the target org, run the apply patch command tofix the above issues.
USAGE
$ sfdx sfpowerkit:source:picklist:generatepatch [-p <string>] [-d <string>] [-f <boolean>] [-r <boolean>]
OPTIONS
-d, --objectsdir=objectsdir Path for Objects folder located in project
-p, --package=package Name of the package to generate the picklist
patch
-f, --fixstandardvalueset Consider patching for standard value set controlled picklists, Warning: This modifies the source code in your package by removing references to standardvalueset from the particular picklist.
-m. --mmovestandardvalueset Consider patching for standard valueset inside source repo, Warning: This modifies the source code in your package
-r, --fixrecordtypes Consider patching for standard value set in RecordTypes, Warning: This modifies the source code in your package
--apiversion=apiversion The api version to be used for the static resource to be generated
EXAMPLE
sfdx sfpowerkit:source:picklist:generatepatch -p sfpowerkit_test -d force-app/main/default/objects/ -f
Scanning for fields of type picklist
Found 2 fields of type picklist
Processing and adding the following fields to patch
Copied Original to Patch: force-app\main\default\objects\Case\fields\test_standard2__c.field-meta.xml
Modified Original in Packaging: force-app\main\default\objects\Case\fields\test_standard2__c.field-meta.xml
Copied Original to Patch: force-app\main\default\objects\Case\fields\test_standard__c.field-meta.xml
Added 2 fields of field type picklist into patch after'removing fields picklist fields in cmdt objects
Added 1 fields of field type picklist that have standard value sets as controlling types
Source was successfully converted to Metadata API format and written to the location: C:\Projects\sfpowerkit_test\temp_sfpowerkit\mdapi
Generating static resource file : force-app/main/default/staticresources/sfpowerkit_test_picklist.resource-meta.xml
Patch sfpowerkit_test_picklist generated successfully.
See code: src\commands\sfpowerkit\source\picklist\generatepatch.ts
Search permissionsets inside project and create a static resource file with permissionsets, used to solve the recordtype assignment upgrade issue in dx unlock package
USAGE
$ sfdx sfpowerkit:source:permissionset:generatepatch [-p <string>] [-d <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-d, --permsetdir=permsetdir Path for permissionset folder located in project
-p, --package=package Name of the package to generate the permissionset patch
--apiversion=apiversion The api version to be used for the static resource to be generated
--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 sfpowerkit:source:permissionset:generatepatch -p Core -d src/core/main/default/permissionsets
Scanning for permissionsets
Found 30 permissionsets
Source was successfully converted to Metadata API format and written to the location: .../temp_sfpowerkit/mdapi
Generating static resource file : src/core/main/default/staticresources/Core_permissionsets.resource-meta.xml
Patch Core_permissionsets generated successfully.
See code: src\commands\sfpowerkit\source\permissionset\generatepatch.ts
Retrieves and applies the patch, This command is exclusively used to apply the patched created by the generatepatch command, see source: picklist:generatepatch and source:permissionset:generatepatch. The command will download the static reource (collection of patched metadata) from the target org, unzips and apply to the target org using mdapi
USAGE
$ sfdx sfpowerkit:package:applypatch -n <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-n, --name=name (required) Name of the static resource to be patched
-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 sfpowerkit:package:applypatch -n customer_picklist -u sandbox
Preparing Patch
Deploying Patch with ID 0Af4Y000003Q7GySAK
Polling for Deployment Status
Polling for Deployment Status
Patch customer_picklist Deployed successfully.
See code: src\commands\sfpowerkit\package\applypatch.ts
Validates a package directory to check whether it only contains valid metadata as per metadata coverage
USAGE
$ sfdx sfpowerkit:package:valid [-n <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]
OPTIONS
-b, --bypass=bypass metadatatypes to skip the package validation check
-n, --package=package the package to analyze
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this command invocation
EXAMPLE
$ sfdx sfpowerkit:package:valid -n testPackage -b sharingrules,sharingownerrule
Now analyzing testPackage
Converting package testPackage
Source was successfully converted to Metadata API format and written to the location:
D:projects estPackage emp_sfpowerkitmdapi
Elements supported included in your package testPackage are
AuraDefinitionBundle
CustomApplication
ApexClass
ContentAsset
WorkflowRule
--------------------------------------------------------------------------------
Unsupported elements to bypass in your package sample are
sharingrules
sharingownerrule
--------------------------------------------------------------------------------
See code: src\commands\sfpowerkit\package\valid.ts
These commands are helpful in managing functionalities are related to a Salesforce Org
Creates a connected app in the target org for JWT based authentication, Please note it only creates Connected App with All users may self authorize option, You would need to manually edit the policies to enable admin users are pre-approved and add your profile to this connected app. API, Web and RefreshToken Scope are added to every app that is being created.
USAGE
$ sfdx sfpowerkit:org:connectedapp:create -n <string> -c <filepath> -e <email> [-u <string>] [--apiversion
<string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]
OPTIONS
-c, --pathtocertificate=pathtocertificate (required) Filepath to the private certificate for the connected app
to be created
-e, --email=email (required) Email of the connected app to be created
-n, --name=name (required) Name of the connected app to be created
-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) [default: warn] logging level for this command invocation
EXAMPLE
$ sfdx sfpowerkit:org:connectedapp:create -u myOrg@example.com -n AzurePipelines -c id_rsa -e
azlam.salamm@invalid.com
Created Connected App AzurePipelines in Target Org
See code: src\commands\sfpowerkit\org\connectedapp\create.ts
Useful if you want to retreive a connected app key especially in CI/CD system after a sandbox refresh. Use the auth command to login to the sandbox and then use this command. Use JSON format if you want to retrieve the entire metadata of the connected app, Without the json flag, it only displays the key
USAGE
$ sfdx sfpowerkit:org:connectedapp:retrieve -n <string> -u <string> [-r <url>] [--json] [--loglevel trace|debug|info|warn|error|fatal]
OPTIONS
-n, --name=name (required) Name of the connected app to be
retreived
-u, --targetusername=targetusername username or alias for the target org; overrides default target org
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this
command invocation
EXAMPLE
$ sfdx sfpowerkit:org:connectedapp:retrieve -u azlam@sfdc.com -p Xasdax2w2 -n
AzurePipelines
Retrived AzurePipelines Consumer Key : XSD21Sd23123w21321
See code: src\commands\sfpowerkit\org\connectedapp\retrieve.ts
Deactivates a duplicate rule in the target org. Deactivate active rules before pushing the changes to the target org
USAGE
$ sfdx sfpowerkit:org:duplicaterule:deactivate -n <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-n, --name=name (required) Name of the duplicate rule
-u, --targetusername=targetusername username or alias for the target org; overrides default target org
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this
command invocation
EXAMPLE
$ sfdx sfpowerkit:org:duplicaterule:deactivate -n Account.CRM_Account_Rule_1 -u sandbox
Polling for Retrieval Status
Retrieved Duplicate Rule with label : CRM Account Rule 2
Preparing Deactivation
Deploying Deactivated Rule with ID 0Af4Y000003OdTWSA0
Polling for Deployment Status
Polling for Deployment Status
Duplicate Rule CRM Account Rule 2 deactivated
See code: src\commands\sfpowerkit\org\duplicaterule\deactivate.ts
Activates a matching rule in the target org
USAGE
$ sfdx sfpowerkit:org:duplicaterule:activate -n <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-n, --name=name (required) Name of the duplicate rule
-u, --targetusername=targetusername username or alias for the target org; overrides default target org
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this
command invocation
EXAMPLE
$ sfdx sfpowerkit:org:duplicaterule:activate -n Account.CRM_Account_Rule_1 -u sandbox
Polling for Retrieval Status
Retrieved Duplicate Rule with label : CRM Account Rule 2
Preparing Activation
Deploying Activated Rule with ID 0Af4Y000003OdTWSA0
Polling for Deployment Status
Polling for Deployment Status
Duplicate Rule CRM Account Rule 2 Activated
See code: src\commands\sfpowerkit\org\duplicaterule\activate.ts
Deactivates a matching rule in the target org, Please ensure all duplicate rules are deactivated before using this
USAGE
$ sfdx sfpowerkit:org:matchingrule:deactivate -n <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-n, --name=name (required) Name of the object
-u, --targetusername=targetusername username or alias for the target org; overrides default target org
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this
command invocation
EXAMPLE
$ sfdx sfpowerkit:org:matchingrule:deactivate -n Account -u sandbox
Polling for Retrieval Status
Retrieved Matching Rule for Object : Account
Preparing Deactivation
Deploying Deactivated Matching Rule with ID 0Af4Y000003OePkSAK
Polling for Deployment Status
Polling for Deployment Status
Matching Rule for Account deactivated
See code: src\commands\sfpowerkit\org\matchingrule\deactivate.ts
Activates a matching rule in the target org, Please ensure all duplicate rules are activated before using this
USAGE
$ sfdx sfpowerkit:org:matchingrule:activate -n <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-n, --name=name (required) Name of the object
-u, --targetusername=targetusername username or alias for the target org; overrides default target org
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this
command invocation
EXAMPLE
$ sfdx sfpowerkit:org:matchingrules:activate -n Account -u sandbox
Polling for Retrieval Status
Retrieved Matching Rule for Object : Account
Preparing Activation
Deploying Activated Rule with ID 0Af4Y000003OdTWSA0
Polling for Deployment Status
Polling for Deployment Status
Matching Rule for Account activated
See code: src\commands\sfpowerkit\org\matchingrule\activate.ts
Deactivates a trigger in the target org
USAGE
$ sfdx sfpowerkit:org:trigger:deactivate -n <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-n, --name=name (required) Name of the ApexTrigger
-u, --targetusername=targetusername username or alias for the target org; overrides default target org
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this
command invocation
EXAMPLE
$ sfdx sfpowerkit:org:trigger:deactivate -n AccountTrigger -u sandbox
Polling for Retrieval Status
Preparing Deactivation
Deploying Deactivated ApexTrigger with ID 0Af4Y000003Q7GySAK
Polling for Deployment Status
Polling for Deployment Status
ApexTrigger AccountTrigger deactivated
See code: src\commands\sfpowerkit\org\trigger\deactivate.ts
Activates a trigger in the target org
USAGE
$ sfdx sfpowerkit:org:trigger:activate -n <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-n, --name=name (required) Name of the ApexTrigger
-u, --targetusername=targetusername username or alias for the target org; overrides default target org
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this
command invocation
EXAMPLE
$ sfdx sfpowerkit:org:trigger:deactivate -n AccountTrigger -u sandbox
Polling for Retrieval Status
Preparing Activation
Deploying Activated ApexTrigger with ID 0Af4Y000003Q7GySAK
Polling for Deployment Status
Polling for Deployment Status
ApexTrigger AccountTrigger Ativated
See code: src\commands\sfpowerkit\org\trigger\activate.ts
Gets the health details of an org against the Salesforce baseline
USAGE
$ sfdx sfpowerkit:org:healthcheck [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal]
OPTIONS
-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) [default: warn] logging level for this command invocation
EXAMPLE
$ sfdx sfpowerkit:org:healthcheck -u myOrg@example.com
Successfully Retrived the healthstatus of the org
See code: src\commands\sfpowerkit\org\healthcheck.ts
Generate a complete manifest of all the metadata from the specified org. Once the manifest is generated use source:retrieve or mdapi:retrieve to retrieve the metadata.
This command is of sufficient quality, however proceed with caution while adopting in your workflow
USAGE
$ sfdx sfpowerkit:org:manifest:build [-q <string>] [-x] [-o <filepath>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]
OPTIONS
-o, --outputfile=outputfile The output path where the manifest file will be created
-q, --quickfilter=quickfilter comma separated values of metadata type, member or file names to be excluded while building the manifest
-u, --targetusername=targetusername username or alias for the target org; overrides default
target org
-x, --excludemanaged exclude managed packages components from the manifest
--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 sfpowerkit:org:manifest:build --targetusername myOrg@example.com -o package.xml
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">...</Package>
$ sfdx sfpowerkit:org:manifest:build --targetusername myOrg@example.com -o package.xml -q 'ApexClass, CustomObject, Report'
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">...</Package>
See code: src\commands\sfpowerkit\org\manifest\build.ts
Gets the apex tests coverage of an org
USAGE
$ sfdx sfpowerkit:org:orgcoverage [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal]
OPTIONS
-u, --targetusername=targetusername username or alias for the 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) [default: warn] logging level for this command invocation
EXAMPLE
$ sfdx sfpowerkit:org:orgcoverage -u myOrg@example.com
Successfully Retrieved the Apex Test Coverage of the org 00D0k000000DmdpEAC
coverage:85
See code: src\commands\sfpowerkit\org\orgcoverage.ts
Creates a sandbox using the tooling api, ensure the user has the required permissions before using this command
USAGE
$ sfdx sfpowerkit:org:sandbox:create -n <string> -d <string> -l <string> [-a <string>] [-f <string>] [-v
<string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]
OPTIONS
-a, --apexclass=apexclass A reference to the ID of an Apex class that runs after each
copy of the sandbox
-d, --description=description (required) Description of the sandbox
-f, --clonefrom=clonefrom A reference to the ID of a SandboxInfo that serves as the
source org for a cloned sandbox.
-l, --licensetype=DEVELOPER|DEVELOPER_PRO|PARTIAL|FULL (required) Type of the sandbox. Valid values are
DEVELOPER,DEVELOPER_PRO,PARTIAL,FULL
-n, --name=name (required) Name of the sandbox
-v, --targetdevhubusername=targetdevhubusername (required) 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) [default: warn] logging level for this command invocation
EXAMPLE
$ sfdx sfpowerkit:org:sandbox:create -d Testsandbox -l DEVELOPER -n test2 -v myOrg@example.com
Successfully Enqueued Creation of Sandbox
See code: src\commands\sfpowerkit\org\sandbox\create.ts
Gets the status of a sandbox
USAGE
$ sfdx sfpowerkit:org:sandbox:info -n <string> [-s] [-v <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal]
OPTIONS
-n, --name=name (required) Name of the sandbox
-s, --showonlylatest Shows only the latest info of the sandbox record
-v, --targetdevhubusername=targetdevhubusername (required) 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) [default: warn] logging level for this command invocation
EXAMPLE
$ sfdx sfpowerkit:org:sandbox:info -n test2 -u myOrg@example.com
Successfully Enqueued Refresh of Sandbox
See code: src\commands\sfpowerkit\org\sandbox\info.ts
Refresh a sandbox using the tooling api, ensure the user has the required permissions before using this command
USAGE
$ sfdx sfpowerkit:org:sandbox:refresh -n <string> [-f <string>] [-v <string>] [--apiversion <string>] [--json]
[--loglevel trace|debug|info|warn|error|fatal]
OPTIONS
-f, --clonefrom=clonefrom A reference to the ID of a SandboxInfo that serves as the source org
for a cloned sandbox.
-n, --name=name (required) Name of the sandbox
-v, --targetdevhubusername=targetdevhubusername (required) 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) [default: warn] logging level for this command invocation
EXAMPLE
$ sfdx sfpowerkit:org:sandbox:refresh -n test2 -f sitSandbox -u myOrg@example.com
Successfully Enqueued Refresh of Sandbox
See code: src\commands\sfpowerkit\org\sandbox\refresh.ts
Gets the active count of scratch org by users in a devhub
USAGE
$ sfdx sfpowerkit:org:scratchorg:usage -v <string>
[--loglevel trace|debug|info|warn|error|fatal]
OPTIONS
-v, --targetdevhubusername=targetdevhubusername (required) username or alias for the dev hub org; overrides default dev hub org
EXAMPLE
$ sfdx sfpowerkit:org:scratchorg:usage -v devhub
Active Scratch Orgs Remaining: 42 out of 100
Daily Scratch Orgs Remaining: 171 out of 200
IN_USE SIGNUPEMAIL
───────────────── ─────────────────
2 XYZ@KYZ.COM
2 JFK@KYZ.COM
Total number of records retrieved: 4.
See code: src\commands\sfpowerkit\org\scratchorg\usage.ts
Delete the scratch org for a paritcular user
USAGE
$ sfdx sfpowerkit:org:scratchorg:delete -v <string> -e <string>
[--loglevel trace|debug|info|warn|error|fatal]
OPTIONS
-v, --targetdevhubusername=targetdevhubusername (required) username or alias for the dev hub org; overrides default dev hub org
-e, --email=email (required) Email of the user account's whose scratch org to be deleted
EXAMPLE
$ sfdx sfpowerkit:org:scratchorg:delete -e xyz@kyz.com -v devhub
Found Scratch Org Ids for user xyz@kyz.com
2AS6F000000XbxVWAS
Deleting Scratch Orgs
Deleted Scratch Org 2AS6F000000XbxVWAS
See code: src\commands\sfpowerkit\org\scratchorg\usage.ts
Allows to authenticate against an org using username/password and Security Token. Security Token requirement can be removed by ensuring the particular user profile is allowed to connect to Salesforce from different IP ranges.
USAGE
$ sfdx sfpowerkit:auth:login -u <string> -p <string> [-s <string>] [ -r <url> ] [-a <string>] [--apiversion
<string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]
OPTIONS
-u, --username=username (required) Username of the org
-p, --password=password (required) Password of the org
-r, --url=url URL of the org, by default it points to test.salesforce.com
-s --securitytoken=securitytoken Security Token for this particular user
-a, --alias=alias alias for the 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) [default: warn] logging level for this command invocation
EXAMPLE
$ sfdx sfpowerkit:auth:login -u azlam@sfdc.com -p Xasdax2w2 -a prod
Authorized to azlam@sfdc.com