sfdx-hardis 6.4.0 → 6.4.1-beta202509082207.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/oclif.manifest.json +577 -577
- package/package.json +1 -1
package/oclif.manifest.json
CHANGED
|
@@ -132,13 +132,12 @@
|
|
|
132
132
|
"clear:cache:hardis"
|
|
133
133
|
]
|
|
134
134
|
},
|
|
135
|
-
"hardis:
|
|
135
|
+
"hardis:config:get": {
|
|
136
136
|
"aliases": [],
|
|
137
137
|
"args": {},
|
|
138
|
-
"description": "\n## Command Behavior\n\n**
|
|
138
|
+
"description": "\n## Command Behavior\n\n**Retrieves and displays the sfdx-hardis configuration for a specified level.**\n\nThis command allows you to inspect the configuration that is currently in effect for your project, which is useful for debugging and understanding how sfdx-hardis will behave.\n\n- **Configuration levels:** It can retrieve configuration from three different levels:\n - **Project:** The configuration defined in the project's `.sfdx-hardis.yml` file.\n - **Branch:** The configuration defined in a branch-specific configuration file (e.g., `.sfdx-hardis.production.yml`).\n - **User:** The global user-level configuration.\n\n## Technical explanations\n\nThe command's logic is straightforward:\n\n- **`getConfig` function:** It calls the `getConfig` utility function, passing the desired configuration level as an argument.\n- **Configuration loading:** The `getConfig` function is responsible for finding the appropriate configuration file, reading its contents, and parsing it as YAML or JSON.\n- **Output:** The retrieved configuration is then displayed to the user as a JSON string.\n",
|
|
139
139
|
"examples": [
|
|
140
|
-
"$ sf hardis:
|
|
141
|
-
"CI=true sf hardis:auth:login"
|
|
140
|
+
"$ sf hardis:project:deploy:sources:metadata"
|
|
142
141
|
],
|
|
143
142
|
"flags": {
|
|
144
143
|
"json": {
|
|
@@ -156,28 +155,20 @@
|
|
|
156
155
|
"multiple": false,
|
|
157
156
|
"type": "option"
|
|
158
157
|
},
|
|
159
|
-
"
|
|
160
|
-
"char": "
|
|
161
|
-
"description": "
|
|
162
|
-
"name": "
|
|
158
|
+
"level": {
|
|
159
|
+
"char": "l",
|
|
160
|
+
"description": "project,branch or user",
|
|
161
|
+
"name": "level",
|
|
162
|
+
"default": "project",
|
|
163
163
|
"hasDynamicHelp": false,
|
|
164
164
|
"multiple": false,
|
|
165
|
+
"options": [
|
|
166
|
+
"project",
|
|
167
|
+
"branch",
|
|
168
|
+
"user"
|
|
169
|
+
],
|
|
165
170
|
"type": "option"
|
|
166
171
|
},
|
|
167
|
-
"devhub": {
|
|
168
|
-
"char": "h",
|
|
169
|
-
"description": "Also connect associated DevHub",
|
|
170
|
-
"name": "devhub",
|
|
171
|
-
"allowNo": false,
|
|
172
|
-
"type": "boolean"
|
|
173
|
-
},
|
|
174
|
-
"scratchorg": {
|
|
175
|
-
"char": "s",
|
|
176
|
-
"description": "Scratch org",
|
|
177
|
-
"name": "scratchorg",
|
|
178
|
-
"allowNo": false,
|
|
179
|
-
"type": "boolean"
|
|
180
|
-
},
|
|
181
172
|
"debug": {
|
|
182
173
|
"char": "d",
|
|
183
174
|
"description": "Activate debug mode (more logs)",
|
|
@@ -201,38 +192,39 @@
|
|
|
201
192
|
},
|
|
202
193
|
"hasDynamicHelp": false,
|
|
203
194
|
"hiddenAliases": [],
|
|
204
|
-
"id": "hardis:
|
|
195
|
+
"id": "hardis:config:get",
|
|
205
196
|
"pluginAlias": "sfdx-hardis",
|
|
206
197
|
"pluginName": "sfdx-hardis",
|
|
207
198
|
"pluginType": "core",
|
|
208
199
|
"strict": true,
|
|
209
200
|
"enableJsonFlag": true,
|
|
210
|
-
"title": "
|
|
201
|
+
"title": "Deploy metadata sources to org",
|
|
211
202
|
"requiresProject": false,
|
|
212
203
|
"isESM": true,
|
|
213
204
|
"relativePath": [
|
|
214
205
|
"lib",
|
|
215
206
|
"commands",
|
|
216
207
|
"hardis",
|
|
217
|
-
"
|
|
218
|
-
"
|
|
208
|
+
"config",
|
|
209
|
+
"get.js"
|
|
219
210
|
],
|
|
220
211
|
"aliasPermutations": [],
|
|
221
212
|
"permutations": [
|
|
222
|
-
"hardis:
|
|
223
|
-
"
|
|
224
|
-
"
|
|
225
|
-
"hardis:
|
|
226
|
-
"
|
|
227
|
-
"
|
|
213
|
+
"hardis:config:get",
|
|
214
|
+
"config:hardis:get",
|
|
215
|
+
"config:get:hardis",
|
|
216
|
+
"hardis:get:config",
|
|
217
|
+
"get:hardis:config",
|
|
218
|
+
"get:config:hardis"
|
|
228
219
|
]
|
|
229
220
|
},
|
|
230
|
-
"hardis:
|
|
221
|
+
"hardis:auth:login": {
|
|
231
222
|
"aliases": [],
|
|
232
223
|
"args": {},
|
|
233
|
-
"description": "\n## Command Behavior\n\n**
|
|
224
|
+
"description": "\n## Command Behavior\n\n**Authenticates to a Salesforce org, primarily designed for CI/CD workflows.**\n\nThis command facilitates secure and automated logins to Salesforce organizations within continuous integration and continuous delivery pipelines. It leverages pre-configured authentication details, ensuring that CI/CD processes can interact with Salesforce without manual intervention.\n\nKey aspects:\n\n- **Configuration-Driven:** It relies on authentication variables and files set up by dedicated configuration commands:\n - For CI/CD repositories: [Configure Org CI Authentication](https://sfdx-hardis.cloudity.com/hardis/project/configure/auth/)\n - For Monitoring repositories: [Configure Org Monitoring](https://sfdx-hardis.cloudity.com/hardis/org/configure/monitoring/)\n- **Technical Org Support:** Supports authentication to a 'technical org' (e.g., for calling Agentforce from another org) by utilizing the `SFDX_AUTH_URL_TECHNICAL_ORG` environment variable. If this variable is set, the command authenticates to this org with the alias `TECHNICAL_ORG`.\n\nTo obtain the `SFDX_AUTH_URL_TECHNICAL_ORG` value, you can run `sf org display --verbose --json` and copy the `sfdxAuthUrl` field from the output.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical flow involves:\n\n- **Flag Parsing:** It parses command-line flags such as `instanceurl`, `devhub`, `scratchorg`, and `debug` to determine the authentication context.\n- **Authentication Hook:** It triggers an internal authentication hook (`this.config.runHook('auth', ...`)) which is responsible for executing the actual authentication logic based on the provided flags (e.g., whether it's a Dev Hub or a scratch org).\n- **Environment Variable Check:** It checks for the presence of `SFDX_AUTH_URL_TECHNICAL_ORG` or `TECHNICAL_ORG_ALIAS` environment variables.\n- **`authOrg` Utility:** If a technical org is configured, it calls the `authOrg` utility function to perform the authentication for that specific org, ensuring it's connected and available for subsequent operations.\n- **Salesforce CLI Integration:** It integrates with the Salesforce CLI's authentication mechanisms to establish and manage org connections.\n</details>\n",
|
|
234
225
|
"examples": [
|
|
235
|
-
"$ sf hardis:
|
|
226
|
+
"$ sf hardis:auth:login",
|
|
227
|
+
"CI=true sf hardis:auth:login"
|
|
236
228
|
],
|
|
237
229
|
"flags": {
|
|
238
230
|
"json": {
|
|
@@ -250,20 +242,28 @@
|
|
|
250
242
|
"multiple": false,
|
|
251
243
|
"type": "option"
|
|
252
244
|
},
|
|
253
|
-
"
|
|
254
|
-
"char": "
|
|
255
|
-
"description": "
|
|
256
|
-
"name": "
|
|
257
|
-
"default": "project",
|
|
245
|
+
"instanceurl": {
|
|
246
|
+
"char": "r",
|
|
247
|
+
"description": "URL of org instance",
|
|
248
|
+
"name": "instanceurl",
|
|
258
249
|
"hasDynamicHelp": false,
|
|
259
250
|
"multiple": false,
|
|
260
|
-
"options": [
|
|
261
|
-
"project",
|
|
262
|
-
"branch",
|
|
263
|
-
"user"
|
|
264
|
-
],
|
|
265
251
|
"type": "option"
|
|
266
252
|
},
|
|
253
|
+
"devhub": {
|
|
254
|
+
"char": "h",
|
|
255
|
+
"description": "Also connect associated DevHub",
|
|
256
|
+
"name": "devhub",
|
|
257
|
+
"allowNo": false,
|
|
258
|
+
"type": "boolean"
|
|
259
|
+
},
|
|
260
|
+
"scratchorg": {
|
|
261
|
+
"char": "s",
|
|
262
|
+
"description": "Scratch org",
|
|
263
|
+
"name": "scratchorg",
|
|
264
|
+
"allowNo": false,
|
|
265
|
+
"type": "boolean"
|
|
266
|
+
},
|
|
267
267
|
"debug": {
|
|
268
268
|
"char": "d",
|
|
269
269
|
"description": "Activate debug mode (more logs)",
|
|
@@ -287,30 +287,30 @@
|
|
|
287
287
|
},
|
|
288
288
|
"hasDynamicHelp": false,
|
|
289
289
|
"hiddenAliases": [],
|
|
290
|
-
"id": "hardis:
|
|
290
|
+
"id": "hardis:auth:login",
|
|
291
291
|
"pluginAlias": "sfdx-hardis",
|
|
292
292
|
"pluginName": "sfdx-hardis",
|
|
293
293
|
"pluginType": "core",
|
|
294
294
|
"strict": true,
|
|
295
295
|
"enableJsonFlag": true,
|
|
296
|
-
"title": "
|
|
296
|
+
"title": "Login",
|
|
297
297
|
"requiresProject": false,
|
|
298
298
|
"isESM": true,
|
|
299
299
|
"relativePath": [
|
|
300
300
|
"lib",
|
|
301
301
|
"commands",
|
|
302
302
|
"hardis",
|
|
303
|
-
"
|
|
304
|
-
"
|
|
303
|
+
"auth",
|
|
304
|
+
"login.js"
|
|
305
305
|
],
|
|
306
306
|
"aliasPermutations": [],
|
|
307
307
|
"permutations": [
|
|
308
|
-
"hardis:
|
|
309
|
-
"
|
|
310
|
-
"
|
|
311
|
-
"hardis:
|
|
312
|
-
"
|
|
313
|
-
"
|
|
308
|
+
"hardis:auth:login",
|
|
309
|
+
"auth:hardis:login",
|
|
310
|
+
"auth:login:hardis",
|
|
311
|
+
"hardis:login:auth",
|
|
312
|
+
"login:hardis:auth",
|
|
313
|
+
"login:auth:hardis"
|
|
314
314
|
]
|
|
315
315
|
},
|
|
316
316
|
"hardis:doc:fieldusage": {
|
|
@@ -5538,12 +5538,13 @@
|
|
|
5538
5538
|
"import:data:org:hardis"
|
|
5539
5539
|
]
|
|
5540
5540
|
},
|
|
5541
|
-
"hardis:org:
|
|
5541
|
+
"hardis:org:fix:listviewmine": {
|
|
5542
5542
|
"aliases": [],
|
|
5543
5543
|
"args": {},
|
|
5544
|
-
"description": "
|
|
5544
|
+
"description": "Fix listviews whose scope Mine has been replaced by Everything\n\n[](https://nicolas.vuillamy.fr/invalid-scope-mine-not-allowed-deploy-your-listviews-anyway-443aceca8ac7)\n\nList of ListViews can be:\n\n- read from .sfdx-hardis.yml file in property **listViewsToSetToMine**\n- sent in argument listviews\n\nNote: property **listViewsToSetToMine** can be auto-generated by command hardis:work:save if .sfdx-hardis.yml contains the following configuration\n\n```yaml\nautoCleanTypes:\n - listViewsMine\n```\n\n- Example of sfdx-hardis.yml property `listViewsToSetToMine`:\n\n```yaml\nlistViewsToSetToMine:\n - \"force-app/main/default/objects/Operation__c/listViews/MyCurrentOperations.listView-meta.xml\"\n - \"force-app/main/default/objects/Operation__c/listViews/MyFinalizedOperations.listView-meta.xml\"\n - \"force-app/main/default/objects/Opportunity/listViews/Default_Opportunity_Pipeline.listView-meta.xml\"\n - \"force-app/main/default/objects/Opportunity/listViews/MyCurrentSubscriptions.listView-meta.xml\"\n - \"force-app/main/default/objects/Opportunity/listViews/MySubscriptions.listView-meta.xml\"\n - \"force-app/main/default/objects/Account/listViews/MyActivePartners.listView-meta.xml\"\n```\n\n- If manually written, this could also be:\n\n```yaml\nlistViewsToSetToMine:\n - \"Operation__c:MyCurrentOperations\"\n - \"Operation__c:MyFinalizedOperations\"\n - \"Opportunity:Default_Opportunity_Pipeline\"\n - \"Opportunity:MyCurrentSubscriptions\"\n - \"Opportunity:MySubscriptions\"\n - \"Account:MyActivePartners\"\n```\n\nTroubleshooting: if you need to run this command from an alpine-linux based docker image, use this workaround in your dockerfile:\n\n```dockerfile\n# Do not use puppeteer embedded chromium\nRUN apk add --update --no-cache chromium\nENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=\"true\"\nENV CHROMIUM_PATH=\"/usr/bin/chromium-browser\"\nENV PUPPETEER_EXECUTABLE_PATH=\"$\\{CHROMIUM_PATH}\" // remove \\ before {\n```\n",
|
|
5545
5545
|
"examples": [
|
|
5546
|
-
"$ sf hardis:org:
|
|
5546
|
+
"$ sf hardis:org:fix:listviewmine",
|
|
5547
|
+
"$ sf hardis:org:fix:listviewmine --listviews Opportunity:MySubscriptions,Account:MyActivePartners"
|
|
5547
5548
|
],
|
|
5548
5549
|
"flags": {
|
|
5549
5550
|
"json": {
|
|
@@ -5561,37 +5562,10 @@
|
|
|
5561
5562
|
"multiple": false,
|
|
5562
5563
|
"type": "option"
|
|
5563
5564
|
},
|
|
5564
|
-
"
|
|
5565
|
-
"char": "
|
|
5566
|
-
"description": "
|
|
5567
|
-
"name": "
|
|
5568
|
-
"hasDynamicHelp": false,
|
|
5569
|
-
"multiple": false,
|
|
5570
|
-
"type": "option"
|
|
5571
|
-
},
|
|
5572
|
-
"chunksize": {
|
|
5573
|
-
"char": "c",
|
|
5574
|
-
"description": "Number of records to add in a chunk before it is processed",
|
|
5575
|
-
"name": "chunksize",
|
|
5576
|
-
"default": 1000,
|
|
5577
|
-
"hasDynamicHelp": false,
|
|
5578
|
-
"multiple": false,
|
|
5579
|
-
"type": "option"
|
|
5580
|
-
},
|
|
5581
|
-
"polltimeout": {
|
|
5582
|
-
"char": "t",
|
|
5583
|
-
"description": "Timeout in MS for Bulk API calls",
|
|
5584
|
-
"name": "polltimeout",
|
|
5585
|
-
"default": 300000,
|
|
5586
|
-
"hasDynamicHelp": false,
|
|
5587
|
-
"multiple": false,
|
|
5588
|
-
"type": "option"
|
|
5589
|
-
},
|
|
5590
|
-
"startchunknumber": {
|
|
5591
|
-
"char": "s",
|
|
5592
|
-
"description": "Chunk number to start from",
|
|
5593
|
-
"name": "startchunknumber",
|
|
5594
|
-
"default": 0,
|
|
5565
|
+
"listviews": {
|
|
5566
|
+
"char": "l",
|
|
5567
|
+
"description": "Comma-separated list of listviews following format Object:ListViewName\nExample: Contact:MyContacts,Contact:MyActiveContacts,Opportunity:MYClosedOpportunities",
|
|
5568
|
+
"name": "listviews",
|
|
5595
5569
|
"hasDynamicHelp": false,
|
|
5596
5570
|
"multiple": false,
|
|
5597
5571
|
"type": "option"
|
|
@@ -5634,57 +5608,60 @@
|
|
|
5634
5608
|
},
|
|
5635
5609
|
"hasDynamicHelp": true,
|
|
5636
5610
|
"hiddenAliases": [],
|
|
5637
|
-
"id": "hardis:org:
|
|
5611
|
+
"id": "hardis:org:fix:listviewmine",
|
|
5638
5612
|
"pluginAlias": "sfdx-hardis",
|
|
5639
5613
|
"pluginName": "sfdx-hardis",
|
|
5640
5614
|
"pluginType": "core",
|
|
5641
5615
|
"strict": true,
|
|
5642
5616
|
"enableJsonFlag": true,
|
|
5643
|
-
"title": "
|
|
5644
|
-
"requiresProject":
|
|
5617
|
+
"title": "Fix listviews with ",
|
|
5618
|
+
"requiresProject": true,
|
|
5645
5619
|
"isESM": true,
|
|
5646
5620
|
"relativePath": [
|
|
5647
5621
|
"lib",
|
|
5648
5622
|
"commands",
|
|
5649
5623
|
"hardis",
|
|
5650
5624
|
"org",
|
|
5651
|
-
"
|
|
5652
|
-
"
|
|
5625
|
+
"fix",
|
|
5626
|
+
"listviewmine.js"
|
|
5653
5627
|
],
|
|
5654
5628
|
"aliasPermutations": [],
|
|
5655
5629
|
"permutations": [
|
|
5656
|
-
"hardis:org:
|
|
5657
|
-
"org:hardis:
|
|
5658
|
-
"org:
|
|
5659
|
-
"org:
|
|
5660
|
-
"hardis:
|
|
5661
|
-
"
|
|
5662
|
-
"
|
|
5663
|
-
"
|
|
5664
|
-
"hardis:
|
|
5665
|
-
"
|
|
5666
|
-
"
|
|
5667
|
-
"
|
|
5668
|
-
"hardis:org:
|
|
5669
|
-
"org:hardis:
|
|
5670
|
-
"org:
|
|
5671
|
-
"org:
|
|
5672
|
-
"hardis:
|
|
5673
|
-
"
|
|
5674
|
-
"
|
|
5675
|
-
"
|
|
5676
|
-
"hardis:
|
|
5677
|
-
"
|
|
5678
|
-
"
|
|
5679
|
-
"
|
|
5630
|
+
"hardis:org:fix:listviewmine",
|
|
5631
|
+
"org:hardis:fix:listviewmine",
|
|
5632
|
+
"org:fix:hardis:listviewmine",
|
|
5633
|
+
"org:fix:listviewmine:hardis",
|
|
5634
|
+
"hardis:fix:org:listviewmine",
|
|
5635
|
+
"fix:hardis:org:listviewmine",
|
|
5636
|
+
"fix:org:hardis:listviewmine",
|
|
5637
|
+
"fix:org:listviewmine:hardis",
|
|
5638
|
+
"hardis:fix:listviewmine:org",
|
|
5639
|
+
"fix:hardis:listviewmine:org",
|
|
5640
|
+
"fix:listviewmine:hardis:org",
|
|
5641
|
+
"fix:listviewmine:org:hardis",
|
|
5642
|
+
"hardis:org:listviewmine:fix",
|
|
5643
|
+
"org:hardis:listviewmine:fix",
|
|
5644
|
+
"org:listviewmine:hardis:fix",
|
|
5645
|
+
"org:listviewmine:fix:hardis",
|
|
5646
|
+
"hardis:listviewmine:org:fix",
|
|
5647
|
+
"listviewmine:hardis:org:fix",
|
|
5648
|
+
"listviewmine:org:hardis:fix",
|
|
5649
|
+
"listviewmine:org:fix:hardis",
|
|
5650
|
+
"hardis:listviewmine:fix:org",
|
|
5651
|
+
"listviewmine:hardis:fix:org",
|
|
5652
|
+
"listviewmine:fix:hardis:org",
|
|
5653
|
+
"listviewmine:fix:org:hardis"
|
|
5680
5654
|
]
|
|
5681
5655
|
},
|
|
5682
|
-
"hardis:org:
|
|
5656
|
+
"hardis:org:diagnose:audittrail": {
|
|
5683
5657
|
"aliases": [],
|
|
5684
5658
|
"args": {},
|
|
5685
|
-
"description": "
|
|
5659
|
+
"description": "Export Audit trail into a CSV file with selected criteria, and highlight suspect actions\n\nAlso detects updates of Custom Settings values (disable by defining `SKIP_AUDIT_TRAIL_CUSTOM_SETTINGS=true`)\n\nRegular setup actions performed in major orgs are filtered.\n\n- \"\"\n - createScratchOrg\n - changedsenderemail\n - deleteScratchOrg\n - loginasgrantedtopartnerbt\n- Certificate and Key Management\n - insertCertificate\n- Custom App Licenses\n - addeduserpackagelicense\n - granteduserpackagelicense\n - revokeduserpackagelicense\n- Customer Portal\n - createdcustomersuccessuser\n - CSPUserDisabled\n- Currency\n - updateddatedexchrate\n- Data Management\n - queueMembership\n- Email Administration\n - dkimRotationPreparationSuccessful\n - dkimRotationSuccessful\n- External Objects\n - xdsEncryptedFieldChange\n- Groups\n - groupMembership\n- Holidays\n - holiday_insert\n- Inbox mobile and legacy desktop apps\n - enableSIQUserNonEAC\n - siqUserAcceptedTOS\n- Manage Users\n - activateduser\n - createduser\n - changedcommunitynickname\n - changedemail\n - changedfederationid\n - changedpassword\n - changedinteractionuseroffon\n - changedinteractionuseronoff\n - changedmarketinguseroffon\n - changedmarketinguseronoff\n - changedofflineuseroffon\n - changedprofileforuserstdtostd\n - changedprofileforuser\n - changedprofileforusercusttostd\n - changedprofileforuserstdtocust\n - changedroleforusertonone\n - changedroleforuser\n - changedroleforuserfromnone\n - changedUserAdminVerifiedStatusVerified\n - changedUserEmailVerifiedStatusUnverified\n - changedUserEmailVerifiedStatusVerified\n - changedknowledgeuseroffon\n - changedsfcontentuseroffon\n - changedsupportuseroffon\n - changedusername\n - changedUserPhoneNumber\n - changedUserPhoneVerifiedStatusUnverified\n - changedUserPhoneVerifiedStatusVerified\n - deactivateduser\n - deleteAuthenticatorPairing\n - deleteTwoFactorInfo2\n - deleteTwoFactorTempCode\n - frozeuser\n - insertAuthenticatorPairing\n - insertTwoFactorInfo2\n - insertTwoFactorTempCode\n - lightningloginenroll\n - PermSetAssign\n - PermSetGroupAssign\n - PermSetGroupUnassign\n - PermSetLicenseAssign\n - PermSetUnassign\n - PermSetLicenseUnassign\n - registeredUserPhoneNumber\n - resetpassword\n - suNetworkAdminLogin\n - suNetworkAdminLogout\n - suOrgAdminLogin\n - suOrgAdminLogout\n - unfrozeuser\n - useremailchangesent\n- Mobile Administration\n - assigneduserstomobileconfig\n- Reporting Snapshots\n - createdReportJob\n - deletedReportJob\n- Sandboxes\n - DeleteSandbox\n\nBy default, deployment user defined in .sfdx-hardis.yml targetUsername property will be excluded.\n\nYou can define additional users to exclude in .sfdx-hardis.yml **monitoringExcludeUsernames** property.\n\nYou can also add more sections / actions considered as not suspect using property **monitoringAllowedSectionsActions**\n\nExample:\n\n```yaml\nmonitoringExcludeUsernames:\n - deploymentuser@cloudity.com\n - marketingcloud@cloudity.com\n - integration-user@cloudity.com\n\nmonitoringAllowedSectionsActions:\n \"Some section\": [] // Will ignore all actions from such section\n \"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.\n```\n\n## Excel output example\n\n\n\n## Local output example\n\n\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-suspect-audit-trail/) and can output Grafana, Slack and MsTeams Notifications.\n",
|
|
5686
5660
|
"examples": [
|
|
5687
|
-
"$ sf hardis:org:
|
|
5661
|
+
"$ sf hardis:org:diagnose:audittrail",
|
|
5662
|
+
"$ sf hardis:org:diagnose:audittrail --excludeusers baptiste@titi.com",
|
|
5663
|
+
"$ sf hardis:org:diagnose:audittrail --excludeusers baptiste@titi.com,bertrand@titi.com",
|
|
5664
|
+
"$ sf hardis:org:diagnose:audittrail --lastndays 5"
|
|
5688
5665
|
],
|
|
5689
5666
|
"flags": {
|
|
5690
5667
|
"json": {
|
|
@@ -5702,20 +5679,29 @@
|
|
|
5702
5679
|
"multiple": false,
|
|
5703
5680
|
"type": "option"
|
|
5704
5681
|
},
|
|
5705
|
-
"
|
|
5706
|
-
"char": "
|
|
5707
|
-
"description": "
|
|
5708
|
-
"name": "
|
|
5682
|
+
"excludeusers": {
|
|
5683
|
+
"char": "e",
|
|
5684
|
+
"description": "Comma-separated list of usernames to exclude",
|
|
5685
|
+
"name": "excludeusers",
|
|
5709
5686
|
"hasDynamicHelp": false,
|
|
5710
5687
|
"multiple": false,
|
|
5711
5688
|
"type": "option"
|
|
5712
5689
|
},
|
|
5713
|
-
"
|
|
5690
|
+
"lastndays": {
|
|
5691
|
+
"char": "t",
|
|
5692
|
+
"description": "Number of days to extract from today (included)",
|
|
5693
|
+
"name": "lastndays",
|
|
5694
|
+
"hasDynamicHelp": false,
|
|
5695
|
+
"multiple": false,
|
|
5696
|
+
"type": "option"
|
|
5697
|
+
},
|
|
5698
|
+
"outputfile": {
|
|
5714
5699
|
"char": "f",
|
|
5715
|
-
"description": "
|
|
5716
|
-
"name": "
|
|
5717
|
-
"
|
|
5718
|
-
"
|
|
5700
|
+
"description": "Force the path and name of output report file. Must end with .csv",
|
|
5701
|
+
"name": "outputfile",
|
|
5702
|
+
"hasDynamicHelp": false,
|
|
5703
|
+
"multiple": false,
|
|
5704
|
+
"type": "option"
|
|
5719
5705
|
},
|
|
5720
5706
|
"debug": {
|
|
5721
5707
|
"char": "d",
|
|
@@ -5755,13 +5741,13 @@
|
|
|
5755
5741
|
},
|
|
5756
5742
|
"hasDynamicHelp": true,
|
|
5757
5743
|
"hiddenAliases": [],
|
|
5758
|
-
"id": "hardis:org:
|
|
5744
|
+
"id": "hardis:org:diagnose:audittrail",
|
|
5759
5745
|
"pluginAlias": "sfdx-hardis",
|
|
5760
5746
|
"pluginName": "sfdx-hardis",
|
|
5761
5747
|
"pluginType": "core",
|
|
5762
5748
|
"strict": true,
|
|
5763
5749
|
"enableJsonFlag": true,
|
|
5764
|
-
"title": "
|
|
5750
|
+
"title": "Diagnose content of Setup Audit Trail",
|
|
5765
5751
|
"requiresProject": false,
|
|
5766
5752
|
"isESM": true,
|
|
5767
5753
|
"relativePath": [
|
|
@@ -5769,141 +5755,8 @@
|
|
|
5769
5755
|
"commands",
|
|
5770
5756
|
"hardis",
|
|
5771
5757
|
"org",
|
|
5772
|
-
"
|
|
5773
|
-
"
|
|
5774
|
-
],
|
|
5775
|
-
"aliasPermutations": [],
|
|
5776
|
-
"permutations": [
|
|
5777
|
-
"hardis:org:files:import",
|
|
5778
|
-
"org:hardis:files:import",
|
|
5779
|
-
"org:files:hardis:import",
|
|
5780
|
-
"org:files:import:hardis",
|
|
5781
|
-
"hardis:files:org:import",
|
|
5782
|
-
"files:hardis:org:import",
|
|
5783
|
-
"files:org:hardis:import",
|
|
5784
|
-
"files:org:import:hardis",
|
|
5785
|
-
"hardis:files:import:org",
|
|
5786
|
-
"files:hardis:import:org",
|
|
5787
|
-
"files:import:hardis:org",
|
|
5788
|
-
"files:import:org:hardis",
|
|
5789
|
-
"hardis:org:import:files",
|
|
5790
|
-
"org:hardis:import:files",
|
|
5791
|
-
"org:import:hardis:files",
|
|
5792
|
-
"org:import:files:hardis",
|
|
5793
|
-
"hardis:import:org:files",
|
|
5794
|
-
"import:hardis:org:files",
|
|
5795
|
-
"import:org:hardis:files",
|
|
5796
|
-
"import:org:files:hardis",
|
|
5797
|
-
"hardis:import:files:org",
|
|
5798
|
-
"import:hardis:files:org",
|
|
5799
|
-
"import:files:hardis:org",
|
|
5800
|
-
"import:files:org:hardis"
|
|
5801
|
-
]
|
|
5802
|
-
},
|
|
5803
|
-
"hardis:org:diagnose:audittrail": {
|
|
5804
|
-
"aliases": [],
|
|
5805
|
-
"args": {},
|
|
5806
|
-
"description": "Export Audit trail into a CSV file with selected criteria, and highlight suspect actions\n\nAlso detects updates of Custom Settings values (disable by defining `SKIP_AUDIT_TRAIL_CUSTOM_SETTINGS=true`)\n\nRegular setup actions performed in major orgs are filtered.\n\n- \"\"\n - createScratchOrg\n - changedsenderemail\n - deleteScratchOrg\n - loginasgrantedtopartnerbt\n- Certificate and Key Management\n - insertCertificate\n- Custom App Licenses\n - addeduserpackagelicense\n - granteduserpackagelicense\n - revokeduserpackagelicense\n- Customer Portal\n - createdcustomersuccessuser\n - CSPUserDisabled\n- Currency\n - updateddatedexchrate\n- Data Management\n - queueMembership\n- Email Administration\n - dkimRotationPreparationSuccessful\n - dkimRotationSuccessful\n- External Objects\n - xdsEncryptedFieldChange\n- Groups\n - groupMembership\n- Holidays\n - holiday_insert\n- Inbox mobile and legacy desktop apps\n - enableSIQUserNonEAC\n - siqUserAcceptedTOS\n- Manage Users\n - activateduser\n - createduser\n - changedcommunitynickname\n - changedemail\n - changedfederationid\n - changedpassword\n - changedinteractionuseroffon\n - changedinteractionuseronoff\n - changedmarketinguseroffon\n - changedmarketinguseronoff\n - changedofflineuseroffon\n - changedprofileforuserstdtostd\n - changedprofileforuser\n - changedprofileforusercusttostd\n - changedprofileforuserstdtocust\n - changedroleforusertonone\n - changedroleforuser\n - changedroleforuserfromnone\n - changedUserAdminVerifiedStatusVerified\n - changedUserEmailVerifiedStatusUnverified\n - changedUserEmailVerifiedStatusVerified\n - changedknowledgeuseroffon\n - changedsfcontentuseroffon\n - changedsupportuseroffon\n - changedusername\n - changedUserPhoneNumber\n - changedUserPhoneVerifiedStatusUnverified\n - changedUserPhoneVerifiedStatusVerified\n - deactivateduser\n - deleteAuthenticatorPairing\n - deleteTwoFactorInfo2\n - deleteTwoFactorTempCode\n - frozeuser\n - insertAuthenticatorPairing\n - insertTwoFactorInfo2\n - insertTwoFactorTempCode\n - lightningloginenroll\n - PermSetAssign\n - PermSetGroupAssign\n - PermSetGroupUnassign\n - PermSetLicenseAssign\n - PermSetUnassign\n - PermSetLicenseUnassign\n - registeredUserPhoneNumber\n - resetpassword\n - suNetworkAdminLogin\n - suNetworkAdminLogout\n - suOrgAdminLogin\n - suOrgAdminLogout\n - unfrozeuser\n - useremailchangesent\n- Mobile Administration\n - assigneduserstomobileconfig\n- Reporting Snapshots\n - createdReportJob\n - deletedReportJob\n- Sandboxes\n - DeleteSandbox\n\nBy default, deployment user defined in .sfdx-hardis.yml targetUsername property will be excluded.\n\nYou can define additional users to exclude in .sfdx-hardis.yml **monitoringExcludeUsernames** property.\n\nYou can also add more sections / actions considered as not suspect using property **monitoringAllowedSectionsActions**\n\nExample:\n\n```yaml\nmonitoringExcludeUsernames:\n - deploymentuser@cloudity.com\n - marketingcloud@cloudity.com\n - integration-user@cloudity.com\n\nmonitoringAllowedSectionsActions:\n \"Some section\": [] // Will ignore all actions from such section\n \"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.\n```\n\n## Excel output example\n\n\n\n## Local output example\n\n\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-suspect-audit-trail/) and can output Grafana, Slack and MsTeams Notifications.\n",
|
|
5807
|
-
"examples": [
|
|
5808
|
-
"$ sf hardis:org:diagnose:audittrail",
|
|
5809
|
-
"$ sf hardis:org:diagnose:audittrail --excludeusers baptiste@titi.com",
|
|
5810
|
-
"$ sf hardis:org:diagnose:audittrail --excludeusers baptiste@titi.com,bertrand@titi.com",
|
|
5811
|
-
"$ sf hardis:org:diagnose:audittrail --lastndays 5"
|
|
5812
|
-
],
|
|
5813
|
-
"flags": {
|
|
5814
|
-
"json": {
|
|
5815
|
-
"description": "Format output as json.",
|
|
5816
|
-
"helpGroup": "GLOBAL",
|
|
5817
|
-
"name": "json",
|
|
5818
|
-
"allowNo": false,
|
|
5819
|
-
"type": "boolean"
|
|
5820
|
-
},
|
|
5821
|
-
"flags-dir": {
|
|
5822
|
-
"helpGroup": "GLOBAL",
|
|
5823
|
-
"name": "flags-dir",
|
|
5824
|
-
"summary": "Import flag values from a directory.",
|
|
5825
|
-
"hasDynamicHelp": false,
|
|
5826
|
-
"multiple": false,
|
|
5827
|
-
"type": "option"
|
|
5828
|
-
},
|
|
5829
|
-
"excludeusers": {
|
|
5830
|
-
"char": "e",
|
|
5831
|
-
"description": "Comma-separated list of usernames to exclude",
|
|
5832
|
-
"name": "excludeusers",
|
|
5833
|
-
"hasDynamicHelp": false,
|
|
5834
|
-
"multiple": false,
|
|
5835
|
-
"type": "option"
|
|
5836
|
-
},
|
|
5837
|
-
"lastndays": {
|
|
5838
|
-
"char": "t",
|
|
5839
|
-
"description": "Number of days to extract from today (included)",
|
|
5840
|
-
"name": "lastndays",
|
|
5841
|
-
"hasDynamicHelp": false,
|
|
5842
|
-
"multiple": false,
|
|
5843
|
-
"type": "option"
|
|
5844
|
-
},
|
|
5845
|
-
"outputfile": {
|
|
5846
|
-
"char": "f",
|
|
5847
|
-
"description": "Force the path and name of output report file. Must end with .csv",
|
|
5848
|
-
"name": "outputfile",
|
|
5849
|
-
"hasDynamicHelp": false,
|
|
5850
|
-
"multiple": false,
|
|
5851
|
-
"type": "option"
|
|
5852
|
-
},
|
|
5853
|
-
"debug": {
|
|
5854
|
-
"char": "d",
|
|
5855
|
-
"description": "Activate debug mode (more logs)",
|
|
5856
|
-
"name": "debug",
|
|
5857
|
-
"allowNo": false,
|
|
5858
|
-
"type": "boolean"
|
|
5859
|
-
},
|
|
5860
|
-
"websocket": {
|
|
5861
|
-
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
5862
|
-
"name": "websocket",
|
|
5863
|
-
"hasDynamicHelp": false,
|
|
5864
|
-
"multiple": false,
|
|
5865
|
-
"type": "option"
|
|
5866
|
-
},
|
|
5867
|
-
"skipauth": {
|
|
5868
|
-
"description": "Skip authentication check when a default username is required",
|
|
5869
|
-
"name": "skipauth",
|
|
5870
|
-
"allowNo": false,
|
|
5871
|
-
"type": "boolean"
|
|
5872
|
-
},
|
|
5873
|
-
"target-org": {
|
|
5874
|
-
"aliases": [
|
|
5875
|
-
"targetusername",
|
|
5876
|
-
"u"
|
|
5877
|
-
],
|
|
5878
|
-
"char": "o",
|
|
5879
|
-
"deprecateAliases": true,
|
|
5880
|
-
"name": "target-org",
|
|
5881
|
-
"noCacheDefault": true,
|
|
5882
|
-
"required": true,
|
|
5883
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
5884
|
-
"hasDynamicHelp": true,
|
|
5885
|
-
"multiple": false,
|
|
5886
|
-
"type": "option"
|
|
5887
|
-
}
|
|
5888
|
-
},
|
|
5889
|
-
"hasDynamicHelp": true,
|
|
5890
|
-
"hiddenAliases": [],
|
|
5891
|
-
"id": "hardis:org:diagnose:audittrail",
|
|
5892
|
-
"pluginAlias": "sfdx-hardis",
|
|
5893
|
-
"pluginName": "sfdx-hardis",
|
|
5894
|
-
"pluginType": "core",
|
|
5895
|
-
"strict": true,
|
|
5896
|
-
"enableJsonFlag": true,
|
|
5897
|
-
"title": "Diagnose content of Setup Audit Trail",
|
|
5898
|
-
"requiresProject": false,
|
|
5899
|
-
"isESM": true,
|
|
5900
|
-
"relativePath": [
|
|
5901
|
-
"lib",
|
|
5902
|
-
"commands",
|
|
5903
|
-
"hardis",
|
|
5904
|
-
"org",
|
|
5905
|
-
"diagnose",
|
|
5906
|
-
"audittrail.js"
|
|
5758
|
+
"diagnose",
|
|
5759
|
+
"audittrail.js"
|
|
5907
5760
|
],
|
|
5908
5761
|
"aliasPermutations": [],
|
|
5909
5762
|
"permutations": [
|
|
@@ -7063,13 +6916,14 @@
|
|
|
7063
6916
|
"unusedusers:diagnose:org:hardis"
|
|
7064
6917
|
]
|
|
7065
6918
|
},
|
|
7066
|
-
"hardis:org:
|
|
6919
|
+
"hardis:org:generate:packagexmlfull": {
|
|
7067
6920
|
"aliases": [],
|
|
7068
6921
|
"args": {},
|
|
7069
|
-
"description": "
|
|
6922
|
+
"description": "\n## Command Behavior\n\n**Generates a comprehensive `package.xml` file for a Salesforce org, including all metadata components, even managed ones.**\n\nThis command is essential for various Salesforce development and administration tasks, especially when you need a complete snapshot of an org's metadata. It goes beyond typical source tracking by including managed package components, which is crucial for understanding the full metadata footprint of an org.\n\nKey functionalities:\n\n- **Full Org Metadata Retrieval:** Connects to a specified Salesforce org (or prompts for one if not provided) and retrieves a complete list of all metadata types and their members.\n- **Managed Package Inclusion:** Unlike standard source retrieval, this command explicitly includes metadata from managed packages, providing a truly comprehensive `package.xml`.\n- **Customizable Output:** Allows you to specify the output file path for the generated `package.xml`.\n- **Interactive Org Selection:** If no target org is specified, it interactively prompts the user to choose an org. (or use --no-prompt to skip this step)\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **Salesforce Metadata API Interaction:** It leverages the Salesforce Metadata API to list all available metadata types and then retrieve all components for each type.\n- **`buildOrgManifest` Utility:** The core logic for querying the org's metadata and constructing the `package.xml` is encapsulated within the `buildOrgManifest` utility function.\n- **XML Generation:** It dynamically builds the XML structure of the `package.xml` file, including the `types` and `members` elements for all retrieved metadata.\n- **File System Operations:** It writes the generated `package.xml` file to the specified output path.\n- **Interactive Prompts:** Uses `promptOrgUsernameDefault` to guide the user in selecting the target Salesforce org.\n</details>\n",
|
|
7070
6923
|
"examples": [
|
|
7071
|
-
"$ sf hardis:org:
|
|
7072
|
-
"$ sf hardis:org:
|
|
6924
|
+
"$ sf hardis:org:generate:packagexmlfull",
|
|
6925
|
+
"$ sf hardis:org:generate:packagexmlfull --outputfile /tmp/packagexmlfull.xml",
|
|
6926
|
+
"$ sf hardis:org:generate:packagexmlfull --target-org nico@example.com"
|
|
7073
6927
|
],
|
|
7074
6928
|
"flags": {
|
|
7075
6929
|
"json": {
|
|
@@ -7087,10 +6941,9 @@
|
|
|
7087
6941
|
"multiple": false,
|
|
7088
6942
|
"type": "option"
|
|
7089
6943
|
},
|
|
7090
|
-
"
|
|
7091
|
-
"
|
|
7092
|
-
"
|
|
7093
|
-
"name": "listviews",
|
|
6944
|
+
"outputfile": {
|
|
6945
|
+
"description": "Output package.xml file",
|
|
6946
|
+
"name": "outputfile",
|
|
7094
6947
|
"hasDynamicHelp": false,
|
|
7095
6948
|
"multiple": false,
|
|
7096
6949
|
"type": "option"
|
|
@@ -7102,6 +6955,13 @@
|
|
|
7102
6955
|
"allowNo": false,
|
|
7103
6956
|
"type": "boolean"
|
|
7104
6957
|
},
|
|
6958
|
+
"no-prompt": {
|
|
6959
|
+
"char": "n",
|
|
6960
|
+
"description": "Do not prompt for org username, use the default one",
|
|
6961
|
+
"name": "no-prompt",
|
|
6962
|
+
"allowNo": false,
|
|
6963
|
+
"type": "boolean"
|
|
6964
|
+
},
|
|
7105
6965
|
"websocket": {
|
|
7106
6966
|
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
7107
6967
|
"name": "websocket",
|
|
@@ -7133,59 +6993,57 @@
|
|
|
7133
6993
|
},
|
|
7134
6994
|
"hasDynamicHelp": true,
|
|
7135
6995
|
"hiddenAliases": [],
|
|
7136
|
-
"id": "hardis:org:
|
|
6996
|
+
"id": "hardis:org:generate:packagexmlfull",
|
|
7137
6997
|
"pluginAlias": "sfdx-hardis",
|
|
7138
6998
|
"pluginName": "sfdx-hardis",
|
|
7139
6999
|
"pluginType": "core",
|
|
7140
7000
|
"strict": true,
|
|
7141
7001
|
"enableJsonFlag": true,
|
|
7142
|
-
"title": "
|
|
7143
|
-
"requiresProject":
|
|
7002
|
+
"title": "Generate Full Org package.xml",
|
|
7003
|
+
"requiresProject": false,
|
|
7144
7004
|
"isESM": true,
|
|
7145
7005
|
"relativePath": [
|
|
7146
7006
|
"lib",
|
|
7147
7007
|
"commands",
|
|
7148
7008
|
"hardis",
|
|
7149
7009
|
"org",
|
|
7150
|
-
"
|
|
7151
|
-
"
|
|
7010
|
+
"generate",
|
|
7011
|
+
"packagexmlfull.js"
|
|
7152
7012
|
],
|
|
7153
7013
|
"aliasPermutations": [],
|
|
7154
7014
|
"permutations": [
|
|
7155
|
-
"hardis:org:
|
|
7156
|
-
"org:hardis:
|
|
7157
|
-
"org:
|
|
7158
|
-
"org:
|
|
7159
|
-
"hardis:
|
|
7160
|
-
"
|
|
7161
|
-
"
|
|
7162
|
-
"
|
|
7163
|
-
"hardis:
|
|
7164
|
-
"
|
|
7165
|
-
"
|
|
7166
|
-
"
|
|
7167
|
-
"hardis:org:
|
|
7168
|
-
"org:hardis:
|
|
7169
|
-
"org:
|
|
7170
|
-
"org:
|
|
7171
|
-
"hardis:
|
|
7172
|
-
"
|
|
7173
|
-
"
|
|
7174
|
-
"
|
|
7175
|
-
"hardis:
|
|
7176
|
-
"
|
|
7177
|
-
"
|
|
7178
|
-
"
|
|
7015
|
+
"hardis:org:generate:packagexmlfull",
|
|
7016
|
+
"org:hardis:generate:packagexmlfull",
|
|
7017
|
+
"org:generate:hardis:packagexmlfull",
|
|
7018
|
+
"org:generate:packagexmlfull:hardis",
|
|
7019
|
+
"hardis:generate:org:packagexmlfull",
|
|
7020
|
+
"generate:hardis:org:packagexmlfull",
|
|
7021
|
+
"generate:org:hardis:packagexmlfull",
|
|
7022
|
+
"generate:org:packagexmlfull:hardis",
|
|
7023
|
+
"hardis:generate:packagexmlfull:org",
|
|
7024
|
+
"generate:hardis:packagexmlfull:org",
|
|
7025
|
+
"generate:packagexmlfull:hardis:org",
|
|
7026
|
+
"generate:packagexmlfull:org:hardis",
|
|
7027
|
+
"hardis:org:packagexmlfull:generate",
|
|
7028
|
+
"org:hardis:packagexmlfull:generate",
|
|
7029
|
+
"org:packagexmlfull:hardis:generate",
|
|
7030
|
+
"org:packagexmlfull:generate:hardis",
|
|
7031
|
+
"hardis:packagexmlfull:org:generate",
|
|
7032
|
+
"packagexmlfull:hardis:org:generate",
|
|
7033
|
+
"packagexmlfull:org:hardis:generate",
|
|
7034
|
+
"packagexmlfull:org:generate:hardis",
|
|
7035
|
+
"hardis:packagexmlfull:generate:org",
|
|
7036
|
+
"packagexmlfull:hardis:generate:org",
|
|
7037
|
+
"packagexmlfull:generate:hardis:org",
|
|
7038
|
+
"packagexmlfull:generate:org:hardis"
|
|
7179
7039
|
]
|
|
7180
7040
|
},
|
|
7181
|
-
"hardis:org:
|
|
7041
|
+
"hardis:org:files:export": {
|
|
7182
7042
|
"aliases": [],
|
|
7183
7043
|
"args": {},
|
|
7184
|
-
"description": "\n## Command Behavior\n\n**
|
|
7044
|
+
"description": "\n## Command Behavior\n\n**Exports file attachments (ContentVersion, Attachment) from a Salesforce org based on a predefined configuration.**\n\nThis command enables the mass download of files associated with Salesforce records, providing a robust solution for backing up files, migrating them to other systems, or integrating them with external document management solutions.\n\nKey functionalities:\n\n- **Configuration-Driven Export:** Relies on an `export.json` file within a designated file export project to define the export criteria, including the SOQL query for parent records, file types to export, and output naming conventions.\n- **Interactive Project Selection:** If the file export project path is not provided via the `--path` flag, it interactively prompts the user to select one.\n- **Configurable Export Options:** Allows overriding default export settings such as `chunksize` (number of records processed in a batch), `polltimeout` (timeout for Bulk API calls), and `startchunknumber` (to resume a failed export).\n- **Support for ContentVersion and Attachment:** Handles both modern Salesforce Files (ContentVersion) and older Attachments.\n\nSee this article for a practical example:\n\n[](https://nicolas.vuillamy.fr/how-to-mass-download-notes-and-attachments-files-from-a-salesforce-org-83a028824afd)\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **FilesExporter Class:** The core logic is encapsulated within the `FilesExporter` class, which orchestrates the entire export process.\n- **SOQL Queries (Bulk API):** It uses Salesforce Bulk API queries to efficiently retrieve large volumes of parent record IDs and file metadata.\n- **File Download:** Downloads the actual file content from Salesforce.\n- **File System Operations:** Writes the downloaded files to the local file system, organizing them into folders based on the configured naming conventions.\n- **Configuration Loading:** Reads the `export.json` file to get the export configuration. It also allows for interactive overriding of these settings.\n- **Interactive Prompts:** Uses `selectFilesWorkspace` to allow the user to choose a file export project and `promptFilesExportConfiguration` for customizing export options.\n- **Error Handling:** Includes mechanisms to handle potential errors during the export process, such as network issues or API limits.\n</details>\n",
|
|
7185
7045
|
"examples": [
|
|
7186
|
-
"$ sf hardis:org:
|
|
7187
|
-
"$ sf hardis:org:generate:packagexmlfull --outputfile /tmp/packagexmlfull.xml",
|
|
7188
|
-
"$ sf hardis:org:generate:packagexmlfull --target-org nico@example.com"
|
|
7046
|
+
"$ sf hardis:org:files:export"
|
|
7189
7047
|
],
|
|
7190
7048
|
"flags": {
|
|
7191
7049
|
"json": {
|
|
@@ -7203,9 +7061,37 @@
|
|
|
7203
7061
|
"multiple": false,
|
|
7204
7062
|
"type": "option"
|
|
7205
7063
|
},
|
|
7206
|
-
"
|
|
7207
|
-
"
|
|
7208
|
-
"
|
|
7064
|
+
"path": {
|
|
7065
|
+
"char": "p",
|
|
7066
|
+
"description": "Path to the file export project",
|
|
7067
|
+
"name": "path",
|
|
7068
|
+
"hasDynamicHelp": false,
|
|
7069
|
+
"multiple": false,
|
|
7070
|
+
"type": "option"
|
|
7071
|
+
},
|
|
7072
|
+
"chunksize": {
|
|
7073
|
+
"char": "c",
|
|
7074
|
+
"description": "Number of records to add in a chunk before it is processed",
|
|
7075
|
+
"name": "chunksize",
|
|
7076
|
+
"default": 1000,
|
|
7077
|
+
"hasDynamicHelp": false,
|
|
7078
|
+
"multiple": false,
|
|
7079
|
+
"type": "option"
|
|
7080
|
+
},
|
|
7081
|
+
"polltimeout": {
|
|
7082
|
+
"char": "t",
|
|
7083
|
+
"description": "Timeout in MS for Bulk API calls",
|
|
7084
|
+
"name": "polltimeout",
|
|
7085
|
+
"default": 300000,
|
|
7086
|
+
"hasDynamicHelp": false,
|
|
7087
|
+
"multiple": false,
|
|
7088
|
+
"type": "option"
|
|
7089
|
+
},
|
|
7090
|
+
"startchunknumber": {
|
|
7091
|
+
"char": "s",
|
|
7092
|
+
"description": "Chunk number to start from",
|
|
7093
|
+
"name": "startchunknumber",
|
|
7094
|
+
"default": 0,
|
|
7209
7095
|
"hasDynamicHelp": false,
|
|
7210
7096
|
"multiple": false,
|
|
7211
7097
|
"type": "option"
|
|
@@ -7217,10 +7103,124 @@
|
|
|
7217
7103
|
"allowNo": false,
|
|
7218
7104
|
"type": "boolean"
|
|
7219
7105
|
},
|
|
7220
|
-
"
|
|
7221
|
-
"
|
|
7222
|
-
"
|
|
7223
|
-
"
|
|
7106
|
+
"websocket": {
|
|
7107
|
+
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
7108
|
+
"name": "websocket",
|
|
7109
|
+
"hasDynamicHelp": false,
|
|
7110
|
+
"multiple": false,
|
|
7111
|
+
"type": "option"
|
|
7112
|
+
},
|
|
7113
|
+
"skipauth": {
|
|
7114
|
+
"description": "Skip authentication check when a default username is required",
|
|
7115
|
+
"name": "skipauth",
|
|
7116
|
+
"allowNo": false,
|
|
7117
|
+
"type": "boolean"
|
|
7118
|
+
},
|
|
7119
|
+
"target-org": {
|
|
7120
|
+
"aliases": [
|
|
7121
|
+
"targetusername",
|
|
7122
|
+
"u"
|
|
7123
|
+
],
|
|
7124
|
+
"char": "o",
|
|
7125
|
+
"deprecateAliases": true,
|
|
7126
|
+
"name": "target-org",
|
|
7127
|
+
"noCacheDefault": true,
|
|
7128
|
+
"required": true,
|
|
7129
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
7130
|
+
"hasDynamicHelp": true,
|
|
7131
|
+
"multiple": false,
|
|
7132
|
+
"type": "option"
|
|
7133
|
+
}
|
|
7134
|
+
},
|
|
7135
|
+
"hasDynamicHelp": true,
|
|
7136
|
+
"hiddenAliases": [],
|
|
7137
|
+
"id": "hardis:org:files:export",
|
|
7138
|
+
"pluginAlias": "sfdx-hardis",
|
|
7139
|
+
"pluginName": "sfdx-hardis",
|
|
7140
|
+
"pluginType": "core",
|
|
7141
|
+
"strict": true,
|
|
7142
|
+
"enableJsonFlag": true,
|
|
7143
|
+
"title": "Export files",
|
|
7144
|
+
"requiresProject": false,
|
|
7145
|
+
"isESM": true,
|
|
7146
|
+
"relativePath": [
|
|
7147
|
+
"lib",
|
|
7148
|
+
"commands",
|
|
7149
|
+
"hardis",
|
|
7150
|
+
"org",
|
|
7151
|
+
"files",
|
|
7152
|
+
"export.js"
|
|
7153
|
+
],
|
|
7154
|
+
"aliasPermutations": [],
|
|
7155
|
+
"permutations": [
|
|
7156
|
+
"hardis:org:files:export",
|
|
7157
|
+
"org:hardis:files:export",
|
|
7158
|
+
"org:files:hardis:export",
|
|
7159
|
+
"org:files:export:hardis",
|
|
7160
|
+
"hardis:files:org:export",
|
|
7161
|
+
"files:hardis:org:export",
|
|
7162
|
+
"files:org:hardis:export",
|
|
7163
|
+
"files:org:export:hardis",
|
|
7164
|
+
"hardis:files:export:org",
|
|
7165
|
+
"files:hardis:export:org",
|
|
7166
|
+
"files:export:hardis:org",
|
|
7167
|
+
"files:export:org:hardis",
|
|
7168
|
+
"hardis:org:export:files",
|
|
7169
|
+
"org:hardis:export:files",
|
|
7170
|
+
"org:export:hardis:files",
|
|
7171
|
+
"org:export:files:hardis",
|
|
7172
|
+
"hardis:export:org:files",
|
|
7173
|
+
"export:hardis:org:files",
|
|
7174
|
+
"export:org:hardis:files",
|
|
7175
|
+
"export:org:files:hardis",
|
|
7176
|
+
"hardis:export:files:org",
|
|
7177
|
+
"export:hardis:files:org",
|
|
7178
|
+
"export:files:hardis:org",
|
|
7179
|
+
"export:files:org:hardis"
|
|
7180
|
+
]
|
|
7181
|
+
},
|
|
7182
|
+
"hardis:org:files:import": {
|
|
7183
|
+
"aliases": [],
|
|
7184
|
+
"args": {},
|
|
7185
|
+
"description": "\nThis command facilitates the mass upload of files into Salesforce, allowing you to populate records with associated documents, images, or other file types. It's a crucial tool for data migration, content seeding, or synchronizing external file repositories with Salesforce.\n\nKey functionalities:\n\n- **Configuration-Driven Import:** Relies on an `export.json` file within a designated file export project (created using `sf hardis:org:configure:files`) to determine which files to import and how they should be associated with Salesforce records.\n- **Interactive Project Selection:** If the file import project path is not provided via the `--path` flag, it interactively prompts the user to select one.\n- **Overwrite Option:** The `--overwrite` flag allows you to replace existing files in Salesforce with local versions that have the same name. Be aware that this option doubles the number of API calls used.\n- **Support for ContentVersion and Attachment:** Handles both modern Salesforce Files (ContentVersion) and older Attachments.\n\nSee this article for how to export files, which is often a prerequisite for importing:\n\n[](https://nicolas.vuillamy.fr/how-to-mass-download-notes-and-attachments-files-from-a-salesforce-org-83a028824afd)\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **FilesImporter Class:** The core logic is encapsulated within the `FilesImporter` class, which orchestrates the entire import process.\n- **File System Scan:** Scans the local file system within the configured project directory to identify files for import.\n- **Salesforce API Interaction:** Uses Salesforce APIs (e.g., ContentVersion, Attachment) to upload files and associate them with records.\n- **Configuration Loading:** Reads the `export.json` file to get the import configuration, including SOQL queries to identify parent records for file association.\n- **Interactive Prompts:** Uses `selectFilesWorkspace` to allow the user to choose a file import project and `prompts` for confirming the overwrite behavior.\n- **Error Handling:** Includes mechanisms to handle potential errors during the import process, such as API limits or file upload failures.\n</details>\n",
|
|
7186
|
+
"examples": [
|
|
7187
|
+
"$ sf hardis:org:files:import"
|
|
7188
|
+
],
|
|
7189
|
+
"flags": {
|
|
7190
|
+
"json": {
|
|
7191
|
+
"description": "Format output as json.",
|
|
7192
|
+
"helpGroup": "GLOBAL",
|
|
7193
|
+
"name": "json",
|
|
7194
|
+
"allowNo": false,
|
|
7195
|
+
"type": "boolean"
|
|
7196
|
+
},
|
|
7197
|
+
"flags-dir": {
|
|
7198
|
+
"helpGroup": "GLOBAL",
|
|
7199
|
+
"name": "flags-dir",
|
|
7200
|
+
"summary": "Import flag values from a directory.",
|
|
7201
|
+
"hasDynamicHelp": false,
|
|
7202
|
+
"multiple": false,
|
|
7203
|
+
"type": "option"
|
|
7204
|
+
},
|
|
7205
|
+
"path": {
|
|
7206
|
+
"char": "p",
|
|
7207
|
+
"description": "Path to the file export project",
|
|
7208
|
+
"name": "path",
|
|
7209
|
+
"hasDynamicHelp": false,
|
|
7210
|
+
"multiple": false,
|
|
7211
|
+
"type": "option"
|
|
7212
|
+
},
|
|
7213
|
+
"overwrite": {
|
|
7214
|
+
"char": "f",
|
|
7215
|
+
"description": "Override existing files (doubles the number of API calls)",
|
|
7216
|
+
"name": "overwrite",
|
|
7217
|
+
"allowNo": false,
|
|
7218
|
+
"type": "boolean"
|
|
7219
|
+
},
|
|
7220
|
+
"debug": {
|
|
7221
|
+
"char": "d",
|
|
7222
|
+
"description": "Activate debug mode (more logs)",
|
|
7223
|
+
"name": "debug",
|
|
7224
7224
|
"allowNo": false,
|
|
7225
7225
|
"type": "boolean"
|
|
7226
7226
|
},
|
|
@@ -7255,13 +7255,13 @@
|
|
|
7255
7255
|
},
|
|
7256
7256
|
"hasDynamicHelp": true,
|
|
7257
7257
|
"hiddenAliases": [],
|
|
7258
|
-
"id": "hardis:org:
|
|
7258
|
+
"id": "hardis:org:files:import",
|
|
7259
7259
|
"pluginAlias": "sfdx-hardis",
|
|
7260
7260
|
"pluginName": "sfdx-hardis",
|
|
7261
7261
|
"pluginType": "core",
|
|
7262
7262
|
"strict": true,
|
|
7263
7263
|
"enableJsonFlag": true,
|
|
7264
|
-
"title": "
|
|
7264
|
+
"title": "Import files",
|
|
7265
7265
|
"requiresProject": false,
|
|
7266
7266
|
"isESM": true,
|
|
7267
7267
|
"relativePath": [
|
|
@@ -7269,35 +7269,35 @@
|
|
|
7269
7269
|
"commands",
|
|
7270
7270
|
"hardis",
|
|
7271
7271
|
"org",
|
|
7272
|
-
"
|
|
7273
|
-
"
|
|
7272
|
+
"files",
|
|
7273
|
+
"import.js"
|
|
7274
7274
|
],
|
|
7275
7275
|
"aliasPermutations": [],
|
|
7276
7276
|
"permutations": [
|
|
7277
|
-
"hardis:org:
|
|
7278
|
-
"org:hardis:
|
|
7279
|
-
"org:
|
|
7280
|
-
"org:
|
|
7281
|
-
"hardis:
|
|
7282
|
-
"
|
|
7283
|
-
"
|
|
7284
|
-
"
|
|
7285
|
-
"hardis:
|
|
7286
|
-
"
|
|
7287
|
-
"
|
|
7288
|
-
"
|
|
7289
|
-
"hardis:org:
|
|
7290
|
-
"org:hardis:
|
|
7291
|
-
"org:
|
|
7292
|
-
"org:
|
|
7293
|
-
"hardis:
|
|
7294
|
-
"
|
|
7295
|
-
"
|
|
7296
|
-
"
|
|
7297
|
-
"hardis:
|
|
7298
|
-
"
|
|
7299
|
-
"
|
|
7300
|
-
"
|
|
7277
|
+
"hardis:org:files:import",
|
|
7278
|
+
"org:hardis:files:import",
|
|
7279
|
+
"org:files:hardis:import",
|
|
7280
|
+
"org:files:import:hardis",
|
|
7281
|
+
"hardis:files:org:import",
|
|
7282
|
+
"files:hardis:org:import",
|
|
7283
|
+
"files:org:hardis:import",
|
|
7284
|
+
"files:org:import:hardis",
|
|
7285
|
+
"hardis:files:import:org",
|
|
7286
|
+
"files:hardis:import:org",
|
|
7287
|
+
"files:import:hardis:org",
|
|
7288
|
+
"files:import:org:hardis",
|
|
7289
|
+
"hardis:org:import:files",
|
|
7290
|
+
"org:hardis:import:files",
|
|
7291
|
+
"org:import:hardis:files",
|
|
7292
|
+
"org:import:files:hardis",
|
|
7293
|
+
"hardis:import:org:files",
|
|
7294
|
+
"import:hardis:org:files",
|
|
7295
|
+
"import:org:hardis:files",
|
|
7296
|
+
"import:org:files:hardis",
|
|
7297
|
+
"hardis:import:files:org",
|
|
7298
|
+
"import:hardis:files:org",
|
|
7299
|
+
"import:files:hardis:org",
|
|
7300
|
+
"import:files:org:hardis"
|
|
7301
7301
|
]
|
|
7302
7302
|
},
|
|
7303
7303
|
"hardis:org:monitor:all": {
|
|
@@ -9682,6 +9682,238 @@
|
|
|
9682
9682
|
"remotesites:audit:project:hardis"
|
|
9683
9683
|
]
|
|
9684
9684
|
},
|
|
9685
|
+
"hardis:project:configure:auth": {
|
|
9686
|
+
"aliases": [],
|
|
9687
|
+
"args": {},
|
|
9688
|
+
"description": "\n## Command Behavior\n\n**Configures authentication between a Git branch and a target Salesforce org for CI/CD deployments.**\n\nThis command facilitates the setup of automated CI/CD pipelines, enabling seamless deployments from specific Git branches to designated Salesforce orgs. It supports both standard Salesforce orgs and Dev Hub configurations, catering to various enterprise deployment workflows.\n\nKey functionalities include:\n\n- **Org Selection/Login:** Guides the user to select an existing Salesforce org or log in to a new one.\n- **Git Branch Association:** Allows associating a specific Git branch with the chosen Salesforce org.\n- **Merge Target Definition:** Enables defining target Git branches into which the configured branch can merge, ensuring controlled deployment flows.\n- **Salesforce Username Configuration:** Prompts for the Salesforce username to be used by the CI server for deployments.\n- **SSL Certificate Generation:** Automatically generates an SSL certificate for secure authentication.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's implementation involves several key technical aspects:\n\n- **SF CLI Integration:** Utilizes \n@salesforce/sf-plugins-core\n for command structure and flag parsing.\n- **Interactive Prompts:** Employs the \nprompts\n library for interactive user input, guiding the configuration process.\n- **Git Integration:** Interacts with Git to retrieve branch information using \n`git().branch([\"--list\", \"-r\"])`\n.\n- **Configuration Management:** Leverages internal utilities (`checkConfig`, `getConfig`, `setConfig`, `setInConfigFile`) to read from and write to project-specific configuration files (e.g., `.sfdx-hardis.<branchName>.yml`).\n- **Salesforce CLI Execution:** Executes Salesforce CLI commands programmatically via `execSfdxJson` for org interactions.\n- **SSL Certificate Generation:** Calls `generateSSLCertificate` to create necessary SSL certificates for JWT-based authentication.\n- **WebSocket Communication:** Uses `WebSocketClient` for potential communication with external tools or processes, such as restarting the command in VS Code.\n- **Dependency Check:** Ensures the presence of `openssl` on the system, which is required for SSL certificate generation.\n",
|
|
9689
|
+
"examples": [
|
|
9690
|
+
"$ sf hardis:project:configure:auth"
|
|
9691
|
+
],
|
|
9692
|
+
"flags": {
|
|
9693
|
+
"json": {
|
|
9694
|
+
"description": "Format output as json.",
|
|
9695
|
+
"helpGroup": "GLOBAL",
|
|
9696
|
+
"name": "json",
|
|
9697
|
+
"allowNo": false,
|
|
9698
|
+
"type": "boolean"
|
|
9699
|
+
},
|
|
9700
|
+
"flags-dir": {
|
|
9701
|
+
"helpGroup": "GLOBAL",
|
|
9702
|
+
"name": "flags-dir",
|
|
9703
|
+
"summary": "Import flag values from a directory.",
|
|
9704
|
+
"hasDynamicHelp": false,
|
|
9705
|
+
"multiple": false,
|
|
9706
|
+
"type": "option"
|
|
9707
|
+
},
|
|
9708
|
+
"devhub": {
|
|
9709
|
+
"char": "b",
|
|
9710
|
+
"description": "Configure project DevHub",
|
|
9711
|
+
"name": "devhub",
|
|
9712
|
+
"allowNo": false,
|
|
9713
|
+
"type": "boolean"
|
|
9714
|
+
},
|
|
9715
|
+
"debug": {
|
|
9716
|
+
"char": "d",
|
|
9717
|
+
"description": "Activate debug mode (more logs)",
|
|
9718
|
+
"name": "debug",
|
|
9719
|
+
"allowNo": false,
|
|
9720
|
+
"type": "boolean"
|
|
9721
|
+
},
|
|
9722
|
+
"websocket": {
|
|
9723
|
+
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
9724
|
+
"name": "websocket",
|
|
9725
|
+
"hasDynamicHelp": false,
|
|
9726
|
+
"multiple": false,
|
|
9727
|
+
"type": "option"
|
|
9728
|
+
},
|
|
9729
|
+
"skipauth": {
|
|
9730
|
+
"description": "Skip authentication check when a default username is required",
|
|
9731
|
+
"name": "skipauth",
|
|
9732
|
+
"allowNo": false,
|
|
9733
|
+
"type": "boolean"
|
|
9734
|
+
},
|
|
9735
|
+
"target-org": {
|
|
9736
|
+
"aliases": [
|
|
9737
|
+
"targetusername",
|
|
9738
|
+
"u"
|
|
9739
|
+
],
|
|
9740
|
+
"char": "o",
|
|
9741
|
+
"deprecateAliases": true,
|
|
9742
|
+
"name": "target-org",
|
|
9743
|
+
"noCacheDefault": true,
|
|
9744
|
+
"summary": "Username or alias of the target org.",
|
|
9745
|
+
"hasDynamicHelp": true,
|
|
9746
|
+
"multiple": false,
|
|
9747
|
+
"type": "option"
|
|
9748
|
+
},
|
|
9749
|
+
"target-dev-hub": {
|
|
9750
|
+
"aliases": [
|
|
9751
|
+
"targetdevhubusername"
|
|
9752
|
+
],
|
|
9753
|
+
"char": "v",
|
|
9754
|
+
"deprecateAliases": true,
|
|
9755
|
+
"name": "target-dev-hub",
|
|
9756
|
+
"noCacheDefault": true,
|
|
9757
|
+
"required": false,
|
|
9758
|
+
"summary": "Username or alias of the Dev Hub org.",
|
|
9759
|
+
"hasDynamicHelp": true,
|
|
9760
|
+
"multiple": false,
|
|
9761
|
+
"type": "option"
|
|
9762
|
+
}
|
|
9763
|
+
},
|
|
9764
|
+
"hasDynamicHelp": true,
|
|
9765
|
+
"hiddenAliases": [],
|
|
9766
|
+
"id": "hardis:project:configure:auth",
|
|
9767
|
+
"pluginAlias": "sfdx-hardis",
|
|
9768
|
+
"pluginName": "sfdx-hardis",
|
|
9769
|
+
"pluginType": "core",
|
|
9770
|
+
"strict": true,
|
|
9771
|
+
"enableJsonFlag": true,
|
|
9772
|
+
"title": "Configure authentication",
|
|
9773
|
+
"requiresProject": false,
|
|
9774
|
+
"requiresDependencies": [
|
|
9775
|
+
"openssl"
|
|
9776
|
+
],
|
|
9777
|
+
"isESM": true,
|
|
9778
|
+
"relativePath": [
|
|
9779
|
+
"lib",
|
|
9780
|
+
"commands",
|
|
9781
|
+
"hardis",
|
|
9782
|
+
"project",
|
|
9783
|
+
"configure",
|
|
9784
|
+
"auth.js"
|
|
9785
|
+
],
|
|
9786
|
+
"aliasPermutations": [],
|
|
9787
|
+
"permutations": [
|
|
9788
|
+
"hardis:project:configure:auth",
|
|
9789
|
+
"project:hardis:configure:auth",
|
|
9790
|
+
"project:configure:hardis:auth",
|
|
9791
|
+
"project:configure:auth:hardis",
|
|
9792
|
+
"hardis:configure:project:auth",
|
|
9793
|
+
"configure:hardis:project:auth",
|
|
9794
|
+
"configure:project:hardis:auth",
|
|
9795
|
+
"configure:project:auth:hardis",
|
|
9796
|
+
"hardis:configure:auth:project",
|
|
9797
|
+
"configure:hardis:auth:project",
|
|
9798
|
+
"configure:auth:hardis:project",
|
|
9799
|
+
"configure:auth:project:hardis",
|
|
9800
|
+
"hardis:project:auth:configure",
|
|
9801
|
+
"project:hardis:auth:configure",
|
|
9802
|
+
"project:auth:hardis:configure",
|
|
9803
|
+
"project:auth:configure:hardis",
|
|
9804
|
+
"hardis:auth:project:configure",
|
|
9805
|
+
"auth:hardis:project:configure",
|
|
9806
|
+
"auth:project:hardis:configure",
|
|
9807
|
+
"auth:project:configure:hardis",
|
|
9808
|
+
"hardis:auth:configure:project",
|
|
9809
|
+
"auth:hardis:configure:project",
|
|
9810
|
+
"auth:configure:hardis:project",
|
|
9811
|
+
"auth:configure:project:hardis"
|
|
9812
|
+
]
|
|
9813
|
+
},
|
|
9814
|
+
"hardis:project:convert:profilestopermsets": {
|
|
9815
|
+
"aliases": [],
|
|
9816
|
+
"args": {},
|
|
9817
|
+
"description": "\n## Command Behavior\n\n**Converts existing Salesforce Profiles into Permission Sets, facilitating a more granular and recommended security model.**\n\nThis command helps in migrating permissions from Profiles to Permission Sets, which is a best practice for managing user access in Salesforce. It creates a new Permission Set for each specified Profile, adopting a naming convention of `PS_PROFILENAME`.\n\nKey functionalities:\n\n- **Profile to Permission Set Conversion:** Automatically extracts permissions from a Profile and creates a corresponding Permission Set.\n- **Naming Convention:** New Permission Sets are named with a `PS_` prefix followed by the Profile name (e.g., `PS_Standard_User`).\n- **Exclusion Filter:** Allows you to exclude specific Profiles from the conversion process using the `--except` flag.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **External Plugin Integration:** It relies on the `shane-sfdx-plugins` (specifically the `sf shane:profile:convert` command) to perform the actual conversion.\n- **File System Scan:** It reads the contents of the `force-app/main/default/profiles` directory to identify all available Profile metadata files.\n- **Command Execution:** For each identified Profile (that is not excluded), it constructs and executes the `sf shane:profile:convert` command with the appropriate Profile name and desired Permission Set name.\n- **Error Handling:** Includes basic error handling for the external command execution.\n</details>\n",
|
|
9818
|
+
"examples": [
|
|
9819
|
+
"$ sf hardis:project:convert:profilestopermsets"
|
|
9820
|
+
],
|
|
9821
|
+
"flags": {
|
|
9822
|
+
"json": {
|
|
9823
|
+
"description": "Format output as json.",
|
|
9824
|
+
"helpGroup": "GLOBAL",
|
|
9825
|
+
"name": "json",
|
|
9826
|
+
"allowNo": false,
|
|
9827
|
+
"type": "boolean"
|
|
9828
|
+
},
|
|
9829
|
+
"flags-dir": {
|
|
9830
|
+
"helpGroup": "GLOBAL",
|
|
9831
|
+
"name": "flags-dir",
|
|
9832
|
+
"summary": "Import flag values from a directory.",
|
|
9833
|
+
"hasDynamicHelp": false,
|
|
9834
|
+
"multiple": false,
|
|
9835
|
+
"type": "option"
|
|
9836
|
+
},
|
|
9837
|
+
"except": {
|
|
9838
|
+
"char": "e",
|
|
9839
|
+
"description": "List of filters",
|
|
9840
|
+
"name": "except",
|
|
9841
|
+
"default": [],
|
|
9842
|
+
"hasDynamicHelp": false,
|
|
9843
|
+
"multiple": true,
|
|
9844
|
+
"type": "option"
|
|
9845
|
+
},
|
|
9846
|
+
"debug": {
|
|
9847
|
+
"char": "d",
|
|
9848
|
+
"description": "Activate debug mode (more logs)",
|
|
9849
|
+
"name": "debug",
|
|
9850
|
+
"allowNo": false,
|
|
9851
|
+
"type": "boolean"
|
|
9852
|
+
},
|
|
9853
|
+
"websocket": {
|
|
9854
|
+
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
9855
|
+
"name": "websocket",
|
|
9856
|
+
"hasDynamicHelp": false,
|
|
9857
|
+
"multiple": false,
|
|
9858
|
+
"type": "option"
|
|
9859
|
+
},
|
|
9860
|
+
"skipauth": {
|
|
9861
|
+
"description": "Skip authentication check when a default username is required",
|
|
9862
|
+
"name": "skipauth",
|
|
9863
|
+
"allowNo": false,
|
|
9864
|
+
"type": "boolean"
|
|
9865
|
+
}
|
|
9866
|
+
},
|
|
9867
|
+
"hasDynamicHelp": false,
|
|
9868
|
+
"hiddenAliases": [],
|
|
9869
|
+
"id": "hardis:project:convert:profilestopermsets",
|
|
9870
|
+
"pluginAlias": "sfdx-hardis",
|
|
9871
|
+
"pluginName": "sfdx-hardis",
|
|
9872
|
+
"pluginType": "core",
|
|
9873
|
+
"strict": true,
|
|
9874
|
+
"enableJsonFlag": true,
|
|
9875
|
+
"title": "Convert Profiles into Permission Sets",
|
|
9876
|
+
"requiresProject": true,
|
|
9877
|
+
"requiresSfdxPlugins": [
|
|
9878
|
+
"shane-sfdx-plugins"
|
|
9879
|
+
],
|
|
9880
|
+
"isESM": true,
|
|
9881
|
+
"relativePath": [
|
|
9882
|
+
"lib",
|
|
9883
|
+
"commands",
|
|
9884
|
+
"hardis",
|
|
9885
|
+
"project",
|
|
9886
|
+
"convert",
|
|
9887
|
+
"profilestopermsets.js"
|
|
9888
|
+
],
|
|
9889
|
+
"aliasPermutations": [],
|
|
9890
|
+
"permutations": [
|
|
9891
|
+
"hardis:project:convert:profilestopermsets",
|
|
9892
|
+
"project:hardis:convert:profilestopermsets",
|
|
9893
|
+
"project:convert:hardis:profilestopermsets",
|
|
9894
|
+
"project:convert:profilestopermsets:hardis",
|
|
9895
|
+
"hardis:convert:project:profilestopermsets",
|
|
9896
|
+
"convert:hardis:project:profilestopermsets",
|
|
9897
|
+
"convert:project:hardis:profilestopermsets",
|
|
9898
|
+
"convert:project:profilestopermsets:hardis",
|
|
9899
|
+
"hardis:convert:profilestopermsets:project",
|
|
9900
|
+
"convert:hardis:profilestopermsets:project",
|
|
9901
|
+
"convert:profilestopermsets:hardis:project",
|
|
9902
|
+
"convert:profilestopermsets:project:hardis",
|
|
9903
|
+
"hardis:project:profilestopermsets:convert",
|
|
9904
|
+
"project:hardis:profilestopermsets:convert",
|
|
9905
|
+
"project:profilestopermsets:hardis:convert",
|
|
9906
|
+
"project:profilestopermsets:convert:hardis",
|
|
9907
|
+
"hardis:profilestopermsets:project:convert",
|
|
9908
|
+
"profilestopermsets:hardis:project:convert",
|
|
9909
|
+
"profilestopermsets:project:hardis:convert",
|
|
9910
|
+
"profilestopermsets:project:convert:hardis",
|
|
9911
|
+
"hardis:profilestopermsets:convert:project",
|
|
9912
|
+
"profilestopermsets:hardis:convert:project",
|
|
9913
|
+
"profilestopermsets:convert:hardis:project",
|
|
9914
|
+
"profilestopermsets:convert:project:hardis"
|
|
9915
|
+
]
|
|
9916
|
+
},
|
|
9685
9917
|
"hardis:project:clean:emptyitems": {
|
|
9686
9918
|
"aliases": [],
|
|
9687
9919
|
"args": {},
|
|
@@ -11167,238 +11399,6 @@
|
|
|
11167
11399
|
"xml:clean:project:hardis"
|
|
11168
11400
|
]
|
|
11169
11401
|
},
|
|
11170
|
-
"hardis:project:configure:auth": {
|
|
11171
|
-
"aliases": [],
|
|
11172
|
-
"args": {},
|
|
11173
|
-
"description": "\n## Command Behavior\n\n**Configures authentication between a Git branch and a target Salesforce org for CI/CD deployments.**\n\nThis command facilitates the setup of automated CI/CD pipelines, enabling seamless deployments from specific Git branches to designated Salesforce orgs. It supports both standard Salesforce orgs and Dev Hub configurations, catering to various enterprise deployment workflows.\n\nKey functionalities include:\n\n- **Org Selection/Login:** Guides the user to select an existing Salesforce org or log in to a new one.\n- **Git Branch Association:** Allows associating a specific Git branch with the chosen Salesforce org.\n- **Merge Target Definition:** Enables defining target Git branches into which the configured branch can merge, ensuring controlled deployment flows.\n- **Salesforce Username Configuration:** Prompts for the Salesforce username to be used by the CI server for deployments.\n- **SSL Certificate Generation:** Automatically generates an SSL certificate for secure authentication.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's implementation involves several key technical aspects:\n\n- **SF CLI Integration:** Utilizes \n@salesforce/sf-plugins-core\n for command structure and flag parsing.\n- **Interactive Prompts:** Employs the \nprompts\n library for interactive user input, guiding the configuration process.\n- **Git Integration:** Interacts with Git to retrieve branch information using \n`git().branch([\"--list\", \"-r\"])`\n.\n- **Configuration Management:** Leverages internal utilities (`checkConfig`, `getConfig`, `setConfig`, `setInConfigFile`) to read from and write to project-specific configuration files (e.g., `.sfdx-hardis.<branchName>.yml`).\n- **Salesforce CLI Execution:** Executes Salesforce CLI commands programmatically via `execSfdxJson` for org interactions.\n- **SSL Certificate Generation:** Calls `generateSSLCertificate` to create necessary SSL certificates for JWT-based authentication.\n- **WebSocket Communication:** Uses `WebSocketClient` for potential communication with external tools or processes, such as restarting the command in VS Code.\n- **Dependency Check:** Ensures the presence of `openssl` on the system, which is required for SSL certificate generation.\n",
|
|
11174
|
-
"examples": [
|
|
11175
|
-
"$ sf hardis:project:configure:auth"
|
|
11176
|
-
],
|
|
11177
|
-
"flags": {
|
|
11178
|
-
"json": {
|
|
11179
|
-
"description": "Format output as json.",
|
|
11180
|
-
"helpGroup": "GLOBAL",
|
|
11181
|
-
"name": "json",
|
|
11182
|
-
"allowNo": false,
|
|
11183
|
-
"type": "boolean"
|
|
11184
|
-
},
|
|
11185
|
-
"flags-dir": {
|
|
11186
|
-
"helpGroup": "GLOBAL",
|
|
11187
|
-
"name": "flags-dir",
|
|
11188
|
-
"summary": "Import flag values from a directory.",
|
|
11189
|
-
"hasDynamicHelp": false,
|
|
11190
|
-
"multiple": false,
|
|
11191
|
-
"type": "option"
|
|
11192
|
-
},
|
|
11193
|
-
"devhub": {
|
|
11194
|
-
"char": "b",
|
|
11195
|
-
"description": "Configure project DevHub",
|
|
11196
|
-
"name": "devhub",
|
|
11197
|
-
"allowNo": false,
|
|
11198
|
-
"type": "boolean"
|
|
11199
|
-
},
|
|
11200
|
-
"debug": {
|
|
11201
|
-
"char": "d",
|
|
11202
|
-
"description": "Activate debug mode (more logs)",
|
|
11203
|
-
"name": "debug",
|
|
11204
|
-
"allowNo": false,
|
|
11205
|
-
"type": "boolean"
|
|
11206
|
-
},
|
|
11207
|
-
"websocket": {
|
|
11208
|
-
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
11209
|
-
"name": "websocket",
|
|
11210
|
-
"hasDynamicHelp": false,
|
|
11211
|
-
"multiple": false,
|
|
11212
|
-
"type": "option"
|
|
11213
|
-
},
|
|
11214
|
-
"skipauth": {
|
|
11215
|
-
"description": "Skip authentication check when a default username is required",
|
|
11216
|
-
"name": "skipauth",
|
|
11217
|
-
"allowNo": false,
|
|
11218
|
-
"type": "boolean"
|
|
11219
|
-
},
|
|
11220
|
-
"target-org": {
|
|
11221
|
-
"aliases": [
|
|
11222
|
-
"targetusername",
|
|
11223
|
-
"u"
|
|
11224
|
-
],
|
|
11225
|
-
"char": "o",
|
|
11226
|
-
"deprecateAliases": true,
|
|
11227
|
-
"name": "target-org",
|
|
11228
|
-
"noCacheDefault": true,
|
|
11229
|
-
"summary": "Username or alias of the target org.",
|
|
11230
|
-
"hasDynamicHelp": true,
|
|
11231
|
-
"multiple": false,
|
|
11232
|
-
"type": "option"
|
|
11233
|
-
},
|
|
11234
|
-
"target-dev-hub": {
|
|
11235
|
-
"aliases": [
|
|
11236
|
-
"targetdevhubusername"
|
|
11237
|
-
],
|
|
11238
|
-
"char": "v",
|
|
11239
|
-
"deprecateAliases": true,
|
|
11240
|
-
"name": "target-dev-hub",
|
|
11241
|
-
"noCacheDefault": true,
|
|
11242
|
-
"required": false,
|
|
11243
|
-
"summary": "Username or alias of the Dev Hub org.",
|
|
11244
|
-
"hasDynamicHelp": true,
|
|
11245
|
-
"multiple": false,
|
|
11246
|
-
"type": "option"
|
|
11247
|
-
}
|
|
11248
|
-
},
|
|
11249
|
-
"hasDynamicHelp": true,
|
|
11250
|
-
"hiddenAliases": [],
|
|
11251
|
-
"id": "hardis:project:configure:auth",
|
|
11252
|
-
"pluginAlias": "sfdx-hardis",
|
|
11253
|
-
"pluginName": "sfdx-hardis",
|
|
11254
|
-
"pluginType": "core",
|
|
11255
|
-
"strict": true,
|
|
11256
|
-
"enableJsonFlag": true,
|
|
11257
|
-
"title": "Configure authentication",
|
|
11258
|
-
"requiresProject": false,
|
|
11259
|
-
"requiresDependencies": [
|
|
11260
|
-
"openssl"
|
|
11261
|
-
],
|
|
11262
|
-
"isESM": true,
|
|
11263
|
-
"relativePath": [
|
|
11264
|
-
"lib",
|
|
11265
|
-
"commands",
|
|
11266
|
-
"hardis",
|
|
11267
|
-
"project",
|
|
11268
|
-
"configure",
|
|
11269
|
-
"auth.js"
|
|
11270
|
-
],
|
|
11271
|
-
"aliasPermutations": [],
|
|
11272
|
-
"permutations": [
|
|
11273
|
-
"hardis:project:configure:auth",
|
|
11274
|
-
"project:hardis:configure:auth",
|
|
11275
|
-
"project:configure:hardis:auth",
|
|
11276
|
-
"project:configure:auth:hardis",
|
|
11277
|
-
"hardis:configure:project:auth",
|
|
11278
|
-
"configure:hardis:project:auth",
|
|
11279
|
-
"configure:project:hardis:auth",
|
|
11280
|
-
"configure:project:auth:hardis",
|
|
11281
|
-
"hardis:configure:auth:project",
|
|
11282
|
-
"configure:hardis:auth:project",
|
|
11283
|
-
"configure:auth:hardis:project",
|
|
11284
|
-
"configure:auth:project:hardis",
|
|
11285
|
-
"hardis:project:auth:configure",
|
|
11286
|
-
"project:hardis:auth:configure",
|
|
11287
|
-
"project:auth:hardis:configure",
|
|
11288
|
-
"project:auth:configure:hardis",
|
|
11289
|
-
"hardis:auth:project:configure",
|
|
11290
|
-
"auth:hardis:project:configure",
|
|
11291
|
-
"auth:project:hardis:configure",
|
|
11292
|
-
"auth:project:configure:hardis",
|
|
11293
|
-
"hardis:auth:configure:project",
|
|
11294
|
-
"auth:hardis:configure:project",
|
|
11295
|
-
"auth:configure:hardis:project",
|
|
11296
|
-
"auth:configure:project:hardis"
|
|
11297
|
-
]
|
|
11298
|
-
},
|
|
11299
|
-
"hardis:project:convert:profilestopermsets": {
|
|
11300
|
-
"aliases": [],
|
|
11301
|
-
"args": {},
|
|
11302
|
-
"description": "\n## Command Behavior\n\n**Converts existing Salesforce Profiles into Permission Sets, facilitating a more granular and recommended security model.**\n\nThis command helps in migrating permissions from Profiles to Permission Sets, which is a best practice for managing user access in Salesforce. It creates a new Permission Set for each specified Profile, adopting a naming convention of `PS_PROFILENAME`.\n\nKey functionalities:\n\n- **Profile to Permission Set Conversion:** Automatically extracts permissions from a Profile and creates a corresponding Permission Set.\n- **Naming Convention:** New Permission Sets are named with a `PS_` prefix followed by the Profile name (e.g., `PS_Standard_User`).\n- **Exclusion Filter:** Allows you to exclude specific Profiles from the conversion process using the `--except` flag.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **External Plugin Integration:** It relies on the `shane-sfdx-plugins` (specifically the `sf shane:profile:convert` command) to perform the actual conversion.\n- **File System Scan:** It reads the contents of the `force-app/main/default/profiles` directory to identify all available Profile metadata files.\n- **Command Execution:** For each identified Profile (that is not excluded), it constructs and executes the `sf shane:profile:convert` command with the appropriate Profile name and desired Permission Set name.\n- **Error Handling:** Includes basic error handling for the external command execution.\n</details>\n",
|
|
11303
|
-
"examples": [
|
|
11304
|
-
"$ sf hardis:project:convert:profilestopermsets"
|
|
11305
|
-
],
|
|
11306
|
-
"flags": {
|
|
11307
|
-
"json": {
|
|
11308
|
-
"description": "Format output as json.",
|
|
11309
|
-
"helpGroup": "GLOBAL",
|
|
11310
|
-
"name": "json",
|
|
11311
|
-
"allowNo": false,
|
|
11312
|
-
"type": "boolean"
|
|
11313
|
-
},
|
|
11314
|
-
"flags-dir": {
|
|
11315
|
-
"helpGroup": "GLOBAL",
|
|
11316
|
-
"name": "flags-dir",
|
|
11317
|
-
"summary": "Import flag values from a directory.",
|
|
11318
|
-
"hasDynamicHelp": false,
|
|
11319
|
-
"multiple": false,
|
|
11320
|
-
"type": "option"
|
|
11321
|
-
},
|
|
11322
|
-
"except": {
|
|
11323
|
-
"char": "e",
|
|
11324
|
-
"description": "List of filters",
|
|
11325
|
-
"name": "except",
|
|
11326
|
-
"default": [],
|
|
11327
|
-
"hasDynamicHelp": false,
|
|
11328
|
-
"multiple": true,
|
|
11329
|
-
"type": "option"
|
|
11330
|
-
},
|
|
11331
|
-
"debug": {
|
|
11332
|
-
"char": "d",
|
|
11333
|
-
"description": "Activate debug mode (more logs)",
|
|
11334
|
-
"name": "debug",
|
|
11335
|
-
"allowNo": false,
|
|
11336
|
-
"type": "boolean"
|
|
11337
|
-
},
|
|
11338
|
-
"websocket": {
|
|
11339
|
-
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
11340
|
-
"name": "websocket",
|
|
11341
|
-
"hasDynamicHelp": false,
|
|
11342
|
-
"multiple": false,
|
|
11343
|
-
"type": "option"
|
|
11344
|
-
},
|
|
11345
|
-
"skipauth": {
|
|
11346
|
-
"description": "Skip authentication check when a default username is required",
|
|
11347
|
-
"name": "skipauth",
|
|
11348
|
-
"allowNo": false,
|
|
11349
|
-
"type": "boolean"
|
|
11350
|
-
}
|
|
11351
|
-
},
|
|
11352
|
-
"hasDynamicHelp": false,
|
|
11353
|
-
"hiddenAliases": [],
|
|
11354
|
-
"id": "hardis:project:convert:profilestopermsets",
|
|
11355
|
-
"pluginAlias": "sfdx-hardis",
|
|
11356
|
-
"pluginName": "sfdx-hardis",
|
|
11357
|
-
"pluginType": "core",
|
|
11358
|
-
"strict": true,
|
|
11359
|
-
"enableJsonFlag": true,
|
|
11360
|
-
"title": "Convert Profiles into Permission Sets",
|
|
11361
|
-
"requiresProject": true,
|
|
11362
|
-
"requiresSfdxPlugins": [
|
|
11363
|
-
"shane-sfdx-plugins"
|
|
11364
|
-
],
|
|
11365
|
-
"isESM": true,
|
|
11366
|
-
"relativePath": [
|
|
11367
|
-
"lib",
|
|
11368
|
-
"commands",
|
|
11369
|
-
"hardis",
|
|
11370
|
-
"project",
|
|
11371
|
-
"convert",
|
|
11372
|
-
"profilestopermsets.js"
|
|
11373
|
-
],
|
|
11374
|
-
"aliasPermutations": [],
|
|
11375
|
-
"permutations": [
|
|
11376
|
-
"hardis:project:convert:profilestopermsets",
|
|
11377
|
-
"project:hardis:convert:profilestopermsets",
|
|
11378
|
-
"project:convert:hardis:profilestopermsets",
|
|
11379
|
-
"project:convert:profilestopermsets:hardis",
|
|
11380
|
-
"hardis:convert:project:profilestopermsets",
|
|
11381
|
-
"convert:hardis:project:profilestopermsets",
|
|
11382
|
-
"convert:project:hardis:profilestopermsets",
|
|
11383
|
-
"convert:project:profilestopermsets:hardis",
|
|
11384
|
-
"hardis:convert:profilestopermsets:project",
|
|
11385
|
-
"convert:hardis:profilestopermsets:project",
|
|
11386
|
-
"convert:profilestopermsets:hardis:project",
|
|
11387
|
-
"convert:profilestopermsets:project:hardis",
|
|
11388
|
-
"hardis:project:profilestopermsets:convert",
|
|
11389
|
-
"project:hardis:profilestopermsets:convert",
|
|
11390
|
-
"project:profilestopermsets:hardis:convert",
|
|
11391
|
-
"project:profilestopermsets:convert:hardis",
|
|
11392
|
-
"hardis:profilestopermsets:project:convert",
|
|
11393
|
-
"profilestopermsets:hardis:project:convert",
|
|
11394
|
-
"profilestopermsets:project:hardis:convert",
|
|
11395
|
-
"profilestopermsets:project:convert:hardis",
|
|
11396
|
-
"hardis:profilestopermsets:convert:project",
|
|
11397
|
-
"profilestopermsets:hardis:convert:project",
|
|
11398
|
-
"profilestopermsets:convert:hardis:project",
|
|
11399
|
-
"profilestopermsets:convert:project:hardis"
|
|
11400
|
-
]
|
|
11401
|
-
},
|
|
11402
11402
|
"hardis:project:deploy:notify": {
|
|
11403
11403
|
"aliases": [],
|
|
11404
11404
|
"args": {},
|
|
@@ -15271,5 +15271,5 @@
|
|
|
15271
15271
|
]
|
|
15272
15272
|
}
|
|
15273
15273
|
},
|
|
15274
|
-
"version": "6.4.0"
|
|
15274
|
+
"version": "6.4.1-beta202509082207.0"
|
|
15275
15275
|
}
|