diff --git a/CHANGELOG.md b/CHANGELOG.md index 4ac332577..d656f2bff 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,8 @@ Note: Can be used with `sfdx plugins:install sfdx-hardis@beta` and docker image `hardisgroupcom/sfdx-hardis@beta` +## [4.13.0] 2023-11-19 + - Monitoring - Display package.xml content in logs when backup failed - Update default **package-skip-items.xml** diff --git a/README.md b/README.md index 1db2ff4ff..f1f8b884e 100644 --- a/README.md +++ b/README.md @@ -148,6 +148,3934 @@ Anyone is welcome to contribute to this sfdx-hardis * [`sfdx hardis:config:get [-l ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisconfigget--l-string--d---websocket-string---skipauth---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) * [`sfdx hardis:doc:extract:permsetgroups [-o ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisdocextractpermsetgroups--o-string--d---websocket-string---skipauth---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) * [`sfdx hardis:doc:plugin:generate [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisdocplugingenerate--d---websocket-string---skipauth---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:lint:access [-e ] [-i ] [-f ] [-o ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardislintaccess--e-string--i-string--f-string--o-string--d---websocket-string---skipauth---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:lint:unused [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardislintunused--d---websocket-string---skipauth---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:mdapi:deploy [-d ] [-w ] [-q | -l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r | -o | -g | -c] [-f ] [-s] [--soapdeploy] [--purgeondelete] [--debug] [--websocket ] [-u ] [--apiversion ] [--verbose] [--concise] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardismdapideploy--d-directory--w-minutes--q-id---l-notestrunrunspecifiedtestsrunlocaltestsrunalltestsinorg---r-array---o---g---c--f-filepath--s---soapdeploy---purgeondelete---debug---websocket-string--u-string---apiversion-string---verbose---concise---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:misc:toml2csv -f [-t ] [-l ] [-s] [-o ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardismisctoml2csv--f-string--t-string--l-array--s--o-string--d---websocket-string---skipauth--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:org:configure:data [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisorgconfiguredata--d---websocket-string---skipauth---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:org:configure:files [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisorgconfigurefiles--d---websocket-string---skipauth---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:org:configure:monitoring [--orginstanceurl ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisorgconfiguremonitoring---orginstanceurl-string--d---websocket-string---skipauth--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:org:connect [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisorgconnect--d---websocket-string---skipauth---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:org:create [-d] [--websocket ] [--skipauth] [-v ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisorgcreate--d---websocket-string---skipauth--v-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:org:data:delete [-p ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisorgdatadelete--p-string--d---websocket-string---skipauth--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:org:data:export [-p ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisorgdataexport--p-string--d---websocket-string---skipauth--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:org:data:import [-p ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisorgdataimport--p-string--d---websocket-string---skipauth--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:org:diagnose:audittrail [-e ] [-t ] [-o ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisorgdiagnoseaudittrail--e-string--t-number--o-string--d---websocket-string---skipauth--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:org:diagnose:legacyapi [-e ] [-l ] [-o ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisorgdiagnoselegacyapi--e-string--l-number--o-string--d---websocket-string---skipauth--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:org:files:export [-p ] [-c ] [-t ] [-s ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisorgfilesexport--p-string--c-number--t-number--s-number--d---websocket-string---skipauth--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:org:fix:listviewmine [-l ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisorgfixlistviewmine--l-string--d---websocket-string---skipauth--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:org:generate:packagexmlfull [--outputfile ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisorggeneratepackagexmlfull---outputfile-string--d---websocket-string---skipauth--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:org:monitor:all [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisorgmonitorall--d---websocket-string---skipauth--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:org:monitor:backup [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisorgmonitorbackup--d---websocket-string---skipauth--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:org:purge:apexlog [-z] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisorgpurgeapexlog--z--d---websocket-string---skipauth--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:org:purge:flow [-z] [-n ] [-s ] [-f] [-r ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisorgpurgeflow--z--n-string--s-string--f--r-string--d---websocket-string---skipauth--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:org:retrieve:packageconfig [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisorgretrievepackageconfig--d---websocket-string---skipauth--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:org:retrieve:sources:analytics [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisorgretrievesourcesanalytics--d---websocket-string---skipauth--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:org:retrieve:sources:dx [-f ] [-t ] [-k ] [-m ] [-o] [-r ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisorgretrievesourcesdx--f-string--t-string--k-string--m-string--o--r-string--d---websocket-string---skipauth--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:org:retrieve:sources:dx2 [-x ] [-t ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisorgretrievesourcesdx2--x-string--t-string--d---websocket-string---skipauth--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:org:retrieve:sources:metadata [-f ] [-p ] [--includemanaged] [-r ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisorgretrievesourcesmetadata--f-string--p-string---includemanaged--r-string--d---websocket-string---skipauth--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:org:retrieve:sources:retrofit [--commit] [--commitmode updated|all] [--push] [--pushmode default|mergerequest] [--productionbranch ] [--retrofittargetbranch ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisorgretrievesourcesretrofit---commit---commitmode-updatedall---push---pushmode-defaultmergerequest---productionbranch-string---retrofittargetbranch-string--d---websocket-string---skipauth--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:org:select [-h] [-s] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisorgselect--h--s--d---websocket-string---skipauth---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:org:test:apex [-l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisorgtestapex--l-notestrunrunspecifiedtestsrunlocaltestsrunalltestsinorg--d---websocket-string---skipauth--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:org:user:activateinvalid [-p ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisorguseractivateinvalid--p-string--d---websocket-string---skipauth--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:org:user:freeze [-n ] [-p ] [-e ] [-m ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisorguserfreeze--n-string--p-string--e-string--m-number--d---websocket-string---skipauth--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:org:user:unfreeze [-n ] [-p ] [-e ] [-m ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisorguserunfreeze--n-string--p-string--e-string--m-number--d---websocket-string---skipauth--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:package:create [-d] [--websocket ] [--skipauth] [-v ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardispackagecreate--d---websocket-string---skipauth--v-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:package:install [-p ] [-d] [--websocket ] [-k ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardispackageinstall--p-string--d---websocket-string--k-string---skipauth--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:package:mergexml [-f ] [-p ] [-x ] [-r ] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardispackagemergexml--f-string--p-string--x-string--r-string---websocket-string---skipauth---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:package:version:create [-d] [-p ] [-k ] [--deleteafter] [-i] [--websocket ] [--skipauth] [-v ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardispackageversioncreate--d--p-string--k-string---deleteafter--i---websocket-string---skipauth--v-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:package:version:list [-d] [--websocket ] [--skipauth] [-v ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardispackageversionlist--d---websocket-string---skipauth--v-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:package:version:promote [-d] [-d] [--websocket ] [--skipauth] [-v ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardispackageversionpromote--d--d---websocket-string---skipauth--v-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:project:audit:apiversion [-m ] [-f] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisprojectauditapiversion--m-number--f--d---websocket-string---skipauth---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:project:audit:callincallout [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisprojectauditcallincallout--d---websocket-string---skipauth---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:project:audit:duplicatefiles [-p ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisprojectauditduplicatefiles--p-string--d---websocket-string---skipauth---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:project:audit:remotesites [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisprojectauditremotesites--d---websocket-string---skipauth---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:project:clean:emptyitems [-f ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisprojectcleanemptyitems--f-string--d---websocket-string---skipauth---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:project:clean:hiddenitems [-f ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisprojectcleanhiddenitems--f-string--d---websocket-string---skipauth---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:project:clean:listviews [-f ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisprojectcleanlistviews--f-string--d---websocket-string---skipauth---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:project:clean:manageditems [-n ] [-f ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisprojectcleanmanageditems--n-string--f-string--d---websocket-string---skipauth---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:project:clean:minimizeprofiles [-f ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisprojectcleanminimizeprofiles--f-string--d---websocket-string---skipauth---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:project:clean:orgmissingitems [-f ] [-p ] [-t ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisprojectcleanorgmissingitems--f-string--p-string--t-string--d---websocket-string---skipauth---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:project:clean:references [-t ] [-c ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisprojectcleanreferences--t-string--c-string--d---websocket-string---skipauth---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:project:clean:retrievefolders [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisprojectcleanretrievefolders--d---websocket-string---skipauth--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:project:clean:standarditems [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisprojectcleanstandarditems--d---websocket-string---skipauth---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:project:clean:systemdebug [-f ] [--websocket ] [--skipauth] [-d] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisprojectcleansystemdebug--f-string---websocket-string---skipauth--d---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:project:clean:xml [-f ] [-p -x ] [-n ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisprojectcleanxml--f-string--p-string--x-string--n-string--d---websocket-string---skipauth---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:project:configure:auth [-b] [-d] [--websocket ] [--skipauth] [-v ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisprojectconfigureauth--b--d---websocket-string---skipauth--v-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:project:convert:profilestopermsets [-e ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisprojectconvertprofilestopermsets--e-array--d---websocket-string---skipauth---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:project:create [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisprojectcreate--d---websocket-string---skipauth---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:project:deploy:sources:dx [-c] [-l NoTestRun|RunSpecifiedTests|RunRepositoryTests|RunLocalTests|RunAllTestsInOrg] [-r ] [-p ] [--delta] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisprojectdeploysourcesdx--c--l-notestrunrunspecifiedtestsrunrepositorytestsrunlocaltestsrunalltestsinorg--r-string--p-string---delta--d---websocket-string---skipauth--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:project:deploy:sources:metadata [-c] [-x ] [-p ] [-f] [-k ] [-l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisprojectdeploysourcesmetadata--c--x-string--p-string--f--k-string--l-notestrunrunspecifiedtestsrunlocaltestsrunalltestsinorg--d---websocket-string---skipauth--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:project:fix:v53flexipages [-p ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisprojectfixv53flexipages--p-string--d---websocket-string---skipauth---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:project:generate:gitdelta [--branch ] [--fromcommit ] [--tocommit ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisprojectgenerategitdelta---branch-string---fromcommit-string---tocommit-string--d---websocket-string---skipauth---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:project:lint [-f] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisprojectlint--f--d---websocket-string---skipauth--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:project:metadata:findduplicates [-f ] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisprojectmetadatafindduplicates--f-array---websocket-string---skipauth---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:scratch:create [-n] [-d] [-d] [--websocket ] [--skipauth] [-v ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisscratchcreate--n--d--d---websocket-string---skipauth--v-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:scratch:delete [-d] [--websocket ] [--skipauth] [-v ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisscratchdelete--d---websocket-string---skipauth--v-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:scratch:pool:create [-d] [--websocket ] [--skipauth] [-v ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisscratchpoolcreate--d---websocket-string---skipauth--v-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:scratch:pool:localauth [-d] [--websocket ] [--skipauth] [-v ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisscratchpoollocalauth--d---websocket-string---skipauth--v-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:scratch:pool:refresh [-d] [--websocket ] [--skipauth] [-v ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisscratchpoolrefresh--d---websocket-string---skipauth--v-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:scratch:pool:reset [-d] [--websocket ] [--skipauth] [-v ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisscratchpoolreset--d---websocket-string---skipauth--v-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:scratch:pool:view [-d] [--websocket ] [--skipauth] [-v ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisscratchpoolview--d---websocket-string---skipauth--v-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:scratch:pull [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisscratchpull--d---websocket-string---skipauth--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:scratch:push [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisscratchpush--d---websocket-string---skipauth--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:source:deploy [--soapdeploy] [-w ] [--predestructivechanges ] [--postdestructivechanges ] [-f [-t | | [-q | -x | -m | -p | -c | -l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r | -o | -g]]] [--resultsdir ] [--coverageformatters ] [--junit] [--checkcoverage] [--debug] [--websocket ] [-u ] [--apiversion ] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardissourcedeploy---soapdeploy--w-minutes---predestructivechanges-filepath----postdestructivechanges-filepath---f--t-----q-id---x-filepath---m-array---p-array---c---l-notestrunrunspecifiedtestsrunlocaltestsrunalltestsinorg---r-array---o---g---resultsdir-directory---coverageformatters-array---junit---checkcoverage---debug---websocket-string--u-string---apiversion-string---verbose---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:source:push [-f] [-w ] [-g] [--debug] [--websocket ] [-u ] [--apiversion ] [--quiet] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardissourcepush--f--w-minutes--g---debug---websocket-string--u-string---apiversion-string---quiet---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:source:retrieve [-p | -x | -m ] [-w ] [-n ] [-f -t] [-d] [--websocket ] [--skipauth] [-u ] [-a ] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardissourceretrieve--p-array---x-filepath---m-array--w-minutes--n-array--f--t--d---websocket-string---skipauth--u-string--a-string---verbose---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:work:new [-d] [--websocket ] [--skipauth] [-v ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisworknew--d---websocket-string---skipauth--v-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:work:refresh [-n] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisworkrefresh--n--d---websocket-string---skipauth--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:work:resetselection [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisworkresetselection--d---websocket-string---skipauth--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:work:save [-n] [-g] [-c] [--auto] [--targetbranch ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisworksave--n--g--c---auto---targetbranch-string--d---websocket-string---skipauth--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:work:ws [-e ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisworkws--e-string--d---websocket-string---skipauth---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) + +## `sfdx hardis:auth:login [-r ] [-h] [-s] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Login to salesforce org + +``` +USAGE + $ sfdx hardis:auth:login [-r ] [-h] [-s] [-d] [--websocket ] [--skipauth] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + -h, --devhub Also connect associated DevHub + -r, --instanceurl=instanceurl URL of org instance + -s, --scratchorg Scratch org + --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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLE + $ sfdx hardis:auth:login +``` + +_See code: [lib/commands/hardis/auth/login.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/auth/login.js)_ + +## `sfdx hardis:cache:clear [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Clear cache generated by sfdx-hardis + +``` +USAGE + $ sfdx hardis:cache:clear [-d] [--websocket ] [--skipauth] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + --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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLE + $ sfdx hardis:cache:clear +``` + +_See code: [lib/commands/hardis/cache/clear.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/cache/clear.js)_ + +## `sfdx hardis:config:get [-l ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Returns sfdx-hardis project config for a given level + +``` +USAGE + $ sfdx hardis:config:get [-l ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -l, --level=project|branch|user [default: project] project,branch or + user + + --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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLE + $ sfdx hardis:project:deploy:sources:metadata +``` + +_See code: [lib/commands/hardis/config/get.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/config/get.js)_ + +## `sfdx hardis:doc:extract:permsetgroups [-o ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Generate markdown files with project documentation + +``` +USAGE + $ sfdx hardis:doc:extract:permsetgroups [-o ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -o, --outputfile=outputfile Force the path and name of output + report file. Must end with .csv + + --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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLE + $ sfdx hardis:doc:extract:permsetgroups +``` + +_See code: [lib/commands/hardis/doc/extract/permsetgroups.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/doc/extract/permsetgroups.js)_ + +## `sfdx hardis:doc:plugin:generate [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Generate Markdown documentation ready for HTML conversion with mkdocs + +``` +USAGE + $ sfdx hardis:doc:plugin:generate [-d] [--websocket ] [--skipauth] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + --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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +DESCRIPTION + After the first run, you need to update manually: + + - mkdocs.yml + - .github/workflows/build-deploy-docs.yml + - docs/javascripts/gtag.js , if you want Google Analytics tracking + + Then, activate Github pages, with "gh_pages" as target branch + + At each merge into master/main branch, the GitHub Action build-deploy-docs will rebuild documentation and publish it + in GitHub pages + +EXAMPLE + $ sfdx hardis:doc:plugin:generate +``` + +_See code: [lib/commands/hardis/doc/plugin/generate.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/doc/plugin/generate.js)_ + +## `sfdx hardis:lint:access [-e ] [-i ] [-f ] [-o ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Check if elements(apex class and field) are at least in one permission set + +``` +USAGE + $ sfdx hardis:lint:access [-e ] [-i ] [-f ] [-o ] [-d] [--websocket ] + [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -e, --elementsignored=elementsignored Ignore specific elements separated + by commas + + -f, --folder=folder [default: force-app] Root folder + + -i, --ignorerights=ignorerights Ignore permission sets or profiles + + -o, --outputfile=outputfile Force the path and name of output + report file. Must end with .csv + + --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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLES + $ sfdx hardis:lint:access + $ sfdx hardis:lint:access -e "ApexClass:ClassA, CustomField:Account.CustomField" + $ sfdx hardis:lint:access -i "PermissionSet:permissionSetA, Profile" +``` + +_See code: [lib/commands/hardis/lint/access.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/lint/access.js)_ + +## `sfdx hardis:lint:unused [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Check if elements(apex class and field) are at least in one permission set + +``` +USAGE + $ sfdx hardis:lint:unused [-d] [--websocket ] [--skipauth] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + --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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLES + $ sfdx hardis:lint:access + $ sfdx hardis:lint:access -e "ApexClass:ClassA, CustomField:Account.CustomField" + $ sfdx hardis:lint:access -i "PermissionSet:permissionSetA, Profile" +``` + +_See code: [lib/commands/hardis/lint/unused.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/lint/unused.js)_ + +## `sfdx hardis:mdapi:deploy [-d ] [-w ] [-q | -l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r | -o | -g | -c] [-f ] [-s] [--soapdeploy] [--purgeondelete] [--debug] [--websocket ] [-u ] [--apiversion ] [--verbose] [--concise] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +sfdx-hardis wrapper for sfdx force:mdapi:deploy that displays tips to solve deployment errors. + +``` +USAGE + $ sfdx hardis:mdapi:deploy [-d ] [-w ] [-q | -l + NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r | -o | -g | -c] [-f ] [-s] + [--soapdeploy] [--purgeondelete] [--debug] [--websocket ] [-u ] [--apiversion ] [--verbose] + [--concise] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -c, --checkonly checkOnly + -d, --deploydir=deploydir deployDir + -f, --zipfile=zipfile zipFile + -g, --ignorewarnings ignoreWarnings + -l, --testlevel=(NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg) [default: NoTestRun] testLevel + -o, --ignoreerrors ignoreErrors + -q, --validateddeployrequestid=validateddeployrequestid validatedDeployRequestId + -r, --runtests=runtests [default: ] runTests + -s, --singlepackage singlePackage + + -u, --targetusername=targetusername username or alias for the target + org; overrides default target org + + -w, --wait=wait [default: 0 minutes] wait + + --apiversion=apiversion override the api version used for + api requests made by this command + + --concise concise + + --debug debug + + --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 + + --purgeondelete purgeOnDelete + + --soapdeploy soapDeploy + + --verbose verbose + + --websocket=websocket websocket + +DESCRIPTION + [![Assisted solving of Salesforce deployments + errors](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/article-deployment-errors.jpg)](http + s://nicolas.vuillamy.fr/assisted-solving-of-salesforce-deployments-errors-47f3666a9ed0) + + [See documentation of Salesforce command](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sf + dx_cli_reference/cli_reference_force_mdapi.htm#cli_reference_force_mdapi_deploy) +``` + +_See code: [lib/commands/hardis/mdapi/deploy.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/mdapi/deploy.js)_ + +## `sfdx hardis:misc:toml2csv -f [-t ] [-l ] [-s] [-o ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Split TOML file into distinct CSV files + +``` +USAGE + $ sfdx hardis:misc:toml2csv -f [-t ] [-l ] [-s] [-o ] [-d] [--websocket ] + [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + -f, --tomlfile=tomlfile (required) Input TOML file path + + -l, --filtersections=filtersections [default: ] List of sections to + process (if not set, all sections + will be processed) + + -o, --outputdir=outputdir Output directory + + -s, --skiptransfo Do not apply transformation to input + data + + -t, --transfoconfig=transfoconfig Path to JSON config file for mapping + and transformation + + -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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLES + $ sfdx hardis:misc:toml2csv --tomlfile 'D:/clients/toto/V1_full.txt' + $ sfdx hardis:misc:toml2csv --skiptransfo --tomlfile 'D:/clients/toto/V1_full.txt' + $ sfdx hardis:misc:toml2csv --skiptransfo --tomlfile 'D:/clients/toto/V1_full.txt' --outputdir 'C:/tmp/rrrr' + $ NODE_OPTIONS=--max_old_space_size=9096 sfdx hardis:misc:toml2csv --skiptransfo --tomlfile './input/V1.txt' + --outputdir './output' --filtersections 'COMPTES,SOUS' +``` + +_See code: [lib/commands/hardis/misc/toml2csv.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/misc/toml2csv.js)_ + +## `sfdx hardis:org:configure:data [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Configure Data Export/Import with a [SFDX Data Loader](https://help.sfdmu.com/) Project + +``` +USAGE + $ sfdx hardis:org:configure:data [-d] [--websocket ] [--skipauth] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + --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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +DESCRIPTION + See article: + + [![How to detect bad words in Salesforce records using SFDX Data Loader and + sfdx-hardis](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/article-badwords.jpg)](https:// + nicolas.vuillamy.fr/how-to-detect-bad-words-in-salesforce-records-using-sfdx-data-loader-and-sfdx-hardis-171db40a9bac) + +EXAMPLE + $ sfdx hardis:org:configure:data +``` + +_See code: [lib/commands/hardis/org/configure/data.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/org/configure/data.js)_ + +## `sfdx hardis:org:configure:files [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Configure export of file attachments from a Salesforce org + +``` +USAGE + $ sfdx hardis:org:configure:files [-d] [--websocket ] [--skipauth] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + --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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +DESCRIPTION + See article below + + [![How to mass download notes and attachments files from a Salesforce + org](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/article-mass-download.jpg)](https://nic + olas.vuillamy.fr/how-to-mass-download-notes-and-attachments-files-from-a-salesforce-org-83a028824afd) + +EXAMPLE + $ sfdx hardis:org:configure:files +``` + +_See code: [lib/commands/hardis/org/configure/files.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/org/configure/files.js)_ + +## `sfdx hardis:org:configure:monitoring [--orginstanceurl ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Configure monitoring of an org + +``` +USAGE + $ sfdx hardis:org:configure:monitoring [--orginstanceurl ] [-d] [--websocket ] [--skipauth] [-u + ] [--apiversion ] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -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 + + --orginstanceurl=orginstanceurl Org instance url (technical param, + do not use manually) + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLE + $ sfdx hardis:org:configure:monitoring +``` + +_See code: [lib/commands/hardis/org/configure/monitoring.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/org/configure/monitoring.js)_ + +## `sfdx hardis:org:connect [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Connect to an org without setting it as default username, then proposes to open the org in web browser + +``` +USAGE + $ sfdx hardis:org:connect [-d] [--websocket ] [--skipauth] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + --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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +DESCRIPTION + + +EXAMPLE + $ sfdx hardis:org:connect +``` + +_See code: [lib/commands/hardis/org/connect.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/org/connect.js)_ + +## `sfdx hardis:org:create [-d] [--websocket ] [--skipauth] [-v ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Create and initialize sandbox org + +``` +USAGE + $ sfdx hardis:org:create [-d] [--websocket ] [--skipauth] [-v ] [--apiversion ] [--json] + [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLE + $ sfdx hardis:org:create +``` + +_See code: [lib/commands/hardis/org/create.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/org/create.js)_ + +## `sfdx hardis:org:data:delete [-p ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Delete data in org using sfdmu + +``` +USAGE + $ sfdx hardis:org:data:delete [-p ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion + ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + -p, --path=path Path to the sfdmu workspace folder + + -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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLE + $ sfdx hardis:org:data:delete +``` + +_See code: [lib/commands/hardis/org/data/delete.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/org/data/delete.js)_ + +## `sfdx hardis:org:data:export [-p ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Export data from an org using a [SFDX Data Loader](https://help.sfdmu.com/) Project + +``` +USAGE + $ sfdx hardis:org:data:export [-p ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion + ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + -p, --path=path Path to the sfdmu workspace folder + + -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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +DESCRIPTION + See article: + + [![How to detect bad words in Salesforce records using SFDX Data Loader and + sfdx-hardis](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/article-badwords.jpg)](https:// + nicolas.vuillamy.fr/how-to-detect-bad-words-in-salesforce-records-using-sfdx-data-loader-and-sfdx-hardis-171db40a9bac) + +EXAMPLE + $ sfdx hardis:org:data:export +``` + +_See code: [lib/commands/hardis/org/data/export.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/org/data/export.js)_ + +## `sfdx hardis:org:data:import [-p ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Import/Load data in an org using a [SFDX Data Loader](https://help.sfdmu.com/) Project + +``` +USAGE + $ sfdx hardis:org:data:import [-p ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion + ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + -p, --path=path Path to the sfdmu workspace folder + + -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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +DESCRIPTION + See article: + + [![How to detect bad words in Salesforce records using SFDX Data Loader and + sfdx-hardis](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/article-badwords.jpg)](https:// + nicolas.vuillamy.fr/how-to-detect-bad-words-in-salesforce-records-using-sfdx-data-loader-and-sfdx-hardis-171db40a9bac) + +EXAMPLE + $ sfdx hardis:org:data:import +``` + +_See code: [lib/commands/hardis/org/data/import.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/org/data/import.js)_ + +## `sfdx hardis:org:diagnose:audittrail [-e ] [-t ] [-o ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Export Audit trail into a CSV file with selected criteria, and highlight suspect actions + +``` +USAGE + $ sfdx hardis:org:diagnose:audittrail [-e ] [-t ] [-o ] [-d] [--websocket ] + [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -e, --excludeusers=excludeusers Comma-separated list of usernames to + exclude + + -o, --outputfile=outputfile Force the path and name of output + report file. Must end with .csv + + -t, --lastndays=lastndays Number of days to extract from today + (included) + + -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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +DESCRIPTION + Regular setup actions performed in major orgs are filtered. + + - "" + - createScratchOrg + - deleteScratchOrg + - Certificate and Key Management + - insertCertificate + - Groups + - groupMembership + - Manage Users + - activateduser + - createduser + - changedcommunitynickname + - changedpassword + - changedinteractionuseroffon + - changedinteractionuseronoff + - changedmarketinguseroffon + - changedmarketinguseronoff + - changedprofileforuser + - changedprofileforusercusttostd + - changedprofileforuserstdtocust + - changedroleforusertonone + - changedroleforuser + - changedroleforuserfromnone + - changedUserEmailVerifiedStatusVerified + - deactivateduser + - deleteAuthenticatorPairing + - deleteTwoFactorInfo2 + - deleteTwoFactorTempCode + - insertAuthenticatorPairing + - insertTwoFactorInfo2 + - insertTwoFactorTempCode + - lightningloginenroll + - PermSetAssign + - PermSetLicenseAssign + - PermSetUnassign + - PermSetLicenseUnassign + - resetpassword + - suOrgAdminLogin + - suOrgAdminLogout + + By default, deployment user defined in .sfdx-hardis.yml targetUsername property will be excluded. + + You can define additional users to exclude in .sfdx-hardis.yml **monitoringExcludeUsernames** property. + + You can also add more sections / actions considered as not suspect using property **monitoringAllowedSectionsActions** + + Example: + + ```yaml + monitoringExcludeUsernames: + - deploymentuser@cloudity.com + - marketingcloud@cloudity.com + - integration-user@cloudity.com + + monitoringAllowedSectionsActions: + "Some section": [] // Will ignore all actions from such section + "Some other section": ["actionType1","actionType2","actionType3"] // Will ignore only those 3 actions from section + "Some other section". Other actions in the same section will be considered as suspect. + ``` + +EXAMPLES + $ sfdx hardis:org:diagnose:audittrail + $ sfdx hardis:org:diagnose:audittrail --excludeusers baptiste@titi.com + $ sfdx hardis:org:diagnose:audittrail --excludeusers baptiste@titi.com,bertrand@titi.com + $ sfdx hardis:org:diagnose:audittrail --lastndays 5 +``` + +_See code: [lib/commands/hardis/org/diagnose/audittrail.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/org/diagnose/audittrail.js)_ + +## `sfdx hardis:org:diagnose:legacyapi [-e ] [-l ] [-o ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Checks if an org uses retired or someday retired API version + +``` +USAGE + $ sfdx hardis:org:diagnose:legacyapi [-e ] [-l ] [-o ] [-d] [--websocket ] + [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -e, --eventtype=eventtype [default: ApiTotalUsage] Type of + EventLogFile event to analyze + + -l, --limit=limit [default: 999] Number of latest + EventLogFile events to analyze + + -o, --outputfile=outputfile Force the path and name of output + report file. Must end with .csv + + -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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +DESCRIPTION + See article below + + [![Handle Salesforce API versions Deprecation like a + pro](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/article-deprecated-api.jpg)](https://ni + colas.vuillamy.fr/handle-salesforce-api-versions-deprecation-like-a-pro-335065f52238) + +EXAMPLES + $ sfdx hardis:org:diagnose:legacyapi + $ sfdx hardis:org:diagnose:legacyapi -u hardis@myclient.com + $ sfdx hardis:org:diagnose:legacyapi --outputfile 'c:/path/to/folder/legacyapi.csv' + $ sfdx hardis:org:diagnose:legacyapi -u hardis@myclient.com --outputfile ./tmp/legacyapi.csv +``` + +_See code: [lib/commands/hardis/org/diagnose/legacyapi.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/org/diagnose/legacyapi.js)_ + +## `sfdx hardis:org:files:export [-p ] [-c ] [-t ] [-s ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Export file attachments from a Salesforce org + +``` +USAGE + $ sfdx hardis:org:files:export [-p ] [-c ] [-t ] [-s ] [-d] [--websocket ] + [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -c, --chunksize=chunksize [default: 1000] Number of records to + add in a chunk before it is + processed + + -d, --debug Activate debug mode (more logs) + + -p, --path=path Path to the file export project + + -s, --startchunknumber=startchunknumber [default: 0] Chunk number to start + from + + -t, --polltimeout=polltimeout [default: 300000] Timeout in MS for + Bulk API calls + + -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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +DESCRIPTION + See article below + + [![How to mass download notes and attachments files from a Salesforce + org](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/article-mass-download.jpg)](https://nic + olas.vuillamy.fr/how-to-mass-download-notes-and-attachments-files-from-a-salesforce-org-83a028824afd) + +EXAMPLE + $ sfdx hardis:org:files:export +``` + +_See code: [lib/commands/hardis/org/files/export.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/org/files/export.js)_ + +## `sfdx hardis:org:fix:listviewmine [-l ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Fix listviews whose scope Mine has been replaced by Everything + +``` +USAGE + $ sfdx hardis:org:fix:listviewmine [-l ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion + ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -l, --listviews=listviews Comma-separated list of listviews + following format Object:ListViewName + Example: Contact:MyContacts,Contact: + MyActiveContacts,Opportunity:MYClose + dOpportunities + + -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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +DESCRIPTION + [![Invalid scope:Mine, not allowed ? Deploy your ListViews anyway + !](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/article-invalid-scope-mine.jpg)](https:// + nicolas.vuillamy.fr/invalid-scope-mine-not-allowed-deploy-your-listviews-anyway-443aceca8ac7) + + List of ListViews can be: + + - read from .sfdx-hardis.yml file in property **listViewsToSetToMine** + - sent in argument listviews + + Note: property **listViewsToSetToMine** can be auto-generated by command hardis:work:save if .sfdx-hardis.yml contains + the following configuration + + ```yaml + autoCleanTypes: + - listViewsMine + ``` + + - Example of sfdx-hardis.yml property `listViewsToSetToMine`: + + ```yaml + listViewsToSetToMine: + - "force-app/main/default/objects/Operation__c/listViews/MyCurrentOperations.listView-meta.xml" + - "force-app/main/default/objects/Operation__c/listViews/MyFinalizedOperations.listView-meta.xml" + - "force-app/main/default/objects/Opportunity/listViews/Default_Opportunity_Pipeline.listView-meta.xml" + - "force-app/main/default/objects/Opportunity/listViews/MyCurrentSubscriptions.listView-meta.xml" + - "force-app/main/default/objects/Opportunity/listViews/MySubscriptions.listView-meta.xml" + - "force-app/main/default/objects/Account/listViews/MyActivePartners.listView-meta.xml" + ``` + + - If manually written, this could also be: + + ```yaml + listViewsToSetToMine: + - "Operation__c:MyCurrentOperations" + - "Operation__c:MyFinalizedOperations" + - "Opportunity:Default_Opportunity_Pipeline" + - "Opportunity:MyCurrentSubscriptions" + - "Opportunity:MySubscriptions" + - "Account:MyActivePartners" + ``` + + Troubleshooting: if you need to run this command from an alpine-linux based docker image, use this workaround in your + dockerfile: + + ```dockerfile + # Do not use puppeteer embedded chromium + RUN apk add --update --no-cache chromium + ENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD="true" + ENV CHROMIUM_PATH="/usr/bin/chromium-browser" + ENV PUPPETEER_EXECUTABLE_PATH="$\{CHROMIUM_PATH}" // remove \ before { + ``` + +EXAMPLES + $ sfdx hardis:org:fix:listviewmine + $ sfdx hardis:org:fix:listviewmine --listviews Opportunity:MySubscriptions,Account:MyActivePartners +``` + +_See code: [lib/commands/hardis/org/fix/listviewmine.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/org/fix/listviewmine.js)_ + +## `sfdx hardis:org:generate:packagexmlfull [--outputfile ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Generates full org package.xml, including managed items + +``` +USAGE + $ sfdx hardis:org:generate:packagexmlfull [--outputfile ] [-d] [--websocket ] [--skipauth] [-u + ] [--apiversion ] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -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 + + --outputfile=outputfile Output package.xml file + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLES + $ sfdx hardis:org:generate:packagexmlfull + $ sfdx hardis:org:generate:packagexmlfull --outputfile /tmp/packagexmlfull.xml + $ sfdx hardis:org:generate:packagexmlfull --targetusername nico@example.com +``` + +_See code: [lib/commands/hardis/org/generate/packagexmlfull.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/org/generate/packagexmlfull.js)_ + +## `sfdx hardis:org:monitor:all [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Monitor org, generate reports and sends notifications + +``` +USAGE + $ sfdx hardis:org:monitor:all [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] + [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +DESCRIPTION + A default list of monitoring commands is used, if you want to override it you can define property + **monitoringCommands** in your .sfdx-hardis.yml file + + Example: + + ```yaml + monitoringCommands: + - title: Detect calls to deprecated API versions + command: sfdx hardis:org:diagnose:legacyapi + - title: Detect suspect setup actions in major orgs + command: sfdx hardis:org:diagnose:audittrail + - title: Detect custom elements with no access rights defined in permission sets + command: sfdx hardis:lint:access + - title: My Custom command + command: sfdx my:custom:command + ``` + +EXAMPLE + $ sfdx hardis:org:monitor:all +``` + +_See code: [lib/commands/hardis/org/monitor/all.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/org/monitor/all.js)_ + +## `sfdx hardis:org:monitor:backup [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Retrieve sfdx sources in the context of a monitoring backup + +``` +USAGE + $ sfdx hardis:org:monitor:backup [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] + [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLE + $ sfdx hardis:org:monitor:backup +``` + +_See code: [lib/commands/hardis/org/monitor/backup.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/org/monitor/backup.js)_ + +## `sfdx hardis:org:purge:apexlog [-z] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Purge apex logs in selected org + +``` +USAGE + $ sfdx hardis:org:purge:apexlog [-z] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] + [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -u, --targetusername=targetusername username or alias for the target + org; overrides default target org + + -z, --[no-]prompt Prompt for confirmation (true by + default, use --no-prompt to skip) + + --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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLES + $ sfdx hardis:org:purge:apexlog + $ sfdx hardis:org:purge:apexlog --targetusername nicolas.vuillamy@gmail.com +``` + +_See code: [lib/commands/hardis/org/purge/apexlog.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/org/purge/apexlog.js)_ + +## `sfdx hardis:org:purge:flow [-z] [-n ] [-s ] [-f] [-r ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Purge Obsolete flow versions to avoid the 50 max versions limit. Filters on Status and Name + +``` +USAGE + $ sfdx hardis:org:purge:flow [-z] [-n ] [-s ] [-f] [-r ] [-d] [--websocket ] + [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -f, --[no-]allowpurgefailure Allows purges to fail without + exiting with 1. Use + --no-allowpurgefailure to disable + + -n, --name=name Filter according to Name criteria + + -r, --instanceurl=instanceurl [default: + https://login.salesforce.com] URL of + org instance + + -s, --status=status Filter according to Status criteria + + -u, --targetusername=targetusername username or alias for the target + org; overrides default target org + + -z, --[no-]prompt Prompt for confirmation (true by + default, use --no-prompt to skip) + + --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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLES + $ sfdx hardis:org:purge:flow --targetusername nicolas.vuillamy@gmail.com + Found 1 records: + ID MASTERLABEL VERSIONNUMBER DESCRIPTION STATUS + 30109000000kX7uAAE TestFlow 2 test flowwww Obsolete + Are you sure you want to delete this list of records (y/n)?: y + Successfully deleted record: 30109000000kX7uAAE. + Deleted the following list of records: + ID MASTERLABEL VERSIONNUMBER DESCRIPTION STATUS + 30109000000kX7uAAE TestFlow 2 test flowwww Obsolete + + $ sfdx hardis:org:purge:flow --targetusername nicolas.vuillamy@gmail.com --status "Obsolete,Draft,InvalidDraft --name + TestFlow" + Found 4 records: + ID MASTERLABEL VERSIONNUMBER DESCRIPTION STATUS + 30109000000kX7uAAE TestFlow 2 test flowwww Obsolete + 30109000000kX8EAAU TestFlow 6 test flowwww InvalidDraft + 30109000000kX8AAAU TestFlow 5 test flowwww InvalidDraft + 30109000000kX89AAE TestFlow 4 test flowwww Draft + Are you sure you want to delete this list of records (y/n)?: n + No record deleted +``` + +_See code: [lib/commands/hardis/org/purge/flow.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/org/purge/flow.js)_ + +## `sfdx hardis:org:retrieve:packageconfig [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Retrieve package configuration from an org + +``` +USAGE + $ sfdx hardis:org:retrieve:packageconfig [-d] [--websocket ] [--skipauth] [-u ] [--apiversion + ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLES + $ sfdx hardis:org:retrieve:packageconfig + sfdx hardis:org:retrieve:packageconfig -u myOrg +``` + +_See code: [lib/commands/hardis/org/retrieve/packageconfig.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/org/retrieve/packageconfig.js)_ + +## `sfdx hardis:org:retrieve:sources:analytics [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Retrieve all CRM Analytics sources from an org, with workarounds for SFDX bugs + +``` +USAGE + $ sfdx hardis:org:retrieve:sources:analytics [-d] [--websocket ] [--skipauth] [-u ] [--apiversion + ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLE + $ sfdx hardis:org:retrieve:sources:analytics +``` + +_See code: [lib/commands/hardis/org/retrieve/sources/analytics.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/org/retrieve/sources/analytics.js)_ + +## `sfdx hardis:org:retrieve:sources:dx [-f ] [-t ] [-k ] [-m ] [-o] [-r ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Retrieve Salesforce DX project from org + +``` +USAGE + $ sfdx hardis:org:retrieve:sources:dx [-f ] [-t ] [-k ] [-m ] [-o] [-r ] [-d] + [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + -f, --folder=folder [default: .] Folder + + -k, --keepmetadatatypes=keepmetadatatypes Comma separated list of metadatas + types that will be the only ones to + be retrieved + + -m, --filteredmetadatas=filteredmetadatas Comma separated list of Metadatas + keys to remove from PackageXml file + + -o, --shape Updates project-scratch-def.json + from org shape + + -r, --instanceurl=instanceurl URL of org instance + + -t, --tempfolder=tempfolder [default: ./tmp] Temporary folder + + -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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLE + $ sfdx hardis:org:retrieve:sources:dx +``` + +_See code: [lib/commands/hardis/org/retrieve/sources/dx.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/org/retrieve/sources/dx.js)_ + +## `sfdx hardis:org:retrieve:sources:dx2 [-x ] [-t ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Retrieve Salesforce DX project from org + +``` +USAGE + $ sfdx hardis:org:retrieve:sources:dx2 [-x ] [-t ] [-d] [--websocket ] [--skipauth] [-u + ] [--apiversion ] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -t, --template=template sfdx-hardis package.xml Template + name. ex: wave + + -u, --targetusername=targetusername username or alias for the target + org; overrides default target org + + -x, --packagexml=packagexml Path to package.xml file + + --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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLE + $ sfdx hardis:org:retrieve:sources:dx2 +``` + +_See code: [lib/commands/hardis/org/retrieve/sources/dx2.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/org/retrieve/sources/dx2.js)_ + +## `sfdx hardis:org:retrieve:sources:metadata [-f ] [-p ] [--includemanaged] [-r ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Retrieve Salesforce DX project from org + +``` +USAGE + $ sfdx hardis:org:retrieve:sources:metadata [-f ] [-p ] [--includemanaged] [-r ] [-d] + [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + -f, --folder=folder [default: .] Folder + -p, --packagexml=packagexml Path to package.xml manifest file + -r, --instanceurl=instanceurl URL of org instance + + -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 + + --includemanaged Include items from managed packages + + --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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLES + $ sfdx hardis:org:retrieve:sources:metadata + $ SFDX_RETRIEVE_WAIT_MINUTES=200 sfdx hardis:org:retrieve:sources:metadata +``` + +_See code: [lib/commands/hardis/org/retrieve/sources/metadata.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/org/retrieve/sources/metadata.js)_ + +## `sfdx hardis:org:retrieve:sources:retrofit [--commit] [--commitmode updated|all] [--push] [--pushmode default|mergerequest] [--productionbranch ] [--retrofittargetbranch ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Retrieve changes from org link to a ref branch not present in sources + +``` +USAGE + $ sfdx hardis:org:retrieve:sources:retrofit [--commit] [--commitmode updated|all] [--push] [--pushmode + default|mergerequest] [--productionbranch ] [--retrofittargetbranch ] [-d] [--websocket ] + [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -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 + + --commit If true, a commit will be performed + after the retrofit + + --commitmode=(updated|all) [default: updated] Defines if we + commit all retrieved updates, or all + updates including creations + + --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 + + --productionbranch=productionbranch Name of the git branch corresponding + to the org we want to perform the + retrofit on. + Can be defined in productionBranch + property in .sfdx-hardis.yml + + --push If true, a push will be performed + after the retrofit + + --pushmode=(default|mergerequest) [default: default] Defines if we + send merge request options to git + push arguments + + --retrofittargetbranch=retrofittargetbranch Name of branch the merge request + will have as target + Can be defined in retrofitBranch + property in .sfdx-hardis.yml + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +DESCRIPTION + This command need to be triggered from a branch that is connected to a SF org. It will then retrieve all changes not + present in that branch sources, commit them and create a merge request against the default branch. If a merge request + already exists, it will simply add a new commit. + + Define the following properties in **.sfdx-hardis.yml** + + - **productionBranch** : Name of the git branch that is corresponding to production org + - **retrofitBranch** : Name of the git branch that will be used as merge request target + + List of metadata to retrieve can be set in three way, in order of priority : + + - `CI_SOURCES_TO_RETROFIT`: env variable (can be defined in CI context) + - `sourcesToRetrofit` property in `.sfdx-hardis.yml` + - Default list: + + - CompactLayout + - CustomApplication + - CustomField + - CustomLabel + - CustomLabels + - CustomMetadata + - CustomObject + - CustomObjectTranslation + - CustomTab + - DuplicateRule + - EmailTemplate + - FlexiPage + - GlobalValueSet + - Layout + - ListView + - MatchingRules + - PermissionSet + - RecordType + - StandardValueSet + - Translations + - ValidationRule + + You can also ignore some files even if they have been updated in production. To do that, define property + **retrofitIgnoredFiles** in .sfdx-hardis.yml + + Example of full retrofit configuration: + + ```yaml + productionBranch: master + retrofitBranch: preprod + retrofitIgnoredFiles: + - force-app/main/default/applications/MyApp.app-meta.xml + - force-app/main/default/applications/MyOtherApp.app-meta.xml + - force-app/main/default/flexipages/MyFlexipageContainingDashboards.flexipage-meta.xml + ``` + +EXAMPLES + $ sfdx hardis:org:retrieve:sources:retrofit + sfdx hardis:org:retrieve:sources:retrofit --productionbranch master --commit --commitmode updated + sfdx hardis:org:retrieve:sources:retrofit --productionbranch master --retrofitbranch preprod --commit --commitmode + updated --push --pushmode mergerequest +``` + +_See code: [lib/commands/hardis/org/retrieve/sources/retrofit.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/org/retrieve/sources/retrofit.js)_ + +## `sfdx hardis:org:select [-h] [-s] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Interactive org selection for user + +``` +USAGE + $ sfdx hardis:org:select [-h] [-s] [-d] [--websocket ] [--skipauth] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + -h, --devhub Also connect associated DevHub + + -s, --scratch Select scratch org related to + default DevHub + + --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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLE + $ sfdx hardis:org:select +``` + +_See code: [lib/commands/hardis/org/select.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/org/select.js)_ + +## `sfdx hardis:org:test:apex [-l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Run apex tests in Salesforce org + +``` +USAGE + $ sfdx hardis:org:test:apex [-l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg] [-d] [--websocket + ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -l, --testlevel=(NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg) [default: RunLocalTests] Level of + tests to apply to validate + deployment + + -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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +DESCRIPTION + If following configuration is defined, it will fail if apex coverage target is not reached: + + - Env `APEX_TESTS_MIN_COVERAGE_ORG_WIDE` or `.sfdx-hardis` property `apexTestsMinCoverageOrgWide` + - Env `APEX_TESTS_MIN_COVERAGE_ORG_WIDE` or `.sfdx-hardis` property `apexTestsMinCoverageOrgWide` + + You can override env var SFDX_TEST_WAIT_MINUTES to wait more than 60 minutes + +EXAMPLE + $ sfdx hardis:org:test:apex +``` + +_See code: [lib/commands/hardis/org/test/apex.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/org/test/apex.js)_ + +## `sfdx hardis:org:user:activateinvalid [-p ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Update sandbox users so their email is valid + +``` +USAGE + $ sfdx hardis:org:user:activateinvalid [-p ] [-d] [--websocket ] [--skipauth] [-u ] + [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -p, --profiles=profiles Comma-separated list of profiles + names that you want to reactive + users assigned to and with a + .invalid email + + -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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +DESCRIPTION + Example: replaces `toto@company.com.dev.invalid` with `toto@company.com.dev.invalid` + + See article below + + [![Reactivate all the sandbox users with .invalid emails in 3 + clicks](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/article-invalid-email.jpg)](https:// + nicolas.vuillamy.fr/reactivate-all-the-sandbox-users-with-invalid-emails-in-3-clicks-2265af4e3a3d) + +EXAMPLES + $ sfdx hardis:org:user:activateinvalid + $ sfdx hardis:org:user:activateinvalid --targetusername myuser@myorg.com + $ sfdx hardis:org:user:activateinvalid --profiles 'System Administrator,MyCustomProfile' --targetusername + myuser@myorg.com +``` + +_See code: [lib/commands/hardis/org/user/activateinvalid.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/org/user/activateinvalid.js)_ + +## `sfdx hardis:org:user:freeze [-n ] [-p ] [-e ] [-m ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Mass freeze users in org before a maintenance or go live + +``` +USAGE + $ sfdx hardis:org:user:freeze [-n ] [-p ] [-e ] [-m ] [-d] [--websocket ] + [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -e, --excludeprofiles=excludeprofiles List of profiles that you want to + NOT freeze, separated by commas + + -m, --maxuserdisplay=maxuserdisplay [default: 100] Maximum users to + display in logs + + -n, --name=name Filter according to Name criteria + + -p, --includeprofiles=includeprofiles List of profiles that you want to + freeze, separated by commas + + -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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +DESCRIPTION + See user guide in the following article + + + + [![How to freeze / unfreeze users during a Salesforce + deployment](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/article-freeze.jpg)](https://med + ium.com/@dimitrimonge/freeze-unfreeze-users-during-salesforce-deployment-8a1488bf8dd3) + +EXAMPLES + $ sfdx hardis:org:user:freeze + $ sfdx hardis:org:user:freeze --targetusername myuser@myorg.com + $ sfdx hardis:org:user:freeze --includeprofiles 'Standard' + $ sfdx hardis:org:user:freeze --excludeprofiles 'System Administrator,Some Other Profile' +``` + +_See code: [lib/commands/hardis/org/user/freeze.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/org/user/freeze.js)_ + +## `sfdx hardis:org:user:unfreeze [-n ] [-p ] [-e ] [-m ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Mass unfreeze users in org after a maintenance or go live + +``` +USAGE + $ sfdx hardis:org:user:unfreeze [-n ] [-p ] [-e ] [-m ] [-d] [--websocket ] + [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -e, --excludeprofiles=excludeprofiles List of profiles that you want to + NOT unfreeze, separated by commas + + -m, --maxuserdisplay=maxuserdisplay [default: 100] Maximum users to + display in logs + + -n, --name=name Filter according to Name criteria + + -p, --includeprofiles=includeprofiles List of profiles that you want to + unfreeze, separated by commas + + -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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +DESCRIPTION + See user guide in the following article + + + + [![How to freeze / unfreeze users during a Salesforce + deployment](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/article-freeze.jpg)](https://med + ium.com/@dimitrimonge/freeze-unfreeze-users-during-salesforce-deployment-8a1488bf8dd3) + +EXAMPLES + $ sfdx hardis:org:user:unfreeze + $ sfdx hardis:org:user:unfreeze --targetusername myuser@myorg.com + $ sfdx hardis:org:user:unfreeze --includeprofiles 'Standard' + $ sfdx hardis:org:user:unfreeze --excludeprofiles 'System Administrator,Some Other Profile' +``` + +_See code: [lib/commands/hardis/org/user/unfreeze.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/org/user/unfreeze.js)_ + +## `sfdx hardis:package:create [-d] [--websocket ] [--skipauth] [-v ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Create a new package + +``` +USAGE + $ sfdx hardis:package:create [-d] [--websocket ] [--skipauth] [-v ] [--apiversion ] [--json] + [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLE + $ sfdx hardis:package:create +``` + +_See code: [lib/commands/hardis/package/create.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/package/create.js)_ + +## `sfdx hardis:package:install [-p ] [-d] [--websocket ] [-k ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Install a package in an org using its id (starting with **04t**) + +``` +USAGE + $ sfdx hardis:package:install [-p ] [-d] [--websocket ] [-k ] [--skipauth] [-u ] + [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -k, --installationkey=installationkey installation key for key-protected + package (default: null) + + -p, --package=package Package Version Id to install + (04t...) + + -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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +DESCRIPTION + Assisted menu to propose to update `installedPackages` property in `.sfdx-hardis.yml` + +EXAMPLE + $ sfdx hardis:package:install +``` + +_See code: [lib/commands/hardis/package/install.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/package/install.js)_ + +## `sfdx hardis:package:mergexml [-f ] [-p ] [-x ] [-r ] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Select and merge package.xml files + +``` +USAGE + $ sfdx hardis:package:mergexml [-f ] [-p ] [-x ] [-r ] [--websocket ] + [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -f, --folder=folder [default: manifest] Root folder + + -p, --packagexmls=packagexmls Comma separated list of package.xml + files to merge. Will be prompted to + user if not provided + + -r, --result=result Result package.xml file name + + -x, --pattern=pattern [default: /**/*package*.xml] Name + criteria to list package.xml files + + --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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLES + $ sfdx hardis:package:mergexml + $ sfdx hardis:package:mergexml --folder packages --pattern /**/*.xml --result myMergedPackage.xml + $ sfdx hardis:package:mergexml --packagexmls "config/mypackage1.xml,config/mypackage2.xml,config/mypackage3.xml" + --result myMergedPackage.xml +``` + +_See code: [lib/commands/hardis/package/mergexml.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/package/mergexml.js)_ + +## `sfdx hardis:package:version:create [-d] [-p ] [-k ] [--deleteafter] [-i] [--websocket ] [--skipauth] [-v ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Create a new version of an unlocked package + +``` +USAGE + $ sfdx hardis:package:version:create [-d] [-p ] [-k ] [--deleteafter] [-i] [--websocket ] + [--skipauth] [-v ] [--apiversion ] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -i, --install Install package version on default + org after generation + + -k, --installkey=installkey Package installation key + + -p, --package=package Package identifier that you want to + use to generate a new package + version + + -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 + + --deleteafter Delete package version after + creating it + + --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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLE + $ sfdx hardis:package:version:create +``` + +_See code: [lib/commands/hardis/package/version/create.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/package/version/create.js)_ + +## `sfdx hardis:package:version:list [-d] [--websocket ] [--skipauth] [-v ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +List versions of unlocked package + +``` +USAGE + $ sfdx hardis:package:version:list [-d] [--websocket ] [--skipauth] [-v ] [--apiversion ] + [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLE + $ sfdx hardis:package:version:list +``` + +_See code: [lib/commands/hardis/package/version/list.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/package/version/list.js)_ + +## `sfdx hardis:package:version:promote [-d] [-d] [--websocket ] [--skipauth] [-v ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Promote package(s) version(s): convert it from beta to released + +``` +USAGE + $ sfdx hardis:package:version:promote [-d] [-d] [--websocket ] [--skipauth] [-v ] [--apiversion + ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --auto Auto-detect which versions of which + packages need to be promoted + + -d, --debug Activate debug mode (more logs) + + -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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLES + $ sfdx hardis:package:version:promote + $ sfdx hardis:package:version:promote --auto +``` + +_See code: [lib/commands/hardis/package/version/promote.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/package/version/promote.js)_ + +## `sfdx hardis:project:audit:apiversion [-m ] [-f] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Audit API version + +``` +USAGE + $ sfdx hardis:project:audit:apiversion [-m ] [-f] [-d] [--websocket ] [--skipauth] [--json] + [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -f, --failiferror Fails (exit code 1) if an error is + found + + -m, --minimumapiversion=minimumapiversion [default: 20] Minimum allowed API + version + + --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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLE + $ sfdx hardis:project:audit:apiversion +``` + +_See code: [lib/commands/hardis/project/audit/apiversion.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/project/audit/apiversion.js)_ + +## `sfdx hardis:project:audit:callincallout [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Generate list of callIn and callouts from sfdx project + +``` +USAGE + $ sfdx hardis:project:audit:callincallout [-d] [--websocket ] [--skipauth] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + --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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLE + $ sfdx hardis:project:audit:callouts +``` + +_See code: [lib/commands/hardis/project/audit/callincallout.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/project/audit/callincallout.js)_ + +## `sfdx hardis:project:audit:duplicatefiles [-p ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Find duplicate files in sfdx folder (often from past @salesforce/cli bugs) + +``` +USAGE + $ sfdx hardis:project:audit:duplicatefiles [-p ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -p, --path=path [default: C:\git\pro\sfdx-hardis2] + Root path to check + + --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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLE + $ sfdx hardis:project:audit:duplicatefiles +``` + +_See code: [lib/commands/hardis/project/audit/duplicatefiles.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/project/audit/duplicatefiles.js)_ + +## `sfdx hardis:project:audit:remotesites [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Generate list of remote sites + +``` +USAGE + $ sfdx hardis:project:audit:remotesites [-d] [--websocket ] [--skipauth] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + --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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLE + $ sfdx hardis:project:audit:remotesites +``` + +_See code: [lib/commands/hardis/project/audit/remotesites.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/project/audit/remotesites.js)_ + +## `sfdx hardis:project:clean:emptyitems [-f ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Remove unwanted empty items within sfdx project sources + +``` +USAGE + $ sfdx hardis:project:clean:emptyitems [-f ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + -f, --folder=folder [default: force-app] Root folder + --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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLE + $ sfdx hardis:project:clean:emptyitems +``` + +_See code: [lib/commands/hardis/project/clean/emptyitems.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/project/clean/emptyitems.js)_ + +## `sfdx hardis:project:clean:hiddenitems [-f ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Remove unwanted hidden items within sfdx project sources + +``` +USAGE + $ sfdx hardis:project:clean:hiddenitems [-f ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + -f, --folder=folder [default: force-app] Root folder + --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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLE + $ sfdx hardis:project:clean:hiddenitems +``` + +_See code: [lib/commands/hardis/project/clean/hiddenitems.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/project/clean/hiddenitems.js)_ + +## `sfdx hardis:project:clean:listviews [-f ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Replace Mine by Everything in ListView, and log the replacements in sfdx-hardis.yml + +``` +USAGE + $ sfdx hardis:project:clean:listviews [-f ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + -f, --folder=folder [default: force-app] Root folder + --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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLE + $ sfdx hardis:project:clean:listviews +``` + +_See code: [lib/commands/hardis/project/clean/listviews.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/project/clean/listviews.js)_ + +## `sfdx hardis:project:clean:manageditems [-n ] [-f ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Remove unwanted managed items within sfdx project sources + +``` +USAGE + $ sfdx hardis:project:clean:manageditems [-n ] [-f ] [-d] [--websocket ] [--skipauth] [--json] + [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + -f, --folder=folder [default: force-app] Root folder + -n, --namespace=namespace Namespace to remove + --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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLE + $ sfdx hardis:project:clean:manageditems --namespace crta +``` + +_See code: [lib/commands/hardis/project/clean/manageditems.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/project/clean/manageditems.js)_ + +## `sfdx hardis:project:clean:minimizeprofiles [-f ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Remove all profile attributes that exist on Permission Sets + +``` +USAGE + $ sfdx hardis:project:clean:minimizeprofiles [-f ] [-d] [--websocket ] [--skipauth] [--json] + [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + -f, --folder=folder [default: force-app] Root folder + --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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +DESCRIPTION + It is a bad practice to define on Profiles elements that can be defined on Permission Sets. + + Salesforce will deprecate such capability in Spring 26. + + Don't wait for that, and use minimizeProfiles cleaning to automatically remove from Profiles any permission that + exists on a Permission Set ! + + The following XML tags are removed automatically: + + - classAccesses + - customMetadataTypeAccesses + - externalDataSourceAccesses + - fieldPermissions + - objectPermissions + - pageAccesses + - userPermissions (except on Admin Profile) + + You can override this list by defining a property minimizeProfilesNodesToRemove in your .sfdx-hardis.yml config file. + +EXAMPLE + $ sfdx hardis:project:clean:minimizeprofiles +``` + +_See code: [lib/commands/hardis/project/clean/minimizeprofiles.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/project/clean/minimizeprofiles.js)_ + +## `sfdx hardis:project:clean:orgmissingitems [-f ] [-p ] [-t ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Clean SFDX sources from items present neither in target org nor local package.xml + +``` +USAGE + $ sfdx hardis:project:clean:orgmissingitems [-f ] [-p ] [-t ] [-d] [--websocket ] + [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug + Activate debug mode (more logs) + + -f, --folder=folder + [default: force-app] Root folder + + -p, --packagexmlfull=packagexmlfull + Path to packagexml used for cleaning. + Must contain also standard CustomObject and CustomField elements. + If not provided, it will be generated from a remote org + + -t, --packagexmltargetorg=packagexmltargetorg + Target org username or alias to build package.xml (sfdx must be authenticated). + If not provided, will be prompted to the user. + + --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 + + --skipauth + Skip authentication check when a default username is required + + --websocket=websocket + Websocket host:port for VsCode SFDX Hardis UI integration + +EXAMPLE + $ sfdx hardis:project:clean:orgmissingitems +``` + +_See code: [lib/commands/hardis/project/clean/orgmissingitems.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/project/clean/orgmissingitems.js)_ + +## `sfdx hardis:project:clean:references [-t ] [-c ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Remove unwanted references within sfdx project sources + +``` +USAGE + $ sfdx hardis:project:clean:references [-t ] [-c ] [-d] [--websocket ] [--skipauth] [--json] + [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -c, --config=config + Path to a JSON config file or a destructiveChanges.xml file + + -d, --debug + Activate debug mode (more logs) + + -t, --type=all|caseentitlement|dashboards|datadotcom|destructivechanges|localfields|productrequest|entitlement + Cleaning type + + --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 + + --skipauth + Skip authentication check when a default username is required + + --websocket=websocket + Websocket host:port for VsCode SFDX Hardis UI integration + +EXAMPLES + $ sfdx hardis:project:clean:references + $ sfdx hardis:project:clean:references --type all + $ sfdx hardis:project:clean:references --config ./cleaning/myconfig.json + $ sfdx hardis:project:clean:references --config ./somefolder/myDestructivePackage.xml +``` + +_See code: [lib/commands/hardis/project/clean/references.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/project/clean/references.js)_ + +## `sfdx hardis:project:clean:retrievefolders [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Retrieve dashboards, documents and report folders in DX sources. Use -u ORGALIAS + +``` +USAGE + $ sfdx hardis:project:clean:retrievefolders [-d] [--websocket ] [--skipauth] [-u ] [--apiversion + ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLE + $ sfdx hardis:project:clean:retrievefolders +``` + +_See code: [lib/commands/hardis/project/clean/retrievefolders.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/project/clean/retrievefolders.js)_ + +## `sfdx hardis:project:clean:standarditems [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Remove unwanted standard items within sfdx project sources + +``` +USAGE + $ sfdx hardis:project:clean:standarditems [-d] [--websocket ] [--skipauth] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + --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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLE + $ sfdx hardis:project:clean:standarditems +``` + +_See code: [lib/commands/hardis/project/clean/standarditems.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/project/clean/standarditems.js)_ + +## `sfdx hardis:project:clean:systemdebug [-f ] [--websocket ] [--skipauth] [-d] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Clean System.debug() lines in APEX Code (classes and triggers) + +``` +USAGE + $ sfdx hardis:project:clean:systemdebug [-f ] [--websocket ] [--skipauth] [-d] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --delete Delete lines with System.debug + -f, --folder=folder [default: force-app] Root folder + --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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLE + $ sfdx hardis:project:clean:systemdebug +``` + +_See code: [lib/commands/hardis/project/clean/systemdebug.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/project/clean/systemdebug.js)_ + +## `sfdx hardis:project:clean:xml [-f ] [-p -x ] [-n ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Remove XML elements using Glob patterns and XPath expressions + +``` +USAGE + $ sfdx hardis:project:clean:xml [-f ] [-p -x ] [-n ] [-d] [--websocket ] + [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + -f, --folder=folder [default: force-app] Root folder + + -n, --namespace=namespace [default: http://soap.sforce.com/200 + 6/04/metadata] XML Namespace to use + + -p, --globpattern=globpattern Glob pattern to find files to clean. + Ex: /**/*.flexipage-meta.xml + + -x, --xpath=xpath XPath to use to detect the elements + to remove. Ex: + //ns:flexiPageRegions//ns:name[conta + ins(text(),'dashboardName')] + + --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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +DESCRIPTION + This can be very useful to avoid to always remove manually the same elements in the same XML file. + + - **globpattern** can be any glob pattern allowing to identify the XML files to update, for example + `/**/*.flexipage-meta.xml` + + - **xpath** can be any xpath following the format `//ns:PARENT-TAG-NAME//ns:TAG-NAME[contains(text(),'TAG-VALUE')]`. + If an element is found, the whole **PARENT-TAG-NAME** (with its subtree) will be removed. + + ![How to build cleaning + XPath](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/doc-clean-xml.jpg) + + Note: If globpattern and xpath are not sent, elements defined in property **cleanXmlPatterns** in **.sfdx-hardis.yml** + config file will be used + +EXAMPLES + $ sfdx hardis:project:clean:xml + $ sfdx hardis:project:clean:xml --globpattern "/**/*.flexipage-meta.xml" --xpath + "//ns:flexiPageRegions//ns:name[contains(text(),'dashboardName')]" +``` + +_See code: [lib/commands/hardis/project/clean/xml.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/project/clean/xml.js)_ + +## `sfdx hardis:project:configure:auth [-b] [-d] [--websocket ] [--skipauth] [-v ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Configure authentication from git branch to target org + +``` +USAGE + $ sfdx hardis:project:configure:auth [-b] [-d] [--websocket ] [--skipauth] [-v ] [-u ] + [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -b, --devhub Configure project DevHub + -d, --debug Activate debug mode (more logs) + + -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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLE + $ sfdx hardis:project:configure:auth +``` + +_See code: [lib/commands/hardis/project/configure/auth.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/project/configure/auth.js)_ + +## `sfdx hardis:project:convert:profilestopermsets [-e ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Creates permission sets from existing profiles, with id PS_PROFILENAME + +``` +USAGE + $ sfdx hardis:project:convert:profilestopermsets [-e ] [-d] [--websocket ] [--skipauth] [--json] + [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + -e, --except=except [default: ] List of filters + --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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLE + $ sfdx hardis:project:convert:profilestopermsets +``` + +_See code: [lib/commands/hardis/project/convert/profilestopermsets.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/project/convert/profilestopermsets.js)_ + +## `sfdx hardis:project:create [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Create a new SFDX Project + +``` +USAGE + $ sfdx hardis:project:create [-d] [--websocket ] [--skipauth] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + --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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLE + $ sfdx hardis:project:create +``` + +_See code: [lib/commands/hardis/project/create.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/project/create.js)_ + +## `sfdx hardis:project:deploy:sources:dx [-c] [-l NoTestRun|RunSpecifiedTests|RunRepositoryTests|RunLocalTests|RunAllTestsInOrg] [-r ] [-p ] [--delta] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Deploy SFDX source to org, following deploymentPlan in .sfdx-hardis.yml + +``` +USAGE + $ sfdx hardis:project:deploy:sources:dx [-c] [-l + NoTestRun|RunSpecifiedTests|RunRepositoryTests|RunLocalTests|RunAllTestsInOrg] [-r ] [-p ] [--delta] + [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -c, --check + Only checks the deployment, there is no impact on target org + + -d, --debug + Activate debug mode (more logs) + + -l, --testlevel=(NoTestRun|RunSpecifiedTests|RunRepositoryTests|RunLocalTests|RunAllTestsInOrg) + [default: RunLocalTests] Level of tests to validate deployment. RunRepositoryTests auto-detect and run all + repository test classes + + -p, --packagexml=packagexml + Path to package.xml containing what you want to deploy in target org + + -r, --runtests=runtests + Apex test classes to run if --testlevel is RunSpecifiedTests + + -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 + + --delta + Applies sfdx-git-delta to package.xml before other deployment processes + + --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 + + --skipauth + Skip authentication check when a default username is required + + --websocket=websocket + Websocket host:port for VsCode SFDX Hardis UI integration + +DESCRIPTION + In case of errors, [tips to fix them](https://sfdx-hardis.cloudity.com/deployTips/) will be included within the error + messages. + + ### Quick Deploy + + In case Pull Request comments are configured on the project, Quick Deploy will try to be used (equivalent to button + Quick Deploy) + + If you do not want to use QuickDeploy, define variable `SFDX_HARDIS_QUICK_DEPLOY=false` + + - [GitHub Pull Requests comments config](https://sfdx-hardis.cloudity.com/salesforce-ci-cd-setup-integration-github/) + - [Gitlab Merge requests notes config](https://sfdx-hardis.cloudity.com/salesforce-ci-cd-setup-integration-gitlab/) + - [Azure Pull Requests comments config](https://sfdx-hardis.cloudity.com/salesforce-ci-cd-setup-integration-azure/) + + ### Delta deployments + + To activate delta deployments, define property `useDeltaDeployment: true` in `config/.sfdx-hardis.yml`. + + This will activate delta deployments only between minor and major branches (major to major remains full deployment + mode) + + If you want to force the delta deployment into major orgs (ex: preprod to prod), this is not recommended but you can + use env variable ALWAYS_ENABLE_DELTA_DEPLOYMENT=true + + ### Dynamic deployment items / Overwrite management + + If necessary,you can define the following files (that supports wildcards *): + + - `manifest/package-no-overwrite.xml`: Every element defined in this file will be deployed only if it is not existing + yet in the target org (can be useful with ListView for example, if the client wants to update them directly in + production org) + - `manifest/packageXmlOnChange.xml`: Every element defined in this file will not be deployed if it already has a + similar definition in target org (can be useful for SharingRules for example) + + See [Overwrite management documentation](https://sfdx-hardis.cloudity.com/salesforce-ci-cd-config-overwrite/) + + ### Deployment plan + + If you need to deploy in multiple steps, you can define a property `deploymentPlan` in `.sfdx-hardis.yml`. + + - If a file `manifest/package.xml` is found, it will be placed with order 0 in the deployment plan + + - If a file `manifest/destructiveChanges.xml` is found, it will be executed as --postdestructivechanges + + - If env var `SFDX_HARDIS_DEPLOY_IGNORE_SPLIT_PACKAGES` is defined as `false` , split of package.xml will be applied + + Example: + + ```yaml + deploymentPlan: + packages: + - label: Deploy Flow-Workflow + packageXmlFile: manifest/splits/packageXmlFlowWorkflow.xml + order: 6 + - label: Deploy SharingRules - Case + packageXmlFile: manifest/splits/packageXmlSharingRulesCase.xml + order: 30 + waitAfter: 30 + ``` + + ### Packages installation + + You can define a list of package to install during deployments using property `installedPackages` + + - If `INSTALL_PACKAGES_DURING_CHECK_DEPLOY` is defined as `true` (or `installPackagesDuringCheckDeploy: true` in + `.sfdx-hardis.yml`), packages will be installed even if the command is called with `--check` mode + - You can automatically update this property by listing all packages installed on an org using command `sfdx + hardis:org:retrieve:packageconfig` + + Example: + + ```yaml + installedPackages: + - Id: 0A35r0000009EtECAU + SubscriberPackageId: 033i0000000LVMYAA4 + SubscriberPackageName: Marketing Cloud + SubscriberPackageNamespace: et4ae5 + SubscriberPackageVersionId: 04t6S000000l11iQAA + SubscriberPackageVersionName: Marketing Cloud + SubscriberPackageVersionNumber: 236.0.0.2 + installOnScratchOrgs: true // true or false depending you want to install this package when + creating a new scratch org + installDuringDeployments: true // set as true to install package during a deployment using sfdx + hardis:project:deploy:sources:dx + installationkey: xxxxxxxxxxxxxxxxxxxx // if the package has a password, write it in this property + - Id: 0A35r0000009F9CCAU + SubscriberPackageId: 033b0000000Pf2AAAS + SubscriberPackageName: Declarative Lookup Rollup Summaries Tool + SubscriberPackageNamespace: dlrs + SubscriberPackageVersionId: 04t5p000001BmLvAAK + SubscriberPackageVersionName: Release + SubscriberPackageVersionNumber: 2.15.0.9 + installOnScratchOrgs: true + installDuringDeployments: true + ``` + + ### Automated fixes post deployments + + #### List view with scope Mine + + If you defined a property **listViewsToSetToMine** in your .sfdx-hardis.yml, related ListViews will be set to Mine ( + see command ) + + Example: + + ```yaml + listViewsToSetToMine: + - "Operation__c:MyCurrentOperations" + - "Operation__c:MyFinalizedOperations" + - "Opportunity:Default_Opportunity_Pipeline" + - "Opportunity:MyCurrentSubscriptions" + - "Opportunity:MySubscriptions" + - "Account:MyActivePartners" + ``` + + Troubleshooting: if you need to fix ListViews with mine from an alpine-linux based docker image, use this workaround + in your dockerfile: + + ```dockerfile + # Do not use puppeteer embedded chromium + RUN apk add --update --no-cache chromium + ENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD="true" + ENV CHROMIUM_PATH="/usr/bin/chromium-browser" + ENV PUPPETEER_EXECUTABLE_PATH="$\{CHROMIUM_PATH}" // remove \ before { + ``` + + If you need to increase the deployment waiting time (force:source:deploy --wait arg), you can define env var + SFDX_DEPLOY_WAIT_MINUTES + +EXAMPLES + $ sfdx hardis:project:deploy:sources:dx + $ sfdx hardis:project:deploy:sources:dx --check +``` + +_See code: [lib/commands/hardis/project/deploy/sources/dx.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/project/deploy/sources/dx.js)_ + +## `sfdx hardis:project:deploy:sources:metadata [-c] [-x ] [-p ] [-f] [-k ] [-l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Deploy metadatas to source org + +``` +USAGE + $ sfdx hardis:project:deploy:sources:metadata [-c] [-x ] [-p ] [-f] [-k ] [-l + NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg] [-d] [--websocket ] [--skipauth] [-u ] + [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -c, --check Only checks the deployment, there is + no impact on target org + + -d, --debug Activate debug mode (more logs) + + -f, --filter Filter metadatas before deploying + + -k, --destructivepackagexml=destructivepackagexml Path to destructiveChanges.xml file + to deploy + + -l, --testlevel=(NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg) [default: RunLocalTests] Level of + tests to apply to validate + deployment + + -p, --packagexml=packagexml Path to package.xml file to deploy + + -u, --targetusername=targetusername username or alias for the target + org; overrides default target org + + -x, --deploydir=deploydir [default: .] Deploy directory + + --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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLE + $ sfdx hardis:project:deploy:sources:metadata +``` + +_See code: [lib/commands/hardis/project/deploy/sources/metadata.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/project/deploy/sources/metadata.js)_ + +## `sfdx hardis:project:fix:v53flexipages [-p ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Fix flexipages for apiVersion v53 (Winter22). + +``` +USAGE + $ sfdx hardis:project:fix:v53flexipages [-p ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -p, --path=path [default: C:\git\pro\sfdx-hardis2] + Root folder + + --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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +DESCRIPTION + Note: Update api version to 53.0 in package.xml and sfdx-project.json + +EXAMPLE + $ sfdx hardis:project:fix:v53flexipages +``` + +_See code: [lib/commands/hardis/project/fix/v53flexipages.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/project/fix/v53flexipages.js)_ + +## `sfdx hardis:project:generate:gitdelta [--branch ] [--fromcommit ] [--tocommit ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Generate package.xml git delta between 2 commits + +``` +USAGE + $ sfdx hardis:project:generate:gitdelta [--branch ] [--fromcommit ] [--tocommit ] [-d] + [--websocket ] [--skipauth] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + --branch=branch Git branch to use to generate delta + --fromcommit=fromcommit Hash of commit to start from + --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 + + --skipauth Skip authentication check when a + default username is required + + --tocommit=tocommit Hash of commit to stop at + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLE + $ sfdx hardis:project:generate:gitdelta +``` + +_See code: [lib/commands/hardis/project/generate/gitdelta.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/project/generate/gitdelta.js)_ + +## `sfdx hardis:project:lint [-f] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Apply syntactic analysis (linters) on the repository sources, using Mega-Linter + +``` +USAGE + $ sfdx hardis:project:lint [-f] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] + [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + -f, --fix Apply linters fixes + + -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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLES + $ sfdx hardis:project:lint + $ sfdx hardis:project:lint --fix +``` + +_See code: [lib/commands/hardis/project/lint.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/project/lint.js)_ + +## `sfdx hardis:project:metadata:findduplicates [-f ] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +find duplicate values in XML file(s). + +``` +USAGE + $ sfdx hardis:project:metadata:findduplicates [-f ] [--websocket ] [--skipauth] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -f, --files=files XML metadata files path + --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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +DESCRIPTION + Find duplicate values in XML file(s). Keys to be checked can be configured in `config/sfdx-hardis.yml` using property + metadataDuplicateFindKeys. + + Default config : + metadataDuplicateFindKeys : + [object Object] + +EXAMPLES + + + + + ... + + + Required + Name + + + Required + Name + + + + + + + $ sfdx hardis:project:metadata:findduplicates --file layout.layout-meta.xml + [sfdx-hardis] Duplicate values in layout.layout-meta.xml + - Key : Layout.layoutSections.layoutColumns.layoutItems.field + - Values : Name + + + $ sfdx hardis:project.metadata:findduplicates -f "force-app/main/default/**/*.xml" + [sfdx-hardis] hardis:project:metadata:findduplicates execution time 0:00:00.397 + [sfdx-hardis] Duplicate values in layout1.layout-meta.xml + - Key : Layout.layoutSections.layoutColumns.layoutItems.field + - Values : CreatedById + + [sfdx-hardis] Duplicate values in layout2.layout-meta.xml + - Key : Layout.layoutSections.layoutColumns.layoutItems.field + - Values : LastModifiedById, Name +``` + +_See code: [lib/commands/hardis/project/metadata/findduplicates.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/project/metadata/findduplicates.js)_ + +## `sfdx hardis:scratch:create [-n] [-d] [-d] [--websocket ] [--skipauth] [-v ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Create and initialize a scratch org or a source-tracked sandbox (config can be defined using `config/.sfdx-hardis.yml`): + +``` +USAGE + $ sfdx hardis:scratch:create [-n] [-d] [-d] [--websocket ] [--skipauth] [-v ] [--apiversion ] + [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -d, --pool Creates the scratch org for a + scratch org pool + + -n, --forcenew If an existing scratch org exists, + do not reuse it but create a new one + + -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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +DESCRIPTION + - **Install packages** + - Use property `installedPackages` + - **Push sources** + - **Assign permission sets** + - Use property `initPermissionSets` + - **Run apex initialization scripts** + - Use property `scratchOrgInitApexScripts` + - **Load data** + - Use property `dataPackages` + +EXAMPLE + $ sfdx hardis:scratch:create +``` + +_See code: [lib/commands/hardis/scratch/create.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/scratch/create.js)_ + +## `sfdx hardis:scratch:delete [-d] [--websocket ] [--skipauth] [-v ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Assisted menu to delete scratch orgs associated to a DevHub + +``` +USAGE + $ sfdx hardis:scratch:delete [-d] [--websocket ] [--skipauth] [-v ] [--apiversion ] [--json] + [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLE + $ sfdx hardis:scratch:delete +``` + +_See code: [lib/commands/hardis/scratch/delete.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/scratch/delete.js)_ + +## `sfdx hardis:scratch:pool:create [-d] [--websocket ] [--skipauth] [-v ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Select a data storage service and configure information to build a scratch org pool + +``` +USAGE + $ sfdx hardis:scratch:pool:create [-d] [--websocket ] [--skipauth] [-v ] [--apiversion ] + [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +DESCRIPTION + Run the command, follow instruction, then you need to schedule a daily CI job for the pool maintenance: + + - Define CI ENV variable SCRATCH_ORG_POOL with value "true" + + - Call the following lines in the CI job: + + ```shell + sfdx hardis:auth:login --devhub + sfdx hardis:scratch:pool:refresh + ``` + +EXAMPLE + $ sfdx hardis:scratch:pool:configure +``` + +_See code: [lib/commands/hardis/scratch/pool/create.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/scratch/pool/create.js)_ + +## `sfdx hardis:scratch:pool:localauth [-d] [--websocket ] [--skipauth] [-v ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Calls the related storage service to request api keys and secrets that allows a local user to fetch a scratch org from scratch org pool + +``` +USAGE + $ sfdx hardis:scratch:pool:localauth [-d] [--websocket ] [--skipauth] [-v ] [--apiversion ] + [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLE + $ sfdx hardis:scratch:pool:localauth +``` + +_See code: [lib/commands/hardis/scratch/pool/localauth.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/scratch/pool/localauth.js)_ + +## `sfdx hardis:scratch:pool:refresh [-d] [--websocket ] [--skipauth] [-v ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Create enough scratch orgs to fill the pool + +``` +USAGE + $ sfdx hardis:scratch:pool:refresh [-d] [--websocket ] [--skipauth] [-v ] [--apiversion ] + [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLE + $ sfdx hardis:scratch:pool:refresh +``` + +_See code: [lib/commands/hardis/scratch/pool/refresh.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/scratch/pool/refresh.js)_ + +## `sfdx hardis:scratch:pool:reset [-d] [--websocket ] [--skipauth] [-v ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Reset scratch org pool (delete all scratches in the pool) + +``` +USAGE + $ sfdx hardis:scratch:pool:reset [-d] [--websocket ] [--skipauth] [-v ] [--apiversion ] + [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLE + $ sfdx hardis:scratch:pool:refresh +``` + +_See code: [lib/commands/hardis/scratch/pool/reset.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/scratch/pool/reset.js)_ + +## `sfdx hardis:scratch:pool:view [-d] [--websocket ] [--skipauth] [-v ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Displays all stored content of project scratch org pool if defined + +``` +USAGE + $ sfdx hardis:scratch:pool:view [-d] [--websocket ] [--skipauth] [-v ] [--apiversion ] + [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLE + $ sfdx hardis:scratch:pool:view +``` + +_See code: [lib/commands/hardis/scratch/pool/view.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/scratch/pool/view.js)_ + +## `sfdx hardis:scratch:pull [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +This commands pulls the updates you performed in your scratch or sandbox org, into your local files + +``` +USAGE + $ sfdx hardis:scratch:pull [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] + [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +DESCRIPTION + Then, you probably want to stage and commit the files containing the updates you want to keep, as explained in this + video. + + + + - Calls sfdx force:source:pull under the hood + - If there are errors, proposes to automatically add erroneous item in `.forceignore`, then pull again + - If you want to always retrieve sources like CustomApplication that are not always detected as updates by + force:source:pull , you can define property **autoRetrieveWhenPull** in .sfdx-hardis.yml + + Example: + ```yaml + autoRetrieveWhenPull: + - CustomApplication:MyCustomApplication + - CustomApplication:MyOtherCustomApplication + - CustomApplication:MyThirdCustomApp + ``` + +EXAMPLE + $ sfdx hardis:scratch:pull +``` + +_See code: [lib/commands/hardis/scratch/pull.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/scratch/pull.js)_ + +## `sfdx hardis:scratch:push [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Push local files to scratch org + +``` +USAGE + $ sfdx hardis:scratch:push [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] + [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +DESCRIPTION + Calls `sfdx force:source:push` under the hood + +EXAMPLE + $ sfdx hardis:scratch:push +``` + +_See code: [lib/commands/hardis/scratch/push.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/scratch/push.js)_ + +## `sfdx hardis:source:deploy [--soapdeploy] [-w ] [--predestructivechanges ] [--postdestructivechanges ] [-f [-t | | [-q | -x | -m | -p | -c | -l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r | -o | -g]]] [--resultsdir ] [--coverageformatters ] [--junit] [--checkcoverage] [--debug] [--websocket ] [-u ] [--apiversion ] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +sfdx-hardis wrapper for sfdx force:source:deploy that displays tips to solve deployment errors. + +``` +USAGE + $ sfdx hardis:source:deploy [--soapdeploy] [-w ] [--predestructivechanges ] + [--postdestructivechanges ] [-f [-t | | [-q | -x | -m | -p | -c | -l + NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r | -o | -g]]] [--resultsdir ] + [--coverageformatters ] [--junit] [--checkcoverage] [--debug] [--websocket ] [-u ] + [--apiversion ] [--verbose] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -c, --checkonly checkonly + -f, --forceoverwrite forceoverwrite + -g, --ignorewarnings ignoreWarnings + -l, --testlevel=(NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg) [default: NoTestRun] testlevel + -m, --metadata=metadata metadata + -o, --ignoreerrors ignoreErrors + -p, --sourcepath=sourcepath sourcePath + -q, --validateddeployrequestid=validateddeployrequestid validateDeployRequestId + -r, --runtests=runtests [default: ] runTests + -t, --tracksource tracksource + + -u, --targetusername=targetusername username or alias for the target + org; overrides default target org + + -w, --wait=wait [default: 60 minutes] wait + + -x, --manifest=manifest flagsLong.manifest + + --apiversion=apiversion override the api version used for + api requests made by this command + + --checkcoverage Check Apex org coverage + + --coverageformatters=coverageformatters coverageformatters + + --debug debug + + --json format output as json + + --junit junit + + --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for + this command invocation + + --postdestructivechanges=postdestructivechanges postdestructivechanges + + --predestructivechanges=predestructivechanges predestructivechanges + + --resultsdir=resultsdir resultsdir + + --soapdeploy soapDeploy + + --verbose verbose + + --websocket=websocket websocket + +DESCRIPTION + Additional to the base command wrapper: If using **--checkonly**, add options **--checkcoverage** and + **--coverageformatters json-summary** to check that org coverage is > 75% (or value defined in .sfdx-hardis.yml + property **apexTestsMinCoverageOrgWide**) + + You can also have deployment results as pull request comments, on: + + - GitHub (see [GitHub Pull Requests comments + config](https://sfdx-hardis.cloudity.com/salesforce-ci-cd-setup-integration-github/)) + - Gitlab (see [Gitlab integration + configuration](https://sfdx-hardis.cloudity.com/salesforce-ci-cd-setup-integration-gitlab/)) + - Azure DevOps (see [Azure integration + configuration](https://sfdx-hardis.cloudity.com/salesforce-ci-cd-setup-integration-azure/)) + + + [![Assisted solving of Salesforce deployments + errors](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/article-deployment-errors.jpg)](http + s://nicolas.vuillamy.fr/assisted-solving-of-salesforce-deployments-errors-47f3666a9ed0) + + Notes: + + - You can disable coloring of errors in red by defining env variable SFDX_HARDIS_DEPLOY_ERR_COLORS=false + + [See documentation of Salesforce command](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sf + dx_cli_reference/cli_reference_force_source.htm#cli_reference_force_source_deploy) + +EXAMPLE + $ sfdx hardis:source:deploy -x manifest/package.xml --wait 60 --ignorewarnings --testlevel RunLocalTests + --postdestructivechanges ./manifest/destructiveChanges.xml --targetusername nicolas.vuillamy@cloudity.com.sfdxhardis + --checkonly --checkcoverage --verbose --coverageformatters json-summary +``` + +_See code: [lib/commands/hardis/source/deploy.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/source/deploy.js)_ + +## `sfdx hardis:source:push [-f] [-w ] [-g] [--debug] [--websocket ] [-u ] [--apiversion ] [--quiet] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +sfdx-hardis wrapper for sfdx force:source:push that displays tips to solve deployment errors. + +``` +USAGE + $ sfdx hardis:source:push [-f] [-w ] [-g] [--debug] [--websocket ] [-u ] [--apiversion + ] [--quiet] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -f, --forceoverwrite forceoverwrite + -g, --ignorewarnings ignorewarnings + + -u, --targetusername=targetusername username or alias for the target + org; overrides default target org + + -w, --wait=wait [default: 60 minutes] wait + + --apiversion=apiversion override the api version used for + api requests made by this command + + --debug debug + + --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 + + --quiet quiet + + --websocket=websocket websocket + +DESCRIPTION + [![Assisted solving of Salesforce deployments + errors](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/article-deployment-errors.jpg)](http + s://nicolas.vuillamy.fr/assisted-solving-of-salesforce-deployments-errors-47f3666a9ed0) + + [See documentation of Salesforce command](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sf + dx_cli_reference/cli_reference_force_source.htm#cli_reference_force_source_push) +``` + +_See code: [lib/commands/hardis/source/push.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/source/push.js)_ + +## `sfdx hardis:source:retrieve [-p | -x | -m ] [-w ] [-n ] [-f -t] [-d] [--websocket ] [--skipauth] [-u ] [-a ] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +sfdx-hardis wrapper for sfdx force:source:retrieve + +``` +USAGE + $ sfdx hardis:source:retrieve [-p | -x | -m ] [-w ] [-n ] [-f -t] [-d] + [--websocket ] [--skipauth] [-u ] [-a ] [--verbose] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -a, --apiversion=apiversion override the api version used for + api requests made by this command + + -d, --debug debugMode + + -f, --forceoverwrite forceoverwrite + + -m, --metadata=metadata metadata + + -n, --packagenames=packagenames packagenames + + -p, --sourcepath=sourcepath sourcePath + + -t, --tracksource tracksource + + -u, --targetusername=targetusername username or alias for the target + org; overrides default target org + + -w, --wait=wait wait + + -x, --manifest=manifest manifest + + --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 + + --skipauth Skip authentication check when a + default username is required + + --verbose verbose + + --websocket=websocket websocket + +DESCRIPTION + - If no retrieve constraint is sent, as assisted menu will request the list of metadatas to retrieve + - If no org is selected , an assisted menu will request the user to choose one + + [See documentation of Salesforce command](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sf + dx_cli_reference/cli_reference_force_source.htm#cli_reference_force_source_retrieve) +``` + +_See code: [lib/commands/hardis/source/retrieve.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/source/retrieve.js)_ + +## `sfdx hardis:work:new [-d] [--websocket ] [--skipauth] [-v ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Assisted menu to start working on a Salesforce task. + +``` +USAGE + $ sfdx hardis:work:new [-d] [--websocket ] [--skipauth] [-v ] [--apiversion ] [--json] + [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +DESCRIPTION + Advanced instructions in [Create New Task + documentation](https://sfdx-hardis.cloudity.com/salesforce-ci-cd-create-new-task/) + + At the end of the command, it will allow you to work on either a scratch org or a sandbox, depending on your choices. + + Under the hood, it can: + + - Make **git pull** to be up to date with target branch + - Create **new git branch** with formatted name (you can override the choices using .sfdx-hardis.yml property + **branchPrefixChoices**) + - Create and initialize a scratch org or a source-tracked sandbox (config can be defined using + `config/.sfdx-hardis.yml`): + - (and for scratch org only for now): + - **Install packages** + - Use property `installedPackages` + - **Push sources** + - **Assign permission sets** + - Use property `initPermissionSets` + - **Run apex initialization scripts** + - Use property `scratchOrgInitApexScripts` + - **Load data** + - Use property `dataPackages` + +EXAMPLE + $ sfdx hardis:work:task:new +``` + +_See code: [lib/commands/hardis/work/new.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/work/new.js)_ + +## `sfdx hardis:work:refresh [-n] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Make my local branch and my scratch org up to date with the most recent sources + +``` +USAGE + $ sfdx hardis:work:refresh [-n] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] + [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -n, --nopull No scratch pull before save (careful + if you use that!) + + -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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLE + $ sfdx hardis:work:refresh +``` + +_See code: [lib/commands/hardis/work/refresh.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/work/refresh.js)_ + +## `sfdx hardis:work:resetselection [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Resets the selection that we want to add in the merge request + +``` +USAGE + $ sfdx hardis:work:resetselection [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] + [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + + -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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +DESCRIPTION + Calls a soft git reset behind the hood + +EXAMPLE + $ sfdx hardis:work:resetsave +``` + +_See code: [lib/commands/hardis/work/resetselection.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/work/resetselection.js)_ + +## `sfdx hardis:work:save [-n] [-g] [-c] [--auto] [--targetbranch ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +When a work task is completed, guide user to create a merge request + +``` +USAGE + $ sfdx hardis:work:save [-n] [-g] [-c] [--auto] [--targetbranch ] [-d] [--websocket ] [--skipauth] [-u + ] [--apiversion ] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -c, --noclean No cleaning of local sources + -d, --debug Activate debug mode (more logs) + -g, --nogit No automated git operations + -n, --nopull No scratch pull before save + + -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 + + --auto No user prompts (when called from CI + for example) + + --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 + + --skipauth Skip authentication check when a + default username is required + + --targetbranch=targetbranch Name of the Merge Request target + branch. Will be guessed or prompted + if not provided. + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +DESCRIPTION + Advanced instructions in [Publish a task](https://sfdx-hardis.cloudity.com/salesforce-ci-cd-publish-task/) + + - Generate package-xml diff using sfdx-git-delta + - Automatically update `manifest/package.xml` and `manifest/destructiveChanges.xml` according to the committed updates + - Automatically Clean XML files using `.sfdx-hardis.yml` properties + - `autocleantypes`: List of auto-performed sources cleanings, available on command + [hardis:project:clean:references](https://sfdx-hardis.cloudity.com/hardis/project/clean/references/) + - `autoRemoveUserPermissions`: List of userPermission to automatically remove from profile metadatas + + Example: + + ```yaml + autoCleanTypes: + - checkPermissions + - destructivechanges + - datadotcom + - minimizeProfiles + - listViewsMine + autoRemoveUserPermissions: + - EnableCommunityAppLauncher + - FieldServiceAccess + - OmnichannelInventorySync + - SendExternalEmailAvailable + - UseOmnichannelInventoryAPIs + - ViewDataLeakageEvents + - ViewMLModels + - ViewPlatformEvents + - WorkCalibrationUser + ``` + + - Push commit to server + +EXAMPLES + $ sfdx hardis:work:task:save + $ sfdx hardis:work:task:save --nopull --nogit --noclean +``` + +_See code: [lib/commands/hardis/work/save.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/work/save.js)_ + +## `sfdx hardis:work:ws [-e ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +Technical calls to WebSocket functions + +``` +USAGE + $ sfdx hardis:work:ws [-e ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + +OPTIONS + -d, --debug Activate debug mode (more logs) + -e, --event=event WebSocket event + --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 + + --skipauth Skip authentication check when a + default username is required + + --websocket=websocket Websocket host:port for VsCode SFDX + Hardis UI integration + +EXAMPLE + $ sfdx hardis:work:ws --event refreshStatus +``` + +_See code: [lib/commands/hardis/work/ws.js](https://github.com/hardisgroupcom/sfdx-hardis/blob/v4.13.0/lib/commands/hardis/work/ws.js)_ + +* [`sfdx hardis:auth:login [-r ] [-h] [-s] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisauthlogin--r-string--h--s--d---websocket-string---skipauth---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:cache:clear [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardiscacheclear--d---websocket-string---skipauth---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:config:get [-l ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisconfigget--l-string--d---websocket-string---skipauth---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:doc:extract:permsetgroups [-o ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisdocextractpermsetgroups--o-string--d---websocket-string---skipauth---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx hardis:doc:plugin:generate [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardisdocplugingenerate--d---websocket-string---skipauth---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) * [`sfdx hardis:lint:access [-e ] [-i ] [-f ] [-d] [--websocket ] [--skipauth] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardislintaccess--e-string--i-string--f-string--d---websocket-string---skipauth---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) * [`sfdx hardis:mdapi:deploy [-d ] [-w ] [-q | -l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r | -o | -g | -c] [-f ] [-s] [--soapdeploy] [--purgeondelete] [--debug] [--websocket ] [-u ] [--apiversion ] [--verbose] [--concise] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardismdapideploy--d-directory--w-minutes--q-id---l-notestrunrunspecifiedtestsrunlocaltestsrunalltestsinorg---r-array---o---g---c--f-filepath--s---soapdeploy---purgeondelete---debug---websocket-string--u-string---apiversion-string---verbose---concise---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) * [`sfdx hardis:misc:toml2csv -f [-t ] [-l ] [-s] [-o ] [-d] [--websocket ] [--skipauth] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hardismisctoml2csv--f-string--t-string--l-array--s--o-string--d---websocket-string---skipauth--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) diff --git a/docs/deployTips.md b/docs/deployTips.md index cc33fa09b..f1ca520e0 100644 --- a/docs/deployTips.md +++ b/docs/deployTips.md @@ -8,11 +8,11 @@ description: Learn how to fix issues that can happen during sfdx deployments This page summarizes all errors that can be detected by sfdx-hardis wrapper commands -| sfdx command | sfdx-hardis wrapper command | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------| -| [sfdx force:source:deploy](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_force_source.htm#cli_reference_force_source_deploy) | [sfdx hardis:source:deploy](https://sfdx-hardis.cloudity.com/hardis/source/deploy/) | -| [sfdx force:source:push](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_force_source.htm#cli_reference_force_source_push) | [sfdx hardis:source:push](https://sfdx-hardis.cloudity.com/hardis/source/push/) | -| [sfdx force:mdapi:deploy](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_force_mdapi.htm#cli_reference_force_mdapi_beta_deploy) | [sfdx hardis:mdapi:deploy](https://sfdx-hardis.cloudity.com/hardis/mdapi/deploy/) | +| sfdx command | sfdx-hardis wrapper command | +| :----------- | :-------------------------- | +| [sfdx force:source:deploy](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_force_source.htm#cli_reference_force_source_deploy) | [sfdx hardis:source:deploy](https://sfdx-hardis.cloudity.com/hardis/source/deploy/) | +| [sfdx force:source:push](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_force_source.htm#cli_reference_force_source_push) | [sfdx hardis:source:push](https://sfdx-hardis.cloudity.com/hardis/source/push/) | +| [sfdx force:mdapi:deploy](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_force_mdapi.htm#cli_reference_force_mdapi_beta_deploy) | [sfdx hardis:mdapi:deploy](https://sfdx-hardis.cloudity.com/hardis/mdapi/deploy/) | You can also use this function on a [sfdx-hardis Salesforce CI/CD project](https://sfdx-hardis.cloudity.com/salesforce-ci-cd-home/) @@ -302,7 +302,7 @@ You probably also need to add CRM Analytics Admin Permission Set assignment to t ## Error parsing file -- `Error (.*) Error parsing file: (.*)` +- `Error (.*) Error parsing file: (.*) ` **Resolution tip** @@ -912,7 +912,7 @@ Please check https://developer.salesforce.com/forums/?id=9060G0000005kVLQAY ## Test classes with 0% coverage -- `0%` +- ` 0%` **Resolution tip** diff --git a/docs/schema/sfdx-hardis-json-schema-parameters.html b/docs/schema/sfdx-hardis-json-schema-parameters.html index ae673ccd9..c31f54b3c 100644 --- a/docs/schema/sfdx-hardis-json-schema-parameters.html +++ b/docs/schema/sfdx-hardis-json-schema-parameters.html @@ -148,7 +148,7 @@

Each item of this array must be:

autoCleanTypes itemsType: enum (of string)

Must be one of:

-
  • "caseentitlement"
  • "dashboards"
  • "datadotcom"
  • "destructivechanges"
  • "localfields"
  • "listViewsMine"
  • "minimizeProfiles"
  • "productrequest"
  • "systemDebug"
+
  • "caseentitlement"
  • "checkPermissions"
  • "dashboards"
  • "datadotcom"
  • "destructivechanges"
  • "localfields"
  • "listViewsMine"
  • "minimizeProfiles"
  • "productrequest"
  • "systemDebug"
@@ -3665,6 +3665,80 @@

+
+
+
+

+ +

+
+ +
+
+ + Type: object
+

Override list of Setup Audit Trail elements that won't be considered as suspect by monitoring tools

+
+ + + + + + +
+
+
+

+ +

+
+ +
+

Additional Properties of any type are allowed.

+ + Type: object
+ + + + + + + +
+
+
+
+
+
+
+
@@ -4621,6 +4695,6 @@

\ No newline at end of file diff --git a/package.json b/package.json index fed6e5b7e..d924e7578 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "sfdx-hardis", "description": "Swiss-army-knife Toolbox for Salesforce\nAllows you to define a complete CD/CD Pipeline\nOrchestrate base commands and assist users with interactive wizards", - "version": "4.12.2", + "version": "4.13.0", "author": "NicolasVuillamy @nvuillam", "bugs": "https://github.com/hardisgroupcom/sfdx-hardis/issues", "dependencies": {