sfdx-hardis 6.0.7-beta202508231311.0 → 6.0.7-beta202508231327.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 +1064 -1064
- 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": {
|
|
@@ -4407,135 +4407,6 @@
|
|
|
4407
4407
|
"ws:work:hardis"
|
|
4408
4408
|
]
|
|
4409
4409
|
},
|
|
4410
|
-
"hardis:git:pull-requests:extract": {
|
|
4411
|
-
"aliases": [],
|
|
4412
|
-
"args": {},
|
|
4413
|
-
"description": "\n## Command Behavior\n\n**Extracts pull request information from your Git server based on specified filtering criteria.**\n\nThis command provides a powerful way to query and retrieve details about pull requests (or merge requests, depending on your Git provider) in your repository. It's highly useful for reporting, auditing, and analyzing development workflows.\n\nKey functionalities include:\n\n- **Target Branch Filtering:** You can filter pull requests by their target branch using the `--target-branch` flag. If not specified, the command will prompt you to select one.\n- **Status Filtering:** Filter pull requests by their status: `open`, `merged`, or `abandoned` using the `--status` flag. An interactive prompt is provided if no status is specified.\n- **Minimum Date Filtering:** Use the `--min-date` flag to retrieve pull requests created or updated after a specific date.\n- **CSV Output:** The extracted pull request data is generated into a CSV file, which can be used for further analysis in spreadsheet software.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves interacting with a Git provider's API:\n\n- **Git Provider Abstraction:** It uses the `GitProvider.getInstance(true)` to abstract away the specifics of different Git platforms (e.g., GitHub, GitLab, Azure DevOps). This ensures the command can work across various environments.\n- **API Calls:** The `gitProvider.listPullRequests()` method is called with a `prConstraint` object that encapsulates the filtering criteria (target branch, minimum date, status).\n- **Interactive Prompts:** The `prompts` library is used to interactively gather input from the user for the target branch and pull request status if they are not provided as command-line flags.\n- **Date Handling:** The `moment` library is used to parse and handle date inputs for the `--min-date` flag.\n- **CSV Generation:** The `generateCsvFile` utility is responsible for converting the retrieved pull request data into a CSV format, and `generateReportPath` determines the output file location.\n- **Error Handling:** It includes error handling for cases where a Git provider cannot be identified.\n</details>\n",
|
|
4414
|
-
"examples": [
|
|
4415
|
-
"$ sf hardis:git:pull-requests:extract",
|
|
4416
|
-
"$ sf hardis:git:pull-requests:extract --target-branch main --status merged"
|
|
4417
|
-
],
|
|
4418
|
-
"flags": {
|
|
4419
|
-
"json": {
|
|
4420
|
-
"description": "Format output as json.",
|
|
4421
|
-
"helpGroup": "GLOBAL",
|
|
4422
|
-
"name": "json",
|
|
4423
|
-
"allowNo": false,
|
|
4424
|
-
"type": "boolean"
|
|
4425
|
-
},
|
|
4426
|
-
"flags-dir": {
|
|
4427
|
-
"helpGroup": "GLOBAL",
|
|
4428
|
-
"name": "flags-dir",
|
|
4429
|
-
"summary": "Import flag values from a directory.",
|
|
4430
|
-
"hasDynamicHelp": false,
|
|
4431
|
-
"multiple": false,
|
|
4432
|
-
"type": "option"
|
|
4433
|
-
},
|
|
4434
|
-
"target-branch": {
|
|
4435
|
-
"char": "t",
|
|
4436
|
-
"description": "Target branch of PRs",
|
|
4437
|
-
"name": "target-branch",
|
|
4438
|
-
"hasDynamicHelp": false,
|
|
4439
|
-
"multiple": false,
|
|
4440
|
-
"type": "option"
|
|
4441
|
-
},
|
|
4442
|
-
"status": {
|
|
4443
|
-
"char": "x",
|
|
4444
|
-
"description": "Status of the PR",
|
|
4445
|
-
"name": "status",
|
|
4446
|
-
"hasDynamicHelp": false,
|
|
4447
|
-
"multiple": false,
|
|
4448
|
-
"options": [
|
|
4449
|
-
"open",
|
|
4450
|
-
"merged",
|
|
4451
|
-
"abandoned"
|
|
4452
|
-
],
|
|
4453
|
-
"type": "option"
|
|
4454
|
-
},
|
|
4455
|
-
"min-date": {
|
|
4456
|
-
"char": "m",
|
|
4457
|
-
"description": "Minimum date for PR",
|
|
4458
|
-
"name": "min-date",
|
|
4459
|
-
"hasDynamicHelp": false,
|
|
4460
|
-
"multiple": false,
|
|
4461
|
-
"type": "option"
|
|
4462
|
-
},
|
|
4463
|
-
"outputfile": {
|
|
4464
|
-
"char": "f",
|
|
4465
|
-
"description": "Force the path and name of output report file. Must end with .csv",
|
|
4466
|
-
"name": "outputfile",
|
|
4467
|
-
"hasDynamicHelp": false,
|
|
4468
|
-
"multiple": false,
|
|
4469
|
-
"type": "option"
|
|
4470
|
-
},
|
|
4471
|
-
"debug": {
|
|
4472
|
-
"char": "d",
|
|
4473
|
-
"description": "Activate debug mode (more logs)",
|
|
4474
|
-
"name": "debug",
|
|
4475
|
-
"allowNo": false,
|
|
4476
|
-
"type": "boolean"
|
|
4477
|
-
},
|
|
4478
|
-
"websocket": {
|
|
4479
|
-
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
4480
|
-
"name": "websocket",
|
|
4481
|
-
"hasDynamicHelp": false,
|
|
4482
|
-
"multiple": false,
|
|
4483
|
-
"type": "option"
|
|
4484
|
-
},
|
|
4485
|
-
"skipauth": {
|
|
4486
|
-
"description": "Skip authentication check when a default username is required",
|
|
4487
|
-
"name": "skipauth",
|
|
4488
|
-
"allowNo": false,
|
|
4489
|
-
"type": "boolean"
|
|
4490
|
-
}
|
|
4491
|
-
},
|
|
4492
|
-
"hasDynamicHelp": false,
|
|
4493
|
-
"hiddenAliases": [],
|
|
4494
|
-
"id": "hardis:git:pull-requests:extract",
|
|
4495
|
-
"pluginAlias": "sfdx-hardis",
|
|
4496
|
-
"pluginName": "sfdx-hardis",
|
|
4497
|
-
"pluginType": "core",
|
|
4498
|
-
"strict": true,
|
|
4499
|
-
"enableJsonFlag": true,
|
|
4500
|
-
"title": "Extract pull requests",
|
|
4501
|
-
"requiresProject": true,
|
|
4502
|
-
"isESM": true,
|
|
4503
|
-
"relativePath": [
|
|
4504
|
-
"lib",
|
|
4505
|
-
"commands",
|
|
4506
|
-
"hardis",
|
|
4507
|
-
"git",
|
|
4508
|
-
"pull-requests",
|
|
4509
|
-
"extract.js"
|
|
4510
|
-
],
|
|
4511
|
-
"aliasPermutations": [],
|
|
4512
|
-
"permutations": [
|
|
4513
|
-
"hardis:git:pull-requests:extract",
|
|
4514
|
-
"git:hardis:pull-requests:extract",
|
|
4515
|
-
"git:pull-requests:hardis:extract",
|
|
4516
|
-
"git:pull-requests:extract:hardis",
|
|
4517
|
-
"hardis:pull-requests:git:extract",
|
|
4518
|
-
"pull-requests:hardis:git:extract",
|
|
4519
|
-
"pull-requests:git:hardis:extract",
|
|
4520
|
-
"pull-requests:git:extract:hardis",
|
|
4521
|
-
"hardis:pull-requests:extract:git",
|
|
4522
|
-
"pull-requests:hardis:extract:git",
|
|
4523
|
-
"pull-requests:extract:hardis:git",
|
|
4524
|
-
"pull-requests:extract:git:hardis",
|
|
4525
|
-
"hardis:git:extract:pull-requests",
|
|
4526
|
-
"git:hardis:extract:pull-requests",
|
|
4527
|
-
"git:extract:hardis:pull-requests",
|
|
4528
|
-
"git:extract:pull-requests:hardis",
|
|
4529
|
-
"hardis:extract:git:pull-requests",
|
|
4530
|
-
"extract:hardis:git:pull-requests",
|
|
4531
|
-
"extract:git:hardis:pull-requests",
|
|
4532
|
-
"extract:git:pull-requests:hardis",
|
|
4533
|
-
"hardis:extract:pull-requests:git",
|
|
4534
|
-
"extract:hardis:pull-requests:git",
|
|
4535
|
-
"extract:pull-requests:hardis:git",
|
|
4536
|
-
"extract:pull-requests:git:hardis"
|
|
4537
|
-
]
|
|
4538
|
-
},
|
|
4539
4410
|
"hardis:doc:extract:permsetgroups": {
|
|
4540
4411
|
"aliases": [],
|
|
4541
4412
|
"args": {},
|
|
@@ -4726,13 +4597,13 @@
|
|
|
4726
4597
|
"generate:plugin:doc:hardis"
|
|
4727
4598
|
]
|
|
4728
4599
|
},
|
|
4729
|
-
"hardis:
|
|
4600
|
+
"hardis:git:pull-requests:extract": {
|
|
4730
4601
|
"aliases": [],
|
|
4731
4602
|
"args": {},
|
|
4732
|
-
"description": "\n## Command Behavior\n\n**
|
|
4603
|
+
"description": "\n## Command Behavior\n\n**Extracts pull request information from your Git server based on specified filtering criteria.**\n\nThis command provides a powerful way to query and retrieve details about pull requests (or merge requests, depending on your Git provider) in your repository. It's highly useful for reporting, auditing, and analyzing development workflows.\n\nKey functionalities include:\n\n- **Target Branch Filtering:** You can filter pull requests by their target branch using the `--target-branch` flag. If not specified, the command will prompt you to select one.\n- **Status Filtering:** Filter pull requests by their status: `open`, `merged`, or `abandoned` using the `--status` flag. An interactive prompt is provided if no status is specified.\n- **Minimum Date Filtering:** Use the `--min-date` flag to retrieve pull requests created or updated after a specific date.\n- **CSV Output:** The extracted pull request data is generated into a CSV file, which can be used for further analysis in spreadsheet software.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves interacting with a Git provider's API:\n\n- **Git Provider Abstraction:** It uses the `GitProvider.getInstance(true)` to abstract away the specifics of different Git platforms (e.g., GitHub, GitLab, Azure DevOps). This ensures the command can work across various environments.\n- **API Calls:** The `gitProvider.listPullRequests()` method is called with a `prConstraint` object that encapsulates the filtering criteria (target branch, minimum date, status).\n- **Interactive Prompts:** The `prompts` library is used to interactively gather input from the user for the target branch and pull request status if they are not provided as command-line flags.\n- **Date Handling:** The `moment` library is used to parse and handle date inputs for the `--min-date` flag.\n- **CSV Generation:** The `generateCsvFile` utility is responsible for converting the retrieved pull request data into a CSV format, and `generateReportPath` determines the output file location.\n- **Error Handling:** It includes error handling for cases where a Git provider cannot be identified.\n</details>\n",
|
|
4733
4604
|
"examples": [
|
|
4734
|
-
"$ sf hardis:
|
|
4735
|
-
"$ sf hardis:
|
|
4605
|
+
"$ sf hardis:git:pull-requests:extract",
|
|
4606
|
+
"$ sf hardis:git:pull-requests:extract --target-branch main --status merged"
|
|
4736
4607
|
],
|
|
4737
4608
|
"flags": {
|
|
4738
4609
|
"json": {
|
|
@@ -4750,11 +4621,140 @@
|
|
|
4750
4621
|
"multiple": false,
|
|
4751
4622
|
"type": "option"
|
|
4752
4623
|
},
|
|
4753
|
-
"
|
|
4754
|
-
"char": "
|
|
4755
|
-
"description": "
|
|
4756
|
-
"name": "
|
|
4757
|
-
"
|
|
4624
|
+
"target-branch": {
|
|
4625
|
+
"char": "t",
|
|
4626
|
+
"description": "Target branch of PRs",
|
|
4627
|
+
"name": "target-branch",
|
|
4628
|
+
"hasDynamicHelp": false,
|
|
4629
|
+
"multiple": false,
|
|
4630
|
+
"type": "option"
|
|
4631
|
+
},
|
|
4632
|
+
"status": {
|
|
4633
|
+
"char": "x",
|
|
4634
|
+
"description": "Status of the PR",
|
|
4635
|
+
"name": "status",
|
|
4636
|
+
"hasDynamicHelp": false,
|
|
4637
|
+
"multiple": false,
|
|
4638
|
+
"options": [
|
|
4639
|
+
"open",
|
|
4640
|
+
"merged",
|
|
4641
|
+
"abandoned"
|
|
4642
|
+
],
|
|
4643
|
+
"type": "option"
|
|
4644
|
+
},
|
|
4645
|
+
"min-date": {
|
|
4646
|
+
"char": "m",
|
|
4647
|
+
"description": "Minimum date for PR",
|
|
4648
|
+
"name": "min-date",
|
|
4649
|
+
"hasDynamicHelp": false,
|
|
4650
|
+
"multiple": false,
|
|
4651
|
+
"type": "option"
|
|
4652
|
+
},
|
|
4653
|
+
"outputfile": {
|
|
4654
|
+
"char": "f",
|
|
4655
|
+
"description": "Force the path and name of output report file. Must end with .csv",
|
|
4656
|
+
"name": "outputfile",
|
|
4657
|
+
"hasDynamicHelp": false,
|
|
4658
|
+
"multiple": false,
|
|
4659
|
+
"type": "option"
|
|
4660
|
+
},
|
|
4661
|
+
"debug": {
|
|
4662
|
+
"char": "d",
|
|
4663
|
+
"description": "Activate debug mode (more logs)",
|
|
4664
|
+
"name": "debug",
|
|
4665
|
+
"allowNo": false,
|
|
4666
|
+
"type": "boolean"
|
|
4667
|
+
},
|
|
4668
|
+
"websocket": {
|
|
4669
|
+
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
4670
|
+
"name": "websocket",
|
|
4671
|
+
"hasDynamicHelp": false,
|
|
4672
|
+
"multiple": false,
|
|
4673
|
+
"type": "option"
|
|
4674
|
+
},
|
|
4675
|
+
"skipauth": {
|
|
4676
|
+
"description": "Skip authentication check when a default username is required",
|
|
4677
|
+
"name": "skipauth",
|
|
4678
|
+
"allowNo": false,
|
|
4679
|
+
"type": "boolean"
|
|
4680
|
+
}
|
|
4681
|
+
},
|
|
4682
|
+
"hasDynamicHelp": false,
|
|
4683
|
+
"hiddenAliases": [],
|
|
4684
|
+
"id": "hardis:git:pull-requests:extract",
|
|
4685
|
+
"pluginAlias": "sfdx-hardis",
|
|
4686
|
+
"pluginName": "sfdx-hardis",
|
|
4687
|
+
"pluginType": "core",
|
|
4688
|
+
"strict": true,
|
|
4689
|
+
"enableJsonFlag": true,
|
|
4690
|
+
"title": "Extract pull requests",
|
|
4691
|
+
"requiresProject": true,
|
|
4692
|
+
"isESM": true,
|
|
4693
|
+
"relativePath": [
|
|
4694
|
+
"lib",
|
|
4695
|
+
"commands",
|
|
4696
|
+
"hardis",
|
|
4697
|
+
"git",
|
|
4698
|
+
"pull-requests",
|
|
4699
|
+
"extract.js"
|
|
4700
|
+
],
|
|
4701
|
+
"aliasPermutations": [],
|
|
4702
|
+
"permutations": [
|
|
4703
|
+
"hardis:git:pull-requests:extract",
|
|
4704
|
+
"git:hardis:pull-requests:extract",
|
|
4705
|
+
"git:pull-requests:hardis:extract",
|
|
4706
|
+
"git:pull-requests:extract:hardis",
|
|
4707
|
+
"hardis:pull-requests:git:extract",
|
|
4708
|
+
"pull-requests:hardis:git:extract",
|
|
4709
|
+
"pull-requests:git:hardis:extract",
|
|
4710
|
+
"pull-requests:git:extract:hardis",
|
|
4711
|
+
"hardis:pull-requests:extract:git",
|
|
4712
|
+
"pull-requests:hardis:extract:git",
|
|
4713
|
+
"pull-requests:extract:hardis:git",
|
|
4714
|
+
"pull-requests:extract:git:hardis",
|
|
4715
|
+
"hardis:git:extract:pull-requests",
|
|
4716
|
+
"git:hardis:extract:pull-requests",
|
|
4717
|
+
"git:extract:hardis:pull-requests",
|
|
4718
|
+
"git:extract:pull-requests:hardis",
|
|
4719
|
+
"hardis:extract:git:pull-requests",
|
|
4720
|
+
"extract:hardis:git:pull-requests",
|
|
4721
|
+
"extract:git:hardis:pull-requests",
|
|
4722
|
+
"extract:git:pull-requests:hardis",
|
|
4723
|
+
"hardis:extract:pull-requests:git",
|
|
4724
|
+
"extract:hardis:pull-requests:git",
|
|
4725
|
+
"extract:pull-requests:hardis:git",
|
|
4726
|
+
"extract:pull-requests:git:hardis"
|
|
4727
|
+
]
|
|
4728
|
+
},
|
|
4729
|
+
"hardis:org:community:update": {
|
|
4730
|
+
"aliases": [],
|
|
4731
|
+
"args": {},
|
|
4732
|
+
"description": "\n## Command Behavior\n\n**Updates the status of one or more Salesforce Experience Cloud (Community) networks.**\n\nThis command provides a way to programmatically change the status of your Salesforce Communities, allowing you to manage their availability. This is particularly useful for:\n\n- **Maintenance:** Taking communities offline for planned maintenance (`DownForMaintenance`).\n- **Activation/Deactivation:** Bringing communities online or offline (`Live`, `DownForMaintenance`).\n- **Automation:** Integrating community status changes into CI/CD pipelines or scheduled jobs.\n\nKey functionalities:\n\n- **Network Selection:** You can specify one or more community network names (separated by commas) using the `--name` flag.\n- **Status Update:** You can set the new status for the selected communities using the `--status` flag. Supported values are `Live` and `DownForMaintenance`.\n- **Confirmation Prompt:** In non-CI environments, it provides a confirmation prompt before executing the update, ensuring intentional changes.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **Salesforce SOQL Query:** It first queries the Salesforce `Network` object using SOQL to retrieve the `Id`, `Name`, and `Status` of the specified communities. This ensures that only existing communities are targeted.\n- **SObject Update:** It then constructs an array of `Network` sObjects with their `Id` and the new `Status` and performs a DML update operation using `conn.sobject(\"Network\").update()`. The `allOrNone: false` option is used to allow partial success in case some updates fail.\n- **Error Handling and Reporting:** It iterates through the update results, logging success or failure for each community. It also provides a summary of successful and erroneous updates.\n- **User Interaction:** Uses `prompts` to confirm the update action with the user when not running in a CI environment.\n- **Salesforce Connection:** Establishes a connection to the target Salesforce org using the `target-org` flag.\n</details>\n",
|
|
4733
|
+
"examples": [
|
|
4734
|
+
"$ sf hardis:org:community:update --name 'MyNetworkName' --status DownForMaintenance",
|
|
4735
|
+
"$ sf hardis:org:community:update --name 'MyNetworkName,MySecondNetworkName' --status Live"
|
|
4736
|
+
],
|
|
4737
|
+
"flags": {
|
|
4738
|
+
"json": {
|
|
4739
|
+
"description": "Format output as json.",
|
|
4740
|
+
"helpGroup": "GLOBAL",
|
|
4741
|
+
"name": "json",
|
|
4742
|
+
"allowNo": false,
|
|
4743
|
+
"type": "boolean"
|
|
4744
|
+
},
|
|
4745
|
+
"flags-dir": {
|
|
4746
|
+
"helpGroup": "GLOBAL",
|
|
4747
|
+
"name": "flags-dir",
|
|
4748
|
+
"summary": "Import flag values from a directory.",
|
|
4749
|
+
"hasDynamicHelp": false,
|
|
4750
|
+
"multiple": false,
|
|
4751
|
+
"type": "option"
|
|
4752
|
+
},
|
|
4753
|
+
"name": {
|
|
4754
|
+
"char": "n",
|
|
4755
|
+
"description": "List of Networks Names that you want to update, separated by comma",
|
|
4756
|
+
"name": "name",
|
|
4757
|
+
"required": true,
|
|
4758
4758
|
"hasDynamicHelp": false,
|
|
4759
4759
|
"multiple": false,
|
|
4760
4760
|
"type": "option"
|
|
@@ -5489,15 +5489,12 @@
|
|
|
5489
5489
|
"import:data:org:hardis"
|
|
5490
5490
|
]
|
|
5491
5491
|
},
|
|
5492
|
-
"hardis:org:
|
|
5492
|
+
"hardis:org:files:export": {
|
|
5493
5493
|
"aliases": [],
|
|
5494
5494
|
"args": {},
|
|
5495
|
-
"description": "
|
|
5495
|
+
"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",
|
|
5496
5496
|
"examples": [
|
|
5497
|
-
"$ sf hardis:org:
|
|
5498
|
-
"$ sf hardis:org:diagnose:audittrail --excludeusers baptiste@titi.com",
|
|
5499
|
-
"$ sf hardis:org:diagnose:audittrail --excludeusers baptiste@titi.com,bertrand@titi.com",
|
|
5500
|
-
"$ sf hardis:org:diagnose:audittrail --lastndays 5"
|
|
5497
|
+
"$ sf hardis:org:files:export"
|
|
5501
5498
|
],
|
|
5502
5499
|
"flags": {
|
|
5503
5500
|
"json": {
|
|
@@ -5515,26 +5512,37 @@
|
|
|
5515
5512
|
"multiple": false,
|
|
5516
5513
|
"type": "option"
|
|
5517
5514
|
},
|
|
5518
|
-
"
|
|
5519
|
-
"char": "
|
|
5520
|
-
"description": "
|
|
5521
|
-
"name": "
|
|
5515
|
+
"path": {
|
|
5516
|
+
"char": "p",
|
|
5517
|
+
"description": "Path to the file export project",
|
|
5518
|
+
"name": "path",
|
|
5522
5519
|
"hasDynamicHelp": false,
|
|
5523
5520
|
"multiple": false,
|
|
5524
5521
|
"type": "option"
|
|
5525
5522
|
},
|
|
5526
|
-
"
|
|
5523
|
+
"chunksize": {
|
|
5524
|
+
"char": "c",
|
|
5525
|
+
"description": "Number of records to add in a chunk before it is processed",
|
|
5526
|
+
"name": "chunksize",
|
|
5527
|
+
"default": 1000,
|
|
5528
|
+
"hasDynamicHelp": false,
|
|
5529
|
+
"multiple": false,
|
|
5530
|
+
"type": "option"
|
|
5531
|
+
},
|
|
5532
|
+
"polltimeout": {
|
|
5527
5533
|
"char": "t",
|
|
5528
|
-
"description": "
|
|
5529
|
-
"name": "
|
|
5534
|
+
"description": "Timeout in MS for Bulk API calls",
|
|
5535
|
+
"name": "polltimeout",
|
|
5536
|
+
"default": 300000,
|
|
5530
5537
|
"hasDynamicHelp": false,
|
|
5531
5538
|
"multiple": false,
|
|
5532
5539
|
"type": "option"
|
|
5533
5540
|
},
|
|
5534
|
-
"
|
|
5535
|
-
"char": "
|
|
5536
|
-
"description": "
|
|
5537
|
-
"name": "
|
|
5541
|
+
"startchunknumber": {
|
|
5542
|
+
"char": "s",
|
|
5543
|
+
"description": "Chunk number to start from",
|
|
5544
|
+
"name": "startchunknumber",
|
|
5545
|
+
"default": 0,
|
|
5538
5546
|
"hasDynamicHelp": false,
|
|
5539
5547
|
"multiple": false,
|
|
5540
5548
|
"type": "option"
|
|
@@ -5577,13 +5585,13 @@
|
|
|
5577
5585
|
},
|
|
5578
5586
|
"hasDynamicHelp": true,
|
|
5579
5587
|
"hiddenAliases": [],
|
|
5580
|
-
"id": "hardis:org:
|
|
5588
|
+
"id": "hardis:org:files:export",
|
|
5581
5589
|
"pluginAlias": "sfdx-hardis",
|
|
5582
5590
|
"pluginName": "sfdx-hardis",
|
|
5583
5591
|
"pluginType": "core",
|
|
5584
5592
|
"strict": true,
|
|
5585
5593
|
"enableJsonFlag": true,
|
|
5586
|
-
"title": "
|
|
5594
|
+
"title": "Export files",
|
|
5587
5595
|
"requiresProject": false,
|
|
5588
5596
|
"isESM": true,
|
|
5589
5597
|
"relativePath": [
|
|
@@ -5591,43 +5599,43 @@
|
|
|
5591
5599
|
"commands",
|
|
5592
5600
|
"hardis",
|
|
5593
5601
|
"org",
|
|
5594
|
-
"
|
|
5595
|
-
"
|
|
5602
|
+
"files",
|
|
5603
|
+
"export.js"
|
|
5596
5604
|
],
|
|
5597
5605
|
"aliasPermutations": [],
|
|
5598
5606
|
"permutations": [
|
|
5599
|
-
"hardis:org:
|
|
5600
|
-
"org:hardis:
|
|
5601
|
-
"org:
|
|
5602
|
-
"org:
|
|
5603
|
-
"hardis:
|
|
5604
|
-
"
|
|
5605
|
-
"
|
|
5606
|
-
"
|
|
5607
|
-
"hardis:
|
|
5608
|
-
"
|
|
5609
|
-
"
|
|
5610
|
-
"
|
|
5611
|
-
"hardis:org:
|
|
5612
|
-
"org:hardis:
|
|
5613
|
-
"org:
|
|
5614
|
-
"org:
|
|
5615
|
-
"hardis:
|
|
5616
|
-
"
|
|
5617
|
-
"
|
|
5618
|
-
"
|
|
5619
|
-
"hardis:
|
|
5620
|
-
"
|
|
5621
|
-
"
|
|
5622
|
-
"
|
|
5607
|
+
"hardis:org:files:export",
|
|
5608
|
+
"org:hardis:files:export",
|
|
5609
|
+
"org:files:hardis:export",
|
|
5610
|
+
"org:files:export:hardis",
|
|
5611
|
+
"hardis:files:org:export",
|
|
5612
|
+
"files:hardis:org:export",
|
|
5613
|
+
"files:org:hardis:export",
|
|
5614
|
+
"files:org:export:hardis",
|
|
5615
|
+
"hardis:files:export:org",
|
|
5616
|
+
"files:hardis:export:org",
|
|
5617
|
+
"files:export:hardis:org",
|
|
5618
|
+
"files:export:org:hardis",
|
|
5619
|
+
"hardis:org:export:files",
|
|
5620
|
+
"org:hardis:export:files",
|
|
5621
|
+
"org:export:hardis:files",
|
|
5622
|
+
"org:export:files:hardis",
|
|
5623
|
+
"hardis:export:org:files",
|
|
5624
|
+
"export:hardis:org:files",
|
|
5625
|
+
"export:org:hardis:files",
|
|
5626
|
+
"export:org:files:hardis",
|
|
5627
|
+
"hardis:export:files:org",
|
|
5628
|
+
"export:hardis:files:org",
|
|
5629
|
+
"export:files:hardis:org",
|
|
5630
|
+
"export:files:org:hardis"
|
|
5623
5631
|
]
|
|
5624
5632
|
},
|
|
5625
|
-
"hardis:org:
|
|
5633
|
+
"hardis:org:files:import": {
|
|
5626
5634
|
"aliases": [],
|
|
5627
5635
|
"args": {},
|
|
5628
|
-
"description": "\
|
|
5636
|
+
"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",
|
|
5629
5637
|
"examples": [
|
|
5630
|
-
"$ sf hardis:org:
|
|
5638
|
+
"$ sf hardis:org:files:import"
|
|
5631
5639
|
],
|
|
5632
5640
|
"flags": {
|
|
5633
5641
|
"json": {
|
|
@@ -5645,6 +5653,21 @@
|
|
|
5645
5653
|
"multiple": false,
|
|
5646
5654
|
"type": "option"
|
|
5647
5655
|
},
|
|
5656
|
+
"path": {
|
|
5657
|
+
"char": "p",
|
|
5658
|
+
"description": "Path to the file export project",
|
|
5659
|
+
"name": "path",
|
|
5660
|
+
"hasDynamicHelp": false,
|
|
5661
|
+
"multiple": false,
|
|
5662
|
+
"type": "option"
|
|
5663
|
+
},
|
|
5664
|
+
"overwrite": {
|
|
5665
|
+
"char": "f",
|
|
5666
|
+
"description": "Override existing files (doubles the number of API calls)",
|
|
5667
|
+
"name": "overwrite",
|
|
5668
|
+
"allowNo": false,
|
|
5669
|
+
"type": "boolean"
|
|
5670
|
+
},
|
|
5648
5671
|
"debug": {
|
|
5649
5672
|
"char": "d",
|
|
5650
5673
|
"description": "Activate debug mode (more logs)",
|
|
@@ -5683,13 +5706,13 @@
|
|
|
5683
5706
|
},
|
|
5684
5707
|
"hasDynamicHelp": true,
|
|
5685
5708
|
"hiddenAliases": [],
|
|
5686
|
-
"id": "hardis:org:
|
|
5709
|
+
"id": "hardis:org:files:import",
|
|
5687
5710
|
"pluginAlias": "sfdx-hardis",
|
|
5688
5711
|
"pluginName": "sfdx-hardis",
|
|
5689
5712
|
"pluginType": "core",
|
|
5690
5713
|
"strict": true,
|
|
5691
5714
|
"enableJsonFlag": true,
|
|
5692
|
-
"title": "
|
|
5715
|
+
"title": "Import files",
|
|
5693
5716
|
"requiresProject": false,
|
|
5694
5717
|
"isESM": true,
|
|
5695
5718
|
"relativePath": [
|
|
@@ -5697,9 +5720,248 @@
|
|
|
5697
5720
|
"commands",
|
|
5698
5721
|
"hardis",
|
|
5699
5722
|
"org",
|
|
5700
|
-
"
|
|
5701
|
-
"
|
|
5702
|
-
],
|
|
5723
|
+
"files",
|
|
5724
|
+
"import.js"
|
|
5725
|
+
],
|
|
5726
|
+
"aliasPermutations": [],
|
|
5727
|
+
"permutations": [
|
|
5728
|
+
"hardis:org:files:import",
|
|
5729
|
+
"org:hardis:files:import",
|
|
5730
|
+
"org:files:hardis:import",
|
|
5731
|
+
"org:files:import:hardis",
|
|
5732
|
+
"hardis:files:org:import",
|
|
5733
|
+
"files:hardis:org:import",
|
|
5734
|
+
"files:org:hardis:import",
|
|
5735
|
+
"files:org:import:hardis",
|
|
5736
|
+
"hardis:files:import:org",
|
|
5737
|
+
"files:hardis:import:org",
|
|
5738
|
+
"files:import:hardis:org",
|
|
5739
|
+
"files:import:org:hardis",
|
|
5740
|
+
"hardis:org:import:files",
|
|
5741
|
+
"org:hardis:import:files",
|
|
5742
|
+
"org:import:hardis:files",
|
|
5743
|
+
"org:import:files:hardis",
|
|
5744
|
+
"hardis:import:org:files",
|
|
5745
|
+
"import:hardis:org:files",
|
|
5746
|
+
"import:org:hardis:files",
|
|
5747
|
+
"import:org:files:hardis",
|
|
5748
|
+
"hardis:import:files:org",
|
|
5749
|
+
"import:hardis:files:org",
|
|
5750
|
+
"import:files:hardis:org",
|
|
5751
|
+
"import:files:org:hardis"
|
|
5752
|
+
]
|
|
5753
|
+
},
|
|
5754
|
+
"hardis:org:diagnose:audittrail": {
|
|
5755
|
+
"aliases": [],
|
|
5756
|
+
"args": {},
|
|
5757
|
+
"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",
|
|
5758
|
+
"examples": [
|
|
5759
|
+
"$ sf hardis:org:diagnose:audittrail",
|
|
5760
|
+
"$ sf hardis:org:diagnose:audittrail --excludeusers baptiste@titi.com",
|
|
5761
|
+
"$ sf hardis:org:diagnose:audittrail --excludeusers baptiste@titi.com,bertrand@titi.com",
|
|
5762
|
+
"$ sf hardis:org:diagnose:audittrail --lastndays 5"
|
|
5763
|
+
],
|
|
5764
|
+
"flags": {
|
|
5765
|
+
"json": {
|
|
5766
|
+
"description": "Format output as json.",
|
|
5767
|
+
"helpGroup": "GLOBAL",
|
|
5768
|
+
"name": "json",
|
|
5769
|
+
"allowNo": false,
|
|
5770
|
+
"type": "boolean"
|
|
5771
|
+
},
|
|
5772
|
+
"flags-dir": {
|
|
5773
|
+
"helpGroup": "GLOBAL",
|
|
5774
|
+
"name": "flags-dir",
|
|
5775
|
+
"summary": "Import flag values from a directory.",
|
|
5776
|
+
"hasDynamicHelp": false,
|
|
5777
|
+
"multiple": false,
|
|
5778
|
+
"type": "option"
|
|
5779
|
+
},
|
|
5780
|
+
"excludeusers": {
|
|
5781
|
+
"char": "e",
|
|
5782
|
+
"description": "Comma-separated list of usernames to exclude",
|
|
5783
|
+
"name": "excludeusers",
|
|
5784
|
+
"hasDynamicHelp": false,
|
|
5785
|
+
"multiple": false,
|
|
5786
|
+
"type": "option"
|
|
5787
|
+
},
|
|
5788
|
+
"lastndays": {
|
|
5789
|
+
"char": "t",
|
|
5790
|
+
"description": "Number of days to extract from today (included)",
|
|
5791
|
+
"name": "lastndays",
|
|
5792
|
+
"hasDynamicHelp": false,
|
|
5793
|
+
"multiple": false,
|
|
5794
|
+
"type": "option"
|
|
5795
|
+
},
|
|
5796
|
+
"outputfile": {
|
|
5797
|
+
"char": "f",
|
|
5798
|
+
"description": "Force the path and name of output report file. Must end with .csv",
|
|
5799
|
+
"name": "outputfile",
|
|
5800
|
+
"hasDynamicHelp": false,
|
|
5801
|
+
"multiple": false,
|
|
5802
|
+
"type": "option"
|
|
5803
|
+
},
|
|
5804
|
+
"debug": {
|
|
5805
|
+
"char": "d",
|
|
5806
|
+
"description": "Activate debug mode (more logs)",
|
|
5807
|
+
"name": "debug",
|
|
5808
|
+
"allowNo": false,
|
|
5809
|
+
"type": "boolean"
|
|
5810
|
+
},
|
|
5811
|
+
"websocket": {
|
|
5812
|
+
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
5813
|
+
"name": "websocket",
|
|
5814
|
+
"hasDynamicHelp": false,
|
|
5815
|
+
"multiple": false,
|
|
5816
|
+
"type": "option"
|
|
5817
|
+
},
|
|
5818
|
+
"skipauth": {
|
|
5819
|
+
"description": "Skip authentication check when a default username is required",
|
|
5820
|
+
"name": "skipauth",
|
|
5821
|
+
"allowNo": false,
|
|
5822
|
+
"type": "boolean"
|
|
5823
|
+
},
|
|
5824
|
+
"target-org": {
|
|
5825
|
+
"aliases": [
|
|
5826
|
+
"targetusername",
|
|
5827
|
+
"u"
|
|
5828
|
+
],
|
|
5829
|
+
"char": "o",
|
|
5830
|
+
"deprecateAliases": true,
|
|
5831
|
+
"name": "target-org",
|
|
5832
|
+
"noCacheDefault": true,
|
|
5833
|
+
"required": true,
|
|
5834
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
5835
|
+
"hasDynamicHelp": true,
|
|
5836
|
+
"multiple": false,
|
|
5837
|
+
"type": "option"
|
|
5838
|
+
}
|
|
5839
|
+
},
|
|
5840
|
+
"hasDynamicHelp": true,
|
|
5841
|
+
"hiddenAliases": [],
|
|
5842
|
+
"id": "hardis:org:diagnose:audittrail",
|
|
5843
|
+
"pluginAlias": "sfdx-hardis",
|
|
5844
|
+
"pluginName": "sfdx-hardis",
|
|
5845
|
+
"pluginType": "core",
|
|
5846
|
+
"strict": true,
|
|
5847
|
+
"enableJsonFlag": true,
|
|
5848
|
+
"title": "Diagnose content of Setup Audit Trail",
|
|
5849
|
+
"requiresProject": false,
|
|
5850
|
+
"isESM": true,
|
|
5851
|
+
"relativePath": [
|
|
5852
|
+
"lib",
|
|
5853
|
+
"commands",
|
|
5854
|
+
"hardis",
|
|
5855
|
+
"org",
|
|
5856
|
+
"diagnose",
|
|
5857
|
+
"audittrail.js"
|
|
5858
|
+
],
|
|
5859
|
+
"aliasPermutations": [],
|
|
5860
|
+
"permutations": [
|
|
5861
|
+
"hardis:org:diagnose:audittrail",
|
|
5862
|
+
"org:hardis:diagnose:audittrail",
|
|
5863
|
+
"org:diagnose:hardis:audittrail",
|
|
5864
|
+
"org:diagnose:audittrail:hardis",
|
|
5865
|
+
"hardis:diagnose:org:audittrail",
|
|
5866
|
+
"diagnose:hardis:org:audittrail",
|
|
5867
|
+
"diagnose:org:hardis:audittrail",
|
|
5868
|
+
"diagnose:org:audittrail:hardis",
|
|
5869
|
+
"hardis:diagnose:audittrail:org",
|
|
5870
|
+
"diagnose:hardis:audittrail:org",
|
|
5871
|
+
"diagnose:audittrail:hardis:org",
|
|
5872
|
+
"diagnose:audittrail:org:hardis",
|
|
5873
|
+
"hardis:org:audittrail:diagnose",
|
|
5874
|
+
"org:hardis:audittrail:diagnose",
|
|
5875
|
+
"org:audittrail:hardis:diagnose",
|
|
5876
|
+
"org:audittrail:diagnose:hardis",
|
|
5877
|
+
"hardis:audittrail:org:diagnose",
|
|
5878
|
+
"audittrail:hardis:org:diagnose",
|
|
5879
|
+
"audittrail:org:hardis:diagnose",
|
|
5880
|
+
"audittrail:org:diagnose:hardis",
|
|
5881
|
+
"hardis:audittrail:diagnose:org",
|
|
5882
|
+
"audittrail:hardis:diagnose:org",
|
|
5883
|
+
"audittrail:diagnose:hardis:org",
|
|
5884
|
+
"audittrail:diagnose:org:hardis"
|
|
5885
|
+
]
|
|
5886
|
+
},
|
|
5887
|
+
"hardis:org:diagnose:instanceupgrade": {
|
|
5888
|
+
"aliases": [],
|
|
5889
|
+
"args": {},
|
|
5890
|
+
"description": "\n## Command Behavior\n\n**Retrieves and displays the scheduled upgrade date for a Salesforce org's instance.**\n\nThis command provides crucial information about when your Salesforce instance will be upgraded to the next major release (Spring, Summer, or Winter). This is vital for release planning, testing, and ensuring compatibility with upcoming Salesforce features.\n\nKey functionalities:\n\n- **Instance Identification:** Determines the Salesforce instance name of your target org.\n- **Upgrade Date Retrieval:** Fetches the planned start time of the next major core service upgrade for that instance from the Salesforce Status API.\n- **Days Until Upgrade:** Calculates and displays the number of days remaining until the next major upgrade.\n- **Severity-Based Logging:** Adjusts the log severity (info, warning) based on the proximity of the upgrade date, providing a visual cue for urgency.\n- **Notifications:** Sends notifications to configured channels (e.g., Slack, MS Teams, Grafana) with the upgrade information, making it suitable for automated monitoring.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **Salesforce SOQL Query:** It first queries the `Organization` object in Salesforce to get the `InstanceName` of the target org.\n- **Salesforce Status API Integration:** It makes an HTTP GET request to the Salesforce Status API (`https://api.status.salesforce.com/v1/instances/{instanceName}/status`) to retrieve detailed information about the instance, including scheduled maintenances.\n- **Data Parsing:** It parses the JSON response from the Status API to extract the relevant major release upgrade information.\n- **Date Calculation:** Uses the `moment` library to calculate the difference in days between the current date and the planned upgrade date.\n- **Notification Integration:** It integrates with the `NotifProvider` to send notifications, including the instance name, upgrade date, and days remaining, along with relevant metrics for monitoring dashboards.\n- **User Feedback:** Provides clear messages to the user about the upgrade status and proximity.\n</details>\n",
|
|
5891
|
+
"examples": [
|
|
5892
|
+
"$ sf hardis:org:diagnose:instanceupgrade"
|
|
5893
|
+
],
|
|
5894
|
+
"flags": {
|
|
5895
|
+
"json": {
|
|
5896
|
+
"description": "Format output as json.",
|
|
5897
|
+
"helpGroup": "GLOBAL",
|
|
5898
|
+
"name": "json",
|
|
5899
|
+
"allowNo": false,
|
|
5900
|
+
"type": "boolean"
|
|
5901
|
+
},
|
|
5902
|
+
"flags-dir": {
|
|
5903
|
+
"helpGroup": "GLOBAL",
|
|
5904
|
+
"name": "flags-dir",
|
|
5905
|
+
"summary": "Import flag values from a directory.",
|
|
5906
|
+
"hasDynamicHelp": false,
|
|
5907
|
+
"multiple": false,
|
|
5908
|
+
"type": "option"
|
|
5909
|
+
},
|
|
5910
|
+
"debug": {
|
|
5911
|
+
"char": "d",
|
|
5912
|
+
"description": "Activate debug mode (more logs)",
|
|
5913
|
+
"name": "debug",
|
|
5914
|
+
"allowNo": false,
|
|
5915
|
+
"type": "boolean"
|
|
5916
|
+
},
|
|
5917
|
+
"websocket": {
|
|
5918
|
+
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
5919
|
+
"name": "websocket",
|
|
5920
|
+
"hasDynamicHelp": false,
|
|
5921
|
+
"multiple": false,
|
|
5922
|
+
"type": "option"
|
|
5923
|
+
},
|
|
5924
|
+
"skipauth": {
|
|
5925
|
+
"description": "Skip authentication check when a default username is required",
|
|
5926
|
+
"name": "skipauth",
|
|
5927
|
+
"allowNo": false,
|
|
5928
|
+
"type": "boolean"
|
|
5929
|
+
},
|
|
5930
|
+
"target-org": {
|
|
5931
|
+
"aliases": [
|
|
5932
|
+
"targetusername",
|
|
5933
|
+
"u"
|
|
5934
|
+
],
|
|
5935
|
+
"char": "o",
|
|
5936
|
+
"deprecateAliases": true,
|
|
5937
|
+
"name": "target-org",
|
|
5938
|
+
"noCacheDefault": true,
|
|
5939
|
+
"required": true,
|
|
5940
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
5941
|
+
"hasDynamicHelp": true,
|
|
5942
|
+
"multiple": false,
|
|
5943
|
+
"type": "option"
|
|
5944
|
+
}
|
|
5945
|
+
},
|
|
5946
|
+
"hasDynamicHelp": true,
|
|
5947
|
+
"hiddenAliases": [],
|
|
5948
|
+
"id": "hardis:org:diagnose:instanceupgrade",
|
|
5949
|
+
"pluginAlias": "sfdx-hardis",
|
|
5950
|
+
"pluginName": "sfdx-hardis",
|
|
5951
|
+
"pluginType": "core",
|
|
5952
|
+
"strict": true,
|
|
5953
|
+
"enableJsonFlag": true,
|
|
5954
|
+
"title": "Get Instance Upgrade date",
|
|
5955
|
+
"requiresProject": false,
|
|
5956
|
+
"isESM": true,
|
|
5957
|
+
"relativePath": [
|
|
5958
|
+
"lib",
|
|
5959
|
+
"commands",
|
|
5960
|
+
"hardis",
|
|
5961
|
+
"org",
|
|
5962
|
+
"diagnose",
|
|
5963
|
+
"instanceupgrade.js"
|
|
5964
|
+
],
|
|
5703
5965
|
"aliasPermutations": [],
|
|
5704
5966
|
"permutations": [
|
|
5705
5967
|
"hardis:org:diagnose:instanceupgrade",
|
|
@@ -6638,12 +6900,14 @@
|
|
|
6638
6900
|
"unusedusers:diagnose:org:hardis"
|
|
6639
6901
|
]
|
|
6640
6902
|
},
|
|
6641
|
-
"hardis:org:
|
|
6903
|
+
"hardis:org:generate:packagexmlfull": {
|
|
6642
6904
|
"aliases": [],
|
|
6643
6905
|
"args": {},
|
|
6644
|
-
"description": "\n## Command Behavior\n\n**
|
|
6906
|
+
"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",
|
|
6645
6907
|
"examples": [
|
|
6646
|
-
"$ sf hardis:org:
|
|
6908
|
+
"$ sf hardis:org:generate:packagexmlfull",
|
|
6909
|
+
"$ sf hardis:org:generate:packagexmlfull --outputfile /tmp/packagexmlfull.xml",
|
|
6910
|
+
"$ sf hardis:org:generate:packagexmlfull --target-org nico@example.com"
|
|
6647
6911
|
],
|
|
6648
6912
|
"flags": {
|
|
6649
6913
|
"json": {
|
|
@@ -6661,37 +6925,9 @@
|
|
|
6661
6925
|
"multiple": false,
|
|
6662
6926
|
"type": "option"
|
|
6663
6927
|
},
|
|
6664
|
-
"
|
|
6665
|
-
"
|
|
6666
|
-
"
|
|
6667
|
-
"name": "path",
|
|
6668
|
-
"hasDynamicHelp": false,
|
|
6669
|
-
"multiple": false,
|
|
6670
|
-
"type": "option"
|
|
6671
|
-
},
|
|
6672
|
-
"chunksize": {
|
|
6673
|
-
"char": "c",
|
|
6674
|
-
"description": "Number of records to add in a chunk before it is processed",
|
|
6675
|
-
"name": "chunksize",
|
|
6676
|
-
"default": 1000,
|
|
6677
|
-
"hasDynamicHelp": false,
|
|
6678
|
-
"multiple": false,
|
|
6679
|
-
"type": "option"
|
|
6680
|
-
},
|
|
6681
|
-
"polltimeout": {
|
|
6682
|
-
"char": "t",
|
|
6683
|
-
"description": "Timeout in MS for Bulk API calls",
|
|
6684
|
-
"name": "polltimeout",
|
|
6685
|
-
"default": 300000,
|
|
6686
|
-
"hasDynamicHelp": false,
|
|
6687
|
-
"multiple": false,
|
|
6688
|
-
"type": "option"
|
|
6689
|
-
},
|
|
6690
|
-
"startchunknumber": {
|
|
6691
|
-
"char": "s",
|
|
6692
|
-
"description": "Chunk number to start from",
|
|
6693
|
-
"name": "startchunknumber",
|
|
6694
|
-
"default": 0,
|
|
6928
|
+
"outputfile": {
|
|
6929
|
+
"description": "Output package.xml file",
|
|
6930
|
+
"name": "outputfile",
|
|
6695
6931
|
"hasDynamicHelp": false,
|
|
6696
6932
|
"multiple": false,
|
|
6697
6933
|
"type": "option"
|
|
@@ -6703,124 +6939,10 @@
|
|
|
6703
6939
|
"allowNo": false,
|
|
6704
6940
|
"type": "boolean"
|
|
6705
6941
|
},
|
|
6706
|
-
"
|
|
6707
|
-
"
|
|
6708
|
-
"
|
|
6709
|
-
"
|
|
6710
|
-
"multiple": false,
|
|
6711
|
-
"type": "option"
|
|
6712
|
-
},
|
|
6713
|
-
"skipauth": {
|
|
6714
|
-
"description": "Skip authentication check when a default username is required",
|
|
6715
|
-
"name": "skipauth",
|
|
6716
|
-
"allowNo": false,
|
|
6717
|
-
"type": "boolean"
|
|
6718
|
-
},
|
|
6719
|
-
"target-org": {
|
|
6720
|
-
"aliases": [
|
|
6721
|
-
"targetusername",
|
|
6722
|
-
"u"
|
|
6723
|
-
],
|
|
6724
|
-
"char": "o",
|
|
6725
|
-
"deprecateAliases": true,
|
|
6726
|
-
"name": "target-org",
|
|
6727
|
-
"noCacheDefault": true,
|
|
6728
|
-
"required": true,
|
|
6729
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
6730
|
-
"hasDynamicHelp": true,
|
|
6731
|
-
"multiple": false,
|
|
6732
|
-
"type": "option"
|
|
6733
|
-
}
|
|
6734
|
-
},
|
|
6735
|
-
"hasDynamicHelp": true,
|
|
6736
|
-
"hiddenAliases": [],
|
|
6737
|
-
"id": "hardis:org:files:export",
|
|
6738
|
-
"pluginAlias": "sfdx-hardis",
|
|
6739
|
-
"pluginName": "sfdx-hardis",
|
|
6740
|
-
"pluginType": "core",
|
|
6741
|
-
"strict": true,
|
|
6742
|
-
"enableJsonFlag": true,
|
|
6743
|
-
"title": "Export files",
|
|
6744
|
-
"requiresProject": false,
|
|
6745
|
-
"isESM": true,
|
|
6746
|
-
"relativePath": [
|
|
6747
|
-
"lib",
|
|
6748
|
-
"commands",
|
|
6749
|
-
"hardis",
|
|
6750
|
-
"org",
|
|
6751
|
-
"files",
|
|
6752
|
-
"export.js"
|
|
6753
|
-
],
|
|
6754
|
-
"aliasPermutations": [],
|
|
6755
|
-
"permutations": [
|
|
6756
|
-
"hardis:org:files:export",
|
|
6757
|
-
"org:hardis:files:export",
|
|
6758
|
-
"org:files:hardis:export",
|
|
6759
|
-
"org:files:export:hardis",
|
|
6760
|
-
"hardis:files:org:export",
|
|
6761
|
-
"files:hardis:org:export",
|
|
6762
|
-
"files:org:hardis:export",
|
|
6763
|
-
"files:org:export:hardis",
|
|
6764
|
-
"hardis:files:export:org",
|
|
6765
|
-
"files:hardis:export:org",
|
|
6766
|
-
"files:export:hardis:org",
|
|
6767
|
-
"files:export:org:hardis",
|
|
6768
|
-
"hardis:org:export:files",
|
|
6769
|
-
"org:hardis:export:files",
|
|
6770
|
-
"org:export:hardis:files",
|
|
6771
|
-
"org:export:files:hardis",
|
|
6772
|
-
"hardis:export:org:files",
|
|
6773
|
-
"export:hardis:org:files",
|
|
6774
|
-
"export:org:hardis:files",
|
|
6775
|
-
"export:org:files:hardis",
|
|
6776
|
-
"hardis:export:files:org",
|
|
6777
|
-
"export:hardis:files:org",
|
|
6778
|
-
"export:files:hardis:org",
|
|
6779
|
-
"export:files:org:hardis"
|
|
6780
|
-
]
|
|
6781
|
-
},
|
|
6782
|
-
"hardis:org:files:import": {
|
|
6783
|
-
"aliases": [],
|
|
6784
|
-
"args": {},
|
|
6785
|
-
"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",
|
|
6786
|
-
"examples": [
|
|
6787
|
-
"$ sf hardis:org:files:import"
|
|
6788
|
-
],
|
|
6789
|
-
"flags": {
|
|
6790
|
-
"json": {
|
|
6791
|
-
"description": "Format output as json.",
|
|
6792
|
-
"helpGroup": "GLOBAL",
|
|
6793
|
-
"name": "json",
|
|
6794
|
-
"allowNo": false,
|
|
6795
|
-
"type": "boolean"
|
|
6796
|
-
},
|
|
6797
|
-
"flags-dir": {
|
|
6798
|
-
"helpGroup": "GLOBAL",
|
|
6799
|
-
"name": "flags-dir",
|
|
6800
|
-
"summary": "Import flag values from a directory.",
|
|
6801
|
-
"hasDynamicHelp": false,
|
|
6802
|
-
"multiple": false,
|
|
6803
|
-
"type": "option"
|
|
6804
|
-
},
|
|
6805
|
-
"path": {
|
|
6806
|
-
"char": "p",
|
|
6807
|
-
"description": "Path to the file export project",
|
|
6808
|
-
"name": "path",
|
|
6809
|
-
"hasDynamicHelp": false,
|
|
6810
|
-
"multiple": false,
|
|
6811
|
-
"type": "option"
|
|
6812
|
-
},
|
|
6813
|
-
"overwrite": {
|
|
6814
|
-
"char": "f",
|
|
6815
|
-
"description": "Override existing files (doubles the number of API calls)",
|
|
6816
|
-
"name": "overwrite",
|
|
6817
|
-
"allowNo": false,
|
|
6818
|
-
"type": "boolean"
|
|
6819
|
-
},
|
|
6820
|
-
"debug": {
|
|
6821
|
-
"char": "d",
|
|
6822
|
-
"description": "Activate debug mode (more logs)",
|
|
6823
|
-
"name": "debug",
|
|
6942
|
+
"no-prompt": {
|
|
6943
|
+
"char": "n",
|
|
6944
|
+
"description": "Do not prompt for org username, use the default one",
|
|
6945
|
+
"name": "no-prompt",
|
|
6824
6946
|
"allowNo": false,
|
|
6825
6947
|
"type": "boolean"
|
|
6826
6948
|
},
|
|
@@ -6855,13 +6977,13 @@
|
|
|
6855
6977
|
},
|
|
6856
6978
|
"hasDynamicHelp": true,
|
|
6857
6979
|
"hiddenAliases": [],
|
|
6858
|
-
"id": "hardis:org:
|
|
6980
|
+
"id": "hardis:org:generate:packagexmlfull",
|
|
6859
6981
|
"pluginAlias": "sfdx-hardis",
|
|
6860
6982
|
"pluginName": "sfdx-hardis",
|
|
6861
6983
|
"pluginType": "core",
|
|
6862
6984
|
"strict": true,
|
|
6863
6985
|
"enableJsonFlag": true,
|
|
6864
|
-
"title": "
|
|
6986
|
+
"title": "Generate Full Org package.xml",
|
|
6865
6987
|
"requiresProject": false,
|
|
6866
6988
|
"isESM": true,
|
|
6867
6989
|
"relativePath": [
|
|
@@ -6869,35 +6991,35 @@
|
|
|
6869
6991
|
"commands",
|
|
6870
6992
|
"hardis",
|
|
6871
6993
|
"org",
|
|
6872
|
-
"
|
|
6873
|
-
"
|
|
6994
|
+
"generate",
|
|
6995
|
+
"packagexmlfull.js"
|
|
6874
6996
|
],
|
|
6875
6997
|
"aliasPermutations": [],
|
|
6876
6998
|
"permutations": [
|
|
6877
|
-
"hardis:org:
|
|
6878
|
-
"org:hardis:
|
|
6879
|
-
"org:
|
|
6880
|
-
"org:
|
|
6881
|
-
"hardis:
|
|
6882
|
-
"
|
|
6883
|
-
"
|
|
6884
|
-
"
|
|
6885
|
-
"hardis:
|
|
6886
|
-
"
|
|
6887
|
-
"
|
|
6888
|
-
"
|
|
6889
|
-
"hardis:org:
|
|
6890
|
-
"org:hardis:
|
|
6891
|
-
"org:
|
|
6892
|
-
"org:
|
|
6893
|
-
"hardis:
|
|
6894
|
-
"
|
|
6895
|
-
"
|
|
6896
|
-
"
|
|
6897
|
-
"hardis:
|
|
6898
|
-
"
|
|
6899
|
-
"
|
|
6900
|
-
"
|
|
6999
|
+
"hardis:org:generate:packagexmlfull",
|
|
7000
|
+
"org:hardis:generate:packagexmlfull",
|
|
7001
|
+
"org:generate:hardis:packagexmlfull",
|
|
7002
|
+
"org:generate:packagexmlfull:hardis",
|
|
7003
|
+
"hardis:generate:org:packagexmlfull",
|
|
7004
|
+
"generate:hardis:org:packagexmlfull",
|
|
7005
|
+
"generate:org:hardis:packagexmlfull",
|
|
7006
|
+
"generate:org:packagexmlfull:hardis",
|
|
7007
|
+
"hardis:generate:packagexmlfull:org",
|
|
7008
|
+
"generate:hardis:packagexmlfull:org",
|
|
7009
|
+
"generate:packagexmlfull:hardis:org",
|
|
7010
|
+
"generate:packagexmlfull:org:hardis",
|
|
7011
|
+
"hardis:org:packagexmlfull:generate",
|
|
7012
|
+
"org:hardis:packagexmlfull:generate",
|
|
7013
|
+
"org:packagexmlfull:hardis:generate",
|
|
7014
|
+
"org:packagexmlfull:generate:hardis",
|
|
7015
|
+
"hardis:packagexmlfull:org:generate",
|
|
7016
|
+
"packagexmlfull:hardis:org:generate",
|
|
7017
|
+
"packagexmlfull:org:hardis:generate",
|
|
7018
|
+
"packagexmlfull:org:generate:hardis",
|
|
7019
|
+
"hardis:packagexmlfull:generate:org",
|
|
7020
|
+
"packagexmlfull:hardis:generate:org",
|
|
7021
|
+
"packagexmlfull:generate:hardis:org",
|
|
7022
|
+
"packagexmlfull:generate:org:hardis"
|
|
6901
7023
|
]
|
|
6902
7024
|
},
|
|
6903
7025
|
"hardis:org:fix:listviewmine": {
|
|
@@ -7007,134 +7129,12 @@
|
|
|
7007
7129
|
"org:listviewmine:fix:hardis",
|
|
7008
7130
|
"hardis:listviewmine:org:fix",
|
|
7009
7131
|
"listviewmine:hardis:org:fix",
|
|
7010
|
-
"listviewmine:org:hardis:fix",
|
|
7011
|
-
"listviewmine:org:fix:hardis",
|
|
7012
|
-
"hardis:listviewmine:fix:org",
|
|
7013
|
-
"listviewmine:hardis:fix:org",
|
|
7014
|
-
"listviewmine:fix:hardis:org",
|
|
7015
|
-
"listviewmine:fix:org:hardis"
|
|
7016
|
-
]
|
|
7017
|
-
},
|
|
7018
|
-
"hardis:org:generate:packagexmlfull": {
|
|
7019
|
-
"aliases": [],
|
|
7020
|
-
"args": {},
|
|
7021
|
-
"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",
|
|
7022
|
-
"examples": [
|
|
7023
|
-
"$ sf hardis:org:generate:packagexmlfull",
|
|
7024
|
-
"$ sf hardis:org:generate:packagexmlfull --outputfile /tmp/packagexmlfull.xml",
|
|
7025
|
-
"$ sf hardis:org:generate:packagexmlfull --target-org nico@example.com"
|
|
7026
|
-
],
|
|
7027
|
-
"flags": {
|
|
7028
|
-
"json": {
|
|
7029
|
-
"description": "Format output as json.",
|
|
7030
|
-
"helpGroup": "GLOBAL",
|
|
7031
|
-
"name": "json",
|
|
7032
|
-
"allowNo": false,
|
|
7033
|
-
"type": "boolean"
|
|
7034
|
-
},
|
|
7035
|
-
"flags-dir": {
|
|
7036
|
-
"helpGroup": "GLOBAL",
|
|
7037
|
-
"name": "flags-dir",
|
|
7038
|
-
"summary": "Import flag values from a directory.",
|
|
7039
|
-
"hasDynamicHelp": false,
|
|
7040
|
-
"multiple": false,
|
|
7041
|
-
"type": "option"
|
|
7042
|
-
},
|
|
7043
|
-
"outputfile": {
|
|
7044
|
-
"description": "Output package.xml file",
|
|
7045
|
-
"name": "outputfile",
|
|
7046
|
-
"hasDynamicHelp": false,
|
|
7047
|
-
"multiple": false,
|
|
7048
|
-
"type": "option"
|
|
7049
|
-
},
|
|
7050
|
-
"debug": {
|
|
7051
|
-
"char": "d",
|
|
7052
|
-
"description": "Activate debug mode (more logs)",
|
|
7053
|
-
"name": "debug",
|
|
7054
|
-
"allowNo": false,
|
|
7055
|
-
"type": "boolean"
|
|
7056
|
-
},
|
|
7057
|
-
"no-prompt": {
|
|
7058
|
-
"char": "n",
|
|
7059
|
-
"description": "Do not prompt for org username, use the default one",
|
|
7060
|
-
"name": "no-prompt",
|
|
7061
|
-
"allowNo": false,
|
|
7062
|
-
"type": "boolean"
|
|
7063
|
-
},
|
|
7064
|
-
"websocket": {
|
|
7065
|
-
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
7066
|
-
"name": "websocket",
|
|
7067
|
-
"hasDynamicHelp": false,
|
|
7068
|
-
"multiple": false,
|
|
7069
|
-
"type": "option"
|
|
7070
|
-
},
|
|
7071
|
-
"skipauth": {
|
|
7072
|
-
"description": "Skip authentication check when a default username is required",
|
|
7073
|
-
"name": "skipauth",
|
|
7074
|
-
"allowNo": false,
|
|
7075
|
-
"type": "boolean"
|
|
7076
|
-
},
|
|
7077
|
-
"target-org": {
|
|
7078
|
-
"aliases": [
|
|
7079
|
-
"targetusername",
|
|
7080
|
-
"u"
|
|
7081
|
-
],
|
|
7082
|
-
"char": "o",
|
|
7083
|
-
"deprecateAliases": true,
|
|
7084
|
-
"name": "target-org",
|
|
7085
|
-
"noCacheDefault": true,
|
|
7086
|
-
"required": true,
|
|
7087
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
7088
|
-
"hasDynamicHelp": true,
|
|
7089
|
-
"multiple": false,
|
|
7090
|
-
"type": "option"
|
|
7091
|
-
}
|
|
7092
|
-
},
|
|
7093
|
-
"hasDynamicHelp": true,
|
|
7094
|
-
"hiddenAliases": [],
|
|
7095
|
-
"id": "hardis:org:generate:packagexmlfull",
|
|
7096
|
-
"pluginAlias": "sfdx-hardis",
|
|
7097
|
-
"pluginName": "sfdx-hardis",
|
|
7098
|
-
"pluginType": "core",
|
|
7099
|
-
"strict": true,
|
|
7100
|
-
"enableJsonFlag": true,
|
|
7101
|
-
"title": "Generate Full Org package.xml",
|
|
7102
|
-
"requiresProject": false,
|
|
7103
|
-
"isESM": true,
|
|
7104
|
-
"relativePath": [
|
|
7105
|
-
"lib",
|
|
7106
|
-
"commands",
|
|
7107
|
-
"hardis",
|
|
7108
|
-
"org",
|
|
7109
|
-
"generate",
|
|
7110
|
-
"packagexmlfull.js"
|
|
7111
|
-
],
|
|
7112
|
-
"aliasPermutations": [],
|
|
7113
|
-
"permutations": [
|
|
7114
|
-
"hardis:org:generate:packagexmlfull",
|
|
7115
|
-
"org:hardis:generate:packagexmlfull",
|
|
7116
|
-
"org:generate:hardis:packagexmlfull",
|
|
7117
|
-
"org:generate:packagexmlfull:hardis",
|
|
7118
|
-
"hardis:generate:org:packagexmlfull",
|
|
7119
|
-
"generate:hardis:org:packagexmlfull",
|
|
7120
|
-
"generate:org:hardis:packagexmlfull",
|
|
7121
|
-
"generate:org:packagexmlfull:hardis",
|
|
7122
|
-
"hardis:generate:packagexmlfull:org",
|
|
7123
|
-
"generate:hardis:packagexmlfull:org",
|
|
7124
|
-
"generate:packagexmlfull:hardis:org",
|
|
7125
|
-
"generate:packagexmlfull:org:hardis",
|
|
7126
|
-
"hardis:org:packagexmlfull:generate",
|
|
7127
|
-
"org:hardis:packagexmlfull:generate",
|
|
7128
|
-
"org:packagexmlfull:hardis:generate",
|
|
7129
|
-
"org:packagexmlfull:generate:hardis",
|
|
7130
|
-
"hardis:packagexmlfull:org:generate",
|
|
7131
|
-
"packagexmlfull:hardis:org:generate",
|
|
7132
|
-
"packagexmlfull:org:hardis:generate",
|
|
7133
|
-
"packagexmlfull:org:generate:hardis",
|
|
7134
|
-
"hardis:packagexmlfull:generate:org",
|
|
7135
|
-
"packagexmlfull:hardis:generate:org",
|
|
7136
|
-
"packagexmlfull:generate:hardis:org",
|
|
7137
|
-
"packagexmlfull:generate:org:hardis"
|
|
7132
|
+
"listviewmine:org:hardis:fix",
|
|
7133
|
+
"listviewmine:org:fix:hardis",
|
|
7134
|
+
"hardis:listviewmine:fix:org",
|
|
7135
|
+
"listviewmine:hardis:fix:org",
|
|
7136
|
+
"listviewmine:fix:hardis:org",
|
|
7137
|
+
"listviewmine:fix:org:hardis"
|
|
7138
7138
|
]
|
|
7139
7139
|
},
|
|
7140
7140
|
"hardis:org:monitor:all": {
|
|
@@ -7880,6 +7880,113 @@
|
|
|
7880
7880
|
"flow:purge:org:hardis"
|
|
7881
7881
|
]
|
|
7882
7882
|
},
|
|
7883
|
+
"hardis:org:retrieve:packageconfig": {
|
|
7884
|
+
"aliases": [],
|
|
7885
|
+
"args": {},
|
|
7886
|
+
"description": "\n**Retrieves the installed package configuration from a Salesforce org and optionally updates the local project configuration.**\n\nThis command is useful for maintaining an accurate record of installed packages within your Salesforce project, which is crucial for managing dependencies and ensuring consistent deployments across environments.\n\nKey functionalities:\n\n- **Package Listing:** Connects to a specified Salesforce org (or prompts for one if not provided) and retrieves a list of all installed packages.\n- **Configuration Update:** Offers the option to update your local project's configuration with the retrieved list of installed packages. This can be beneficial for automating package installations during environment setup or CI/CD processes.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **Org Connection:** It establishes a connection to the target Salesforce org using the provided or prompted username.\n- **Metadata Retrieval:** It utilizes `MetadataUtils.listInstalledPackages` to query the Salesforce org and obtain details about the installed packages.\n- **Interactive Prompt:** It uses the `prompts` library to ask the user whether they want to update their local project configuration with the retrieved package list.\n- **Configuration Management:** If the user confirms, it calls `managePackageConfig` to update the project's configuration file (likely `.sfdx-hardis.yml`) with the new package information.\n- **User Feedback:** Provides clear messages to the user about the success of the package retrieval and configuration update.\n</details>\n",
|
|
7887
|
+
"examples": [
|
|
7888
|
+
"$ sf hardis:org:retrieve:packageconfig",
|
|
7889
|
+
"sf hardis:org:retrieve:packageconfig -u myOrg"
|
|
7890
|
+
],
|
|
7891
|
+
"flags": {
|
|
7892
|
+
"json": {
|
|
7893
|
+
"description": "Format output as json.",
|
|
7894
|
+
"helpGroup": "GLOBAL",
|
|
7895
|
+
"name": "json",
|
|
7896
|
+
"allowNo": false,
|
|
7897
|
+
"type": "boolean"
|
|
7898
|
+
},
|
|
7899
|
+
"flags-dir": {
|
|
7900
|
+
"helpGroup": "GLOBAL",
|
|
7901
|
+
"name": "flags-dir",
|
|
7902
|
+
"summary": "Import flag values from a directory.",
|
|
7903
|
+
"hasDynamicHelp": false,
|
|
7904
|
+
"multiple": false,
|
|
7905
|
+
"type": "option"
|
|
7906
|
+
},
|
|
7907
|
+
"debug": {
|
|
7908
|
+
"char": "d",
|
|
7909
|
+
"description": "Activate debug mode (more logs)",
|
|
7910
|
+
"name": "debug",
|
|
7911
|
+
"allowNo": false,
|
|
7912
|
+
"type": "boolean"
|
|
7913
|
+
},
|
|
7914
|
+
"websocket": {
|
|
7915
|
+
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
7916
|
+
"name": "websocket",
|
|
7917
|
+
"hasDynamicHelp": false,
|
|
7918
|
+
"multiple": false,
|
|
7919
|
+
"type": "option"
|
|
7920
|
+
},
|
|
7921
|
+
"skipauth": {
|
|
7922
|
+
"description": "Skip authentication check when a default username is required",
|
|
7923
|
+
"name": "skipauth",
|
|
7924
|
+
"allowNo": false,
|
|
7925
|
+
"type": "boolean"
|
|
7926
|
+
},
|
|
7927
|
+
"target-org": {
|
|
7928
|
+
"aliases": [
|
|
7929
|
+
"targetusername",
|
|
7930
|
+
"u"
|
|
7931
|
+
],
|
|
7932
|
+
"char": "o",
|
|
7933
|
+
"deprecateAliases": true,
|
|
7934
|
+
"name": "target-org",
|
|
7935
|
+
"noCacheDefault": true,
|
|
7936
|
+
"required": true,
|
|
7937
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
7938
|
+
"hasDynamicHelp": true,
|
|
7939
|
+
"multiple": false,
|
|
7940
|
+
"type": "option"
|
|
7941
|
+
}
|
|
7942
|
+
},
|
|
7943
|
+
"hasDynamicHelp": true,
|
|
7944
|
+
"hiddenAliases": [],
|
|
7945
|
+
"id": "hardis:org:retrieve:packageconfig",
|
|
7946
|
+
"pluginAlias": "sfdx-hardis",
|
|
7947
|
+
"pluginName": "sfdx-hardis",
|
|
7948
|
+
"pluginType": "core",
|
|
7949
|
+
"strict": true,
|
|
7950
|
+
"enableJsonFlag": true,
|
|
7951
|
+
"title": "Retrieve package configuration from an org",
|
|
7952
|
+
"requiresProject": false,
|
|
7953
|
+
"isESM": true,
|
|
7954
|
+
"relativePath": [
|
|
7955
|
+
"lib",
|
|
7956
|
+
"commands",
|
|
7957
|
+
"hardis",
|
|
7958
|
+
"org",
|
|
7959
|
+
"retrieve",
|
|
7960
|
+
"packageconfig.js"
|
|
7961
|
+
],
|
|
7962
|
+
"aliasPermutations": [],
|
|
7963
|
+
"permutations": [
|
|
7964
|
+
"hardis:org:retrieve:packageconfig",
|
|
7965
|
+
"org:hardis:retrieve:packageconfig",
|
|
7966
|
+
"org:retrieve:hardis:packageconfig",
|
|
7967
|
+
"org:retrieve:packageconfig:hardis",
|
|
7968
|
+
"hardis:retrieve:org:packageconfig",
|
|
7969
|
+
"retrieve:hardis:org:packageconfig",
|
|
7970
|
+
"retrieve:org:hardis:packageconfig",
|
|
7971
|
+
"retrieve:org:packageconfig:hardis",
|
|
7972
|
+
"hardis:retrieve:packageconfig:org",
|
|
7973
|
+
"retrieve:hardis:packageconfig:org",
|
|
7974
|
+
"retrieve:packageconfig:hardis:org",
|
|
7975
|
+
"retrieve:packageconfig:org:hardis",
|
|
7976
|
+
"hardis:org:packageconfig:retrieve",
|
|
7977
|
+
"org:hardis:packageconfig:retrieve",
|
|
7978
|
+
"org:packageconfig:hardis:retrieve",
|
|
7979
|
+
"org:packageconfig:retrieve:hardis",
|
|
7980
|
+
"hardis:packageconfig:org:retrieve",
|
|
7981
|
+
"packageconfig:hardis:org:retrieve",
|
|
7982
|
+
"packageconfig:org:hardis:retrieve",
|
|
7983
|
+
"packageconfig:org:retrieve:hardis",
|
|
7984
|
+
"hardis:packageconfig:retrieve:org",
|
|
7985
|
+
"packageconfig:hardis:retrieve:org",
|
|
7986
|
+
"packageconfig:retrieve:hardis:org",
|
|
7987
|
+
"packageconfig:retrieve:org:hardis"
|
|
7988
|
+
]
|
|
7989
|
+
},
|
|
7883
7990
|
"hardis:org:refresh:after-refresh": {
|
|
7884
7991
|
"aliases": [],
|
|
7885
7992
|
"args": {},
|
|
@@ -8081,149 +8188,42 @@
|
|
|
8081
8188
|
"pluginType": "core",
|
|
8082
8189
|
"strict": true,
|
|
8083
8190
|
"enableJsonFlag": true,
|
|
8084
|
-
"requiresProject": true,
|
|
8085
|
-
"isESM": true,
|
|
8086
|
-
"relativePath": [
|
|
8087
|
-
"lib",
|
|
8088
|
-
"commands",
|
|
8089
|
-
"hardis",
|
|
8090
|
-
"org",
|
|
8091
|
-
"refresh",
|
|
8092
|
-
"before-refresh.js"
|
|
8093
|
-
],
|
|
8094
|
-
"aliasPermutations": [],
|
|
8095
|
-
"permutations": [
|
|
8096
|
-
"hardis:org:refresh:before-refresh",
|
|
8097
|
-
"org:hardis:refresh:before-refresh",
|
|
8098
|
-
"org:refresh:hardis:before-refresh",
|
|
8099
|
-
"org:refresh:before-refresh:hardis",
|
|
8100
|
-
"hardis:refresh:org:before-refresh",
|
|
8101
|
-
"refresh:hardis:org:before-refresh",
|
|
8102
|
-
"refresh:org:hardis:before-refresh",
|
|
8103
|
-
"refresh:org:before-refresh:hardis",
|
|
8104
|
-
"hardis:refresh:before-refresh:org",
|
|
8105
|
-
"refresh:hardis:before-refresh:org",
|
|
8106
|
-
"refresh:before-refresh:hardis:org",
|
|
8107
|
-
"refresh:before-refresh:org:hardis",
|
|
8108
|
-
"hardis:org:before-refresh:refresh",
|
|
8109
|
-
"org:hardis:before-refresh:refresh",
|
|
8110
|
-
"org:before-refresh:hardis:refresh",
|
|
8111
|
-
"org:before-refresh:refresh:hardis",
|
|
8112
|
-
"hardis:before-refresh:org:refresh",
|
|
8113
|
-
"before-refresh:hardis:org:refresh",
|
|
8114
|
-
"before-refresh:org:hardis:refresh",
|
|
8115
|
-
"before-refresh:org:refresh:hardis",
|
|
8116
|
-
"hardis:before-refresh:refresh:org",
|
|
8117
|
-
"before-refresh:hardis:refresh:org",
|
|
8118
|
-
"before-refresh:refresh:hardis:org",
|
|
8119
|
-
"before-refresh:refresh:org:hardis"
|
|
8120
|
-
]
|
|
8121
|
-
},
|
|
8122
|
-
"hardis:org:retrieve:packageconfig": {
|
|
8123
|
-
"aliases": [],
|
|
8124
|
-
"args": {},
|
|
8125
|
-
"description": "\n**Retrieves the installed package configuration from a Salesforce org and optionally updates the local project configuration.**\n\nThis command is useful for maintaining an accurate record of installed packages within your Salesforce project, which is crucial for managing dependencies and ensuring consistent deployments across environments.\n\nKey functionalities:\n\n- **Package Listing:** Connects to a specified Salesforce org (or prompts for one if not provided) and retrieves a list of all installed packages.\n- **Configuration Update:** Offers the option to update your local project's configuration with the retrieved list of installed packages. This can be beneficial for automating package installations during environment setup or CI/CD processes.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **Org Connection:** It establishes a connection to the target Salesforce org using the provided or prompted username.\n- **Metadata Retrieval:** It utilizes `MetadataUtils.listInstalledPackages` to query the Salesforce org and obtain details about the installed packages.\n- **Interactive Prompt:** It uses the `prompts` library to ask the user whether they want to update their local project configuration with the retrieved package list.\n- **Configuration Management:** If the user confirms, it calls `managePackageConfig` to update the project's configuration file (likely `.sfdx-hardis.yml`) with the new package information.\n- **User Feedback:** Provides clear messages to the user about the success of the package retrieval and configuration update.\n</details>\n",
|
|
8126
|
-
"examples": [
|
|
8127
|
-
"$ sf hardis:org:retrieve:packageconfig",
|
|
8128
|
-
"sf hardis:org:retrieve:packageconfig -u myOrg"
|
|
8129
|
-
],
|
|
8130
|
-
"flags": {
|
|
8131
|
-
"json": {
|
|
8132
|
-
"description": "Format output as json.",
|
|
8133
|
-
"helpGroup": "GLOBAL",
|
|
8134
|
-
"name": "json",
|
|
8135
|
-
"allowNo": false,
|
|
8136
|
-
"type": "boolean"
|
|
8137
|
-
},
|
|
8138
|
-
"flags-dir": {
|
|
8139
|
-
"helpGroup": "GLOBAL",
|
|
8140
|
-
"name": "flags-dir",
|
|
8141
|
-
"summary": "Import flag values from a directory.",
|
|
8142
|
-
"hasDynamicHelp": false,
|
|
8143
|
-
"multiple": false,
|
|
8144
|
-
"type": "option"
|
|
8145
|
-
},
|
|
8146
|
-
"debug": {
|
|
8147
|
-
"char": "d",
|
|
8148
|
-
"description": "Activate debug mode (more logs)",
|
|
8149
|
-
"name": "debug",
|
|
8150
|
-
"allowNo": false,
|
|
8151
|
-
"type": "boolean"
|
|
8152
|
-
},
|
|
8153
|
-
"websocket": {
|
|
8154
|
-
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
8155
|
-
"name": "websocket",
|
|
8156
|
-
"hasDynamicHelp": false,
|
|
8157
|
-
"multiple": false,
|
|
8158
|
-
"type": "option"
|
|
8159
|
-
},
|
|
8160
|
-
"skipauth": {
|
|
8161
|
-
"description": "Skip authentication check when a default username is required",
|
|
8162
|
-
"name": "skipauth",
|
|
8163
|
-
"allowNo": false,
|
|
8164
|
-
"type": "boolean"
|
|
8165
|
-
},
|
|
8166
|
-
"target-org": {
|
|
8167
|
-
"aliases": [
|
|
8168
|
-
"targetusername",
|
|
8169
|
-
"u"
|
|
8170
|
-
],
|
|
8171
|
-
"char": "o",
|
|
8172
|
-
"deprecateAliases": true,
|
|
8173
|
-
"name": "target-org",
|
|
8174
|
-
"noCacheDefault": true,
|
|
8175
|
-
"required": true,
|
|
8176
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
8177
|
-
"hasDynamicHelp": true,
|
|
8178
|
-
"multiple": false,
|
|
8179
|
-
"type": "option"
|
|
8180
|
-
}
|
|
8181
|
-
},
|
|
8182
|
-
"hasDynamicHelp": true,
|
|
8183
|
-
"hiddenAliases": [],
|
|
8184
|
-
"id": "hardis:org:retrieve:packageconfig",
|
|
8185
|
-
"pluginAlias": "sfdx-hardis",
|
|
8186
|
-
"pluginName": "sfdx-hardis",
|
|
8187
|
-
"pluginType": "core",
|
|
8188
|
-
"strict": true,
|
|
8189
|
-
"enableJsonFlag": true,
|
|
8190
|
-
"title": "Retrieve package configuration from an org",
|
|
8191
|
-
"requiresProject": false,
|
|
8192
|
-
"isESM": true,
|
|
8193
|
-
"relativePath": [
|
|
8194
|
-
"lib",
|
|
8195
|
-
"commands",
|
|
8196
|
-
"hardis",
|
|
8197
|
-
"org",
|
|
8198
|
-
"retrieve",
|
|
8199
|
-
"packageconfig.js"
|
|
8200
|
-
],
|
|
8201
|
-
"aliasPermutations": [],
|
|
8202
|
-
"permutations": [
|
|
8203
|
-
"hardis:org:retrieve:packageconfig",
|
|
8204
|
-
"org:hardis:retrieve:packageconfig",
|
|
8205
|
-
"org:retrieve:hardis:packageconfig",
|
|
8206
|
-
"org:retrieve:packageconfig:hardis",
|
|
8207
|
-
"hardis:retrieve:org:packageconfig",
|
|
8208
|
-
"retrieve:hardis:org:packageconfig",
|
|
8209
|
-
"retrieve:org:hardis:packageconfig",
|
|
8210
|
-
"retrieve:org:packageconfig:hardis",
|
|
8211
|
-
"hardis:retrieve:packageconfig:org",
|
|
8212
|
-
"retrieve:hardis:packageconfig:org",
|
|
8213
|
-
"retrieve:packageconfig:hardis:org",
|
|
8214
|
-
"retrieve:packageconfig:org:hardis",
|
|
8215
|
-
"hardis:org:packageconfig:retrieve",
|
|
8216
|
-
"org:hardis:packageconfig:retrieve",
|
|
8217
|
-
"org:packageconfig:hardis:retrieve",
|
|
8218
|
-
"org:packageconfig:retrieve:hardis",
|
|
8219
|
-
"hardis:packageconfig:org:retrieve",
|
|
8220
|
-
"packageconfig:hardis:org:retrieve",
|
|
8221
|
-
"packageconfig:org:hardis:retrieve",
|
|
8222
|
-
"packageconfig:org:retrieve:hardis",
|
|
8223
|
-
"hardis:packageconfig:retrieve:org",
|
|
8224
|
-
"packageconfig:hardis:retrieve:org",
|
|
8225
|
-
"packageconfig:retrieve:hardis:org",
|
|
8226
|
-
"packageconfig:retrieve:org:hardis"
|
|
8191
|
+
"requiresProject": true,
|
|
8192
|
+
"isESM": true,
|
|
8193
|
+
"relativePath": [
|
|
8194
|
+
"lib",
|
|
8195
|
+
"commands",
|
|
8196
|
+
"hardis",
|
|
8197
|
+
"org",
|
|
8198
|
+
"refresh",
|
|
8199
|
+
"before-refresh.js"
|
|
8200
|
+
],
|
|
8201
|
+
"aliasPermutations": [],
|
|
8202
|
+
"permutations": [
|
|
8203
|
+
"hardis:org:refresh:before-refresh",
|
|
8204
|
+
"org:hardis:refresh:before-refresh",
|
|
8205
|
+
"org:refresh:hardis:before-refresh",
|
|
8206
|
+
"org:refresh:before-refresh:hardis",
|
|
8207
|
+
"hardis:refresh:org:before-refresh",
|
|
8208
|
+
"refresh:hardis:org:before-refresh",
|
|
8209
|
+
"refresh:org:hardis:before-refresh",
|
|
8210
|
+
"refresh:org:before-refresh:hardis",
|
|
8211
|
+
"hardis:refresh:before-refresh:org",
|
|
8212
|
+
"refresh:hardis:before-refresh:org",
|
|
8213
|
+
"refresh:before-refresh:hardis:org",
|
|
8214
|
+
"refresh:before-refresh:org:hardis",
|
|
8215
|
+
"hardis:org:before-refresh:refresh",
|
|
8216
|
+
"org:hardis:before-refresh:refresh",
|
|
8217
|
+
"org:before-refresh:hardis:refresh",
|
|
8218
|
+
"org:before-refresh:refresh:hardis",
|
|
8219
|
+
"hardis:before-refresh:org:refresh",
|
|
8220
|
+
"before-refresh:hardis:org:refresh",
|
|
8221
|
+
"before-refresh:org:hardis:refresh",
|
|
8222
|
+
"before-refresh:org:refresh:hardis",
|
|
8223
|
+
"hardis:before-refresh:refresh:org",
|
|
8224
|
+
"before-refresh:hardis:refresh:org",
|
|
8225
|
+
"before-refresh:refresh:hardis:org",
|
|
8226
|
+
"before-refresh:refresh:org:hardis"
|
|
8227
8227
|
]
|
|
8228
8228
|
},
|
|
8229
8229
|
"hardis:org:test:apex": {
|
|
@@ -9425,229 +9425,9 @@
|
|
|
9425
9425
|
"hardis:project:audit:remotesites": {
|
|
9426
9426
|
"aliases": [],
|
|
9427
9427
|
"args": {},
|
|
9428
|
-
"description": "\n## Command Behavior\n\n**Audits Salesforce Remote Site Settings in your project, providing a comprehensive overview of external endpoints accessed by your Salesforce org.**\n\nThis command is crucial for security reviews, compliance checks, and understanding the external integrations of your Salesforce environment. It helps identify all configured remote sites, their URLs, activity status, and associated protocols.\n\nKey functionalities:\n\n- **Remote Site Discovery:** Scans your project for RemoteSiteSetting metadata files (.remoteSite-meta.xml or .remoteSite).\n- **URL Extraction:** Extracts the URL, active status, and description for each remote site.\n- **Protocol and Domain Identification:** Determines the protocol (HTTP/HTTPS) and extracts the domain from each URL, providing a clearer picture of the external systems being accessed.\n- **Reporting:** Generates a CSV report summarizing all detected remote sites, including their protocol, domain, name, URL, active status, and description.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **File Discovery:** Uses `glob` to find all RemoteSiteSetting metadata files within the project.\n- **Content Analysis:** Reads the content of each XML file and uses regular expressions (/<url>(.*?)<\\/url>/gim, /<isActive>(.*?)<\\/isActive>/gim, /<description>(.*?)<\\/description>/gim) to extract relevant details.\n- **`catchMatches` Utility:** This utility function is used to apply the defined regular expressions to each file and extract all matching occurrences.\n- **URL Parsing:** Uses Node.js's `url` module to parse the extracted URLs and `psl` (Public Suffix List) to extract the domain name from the hostname.\n- **Data Structuring:** Organizes the extracted information into a structured format, including the remote site's name, file name, namespace, URL, active status, description, protocol, and domain.\n- **Reporting:** Uses `generateReports` to create a CSV report and display a table in the console, summarizing the audit findings.\n</details>\n",
|
|
9429
|
-
"examples": [
|
|
9430
|
-
"$ sf hardis:project:audit:remotesites"
|
|
9431
|
-
],
|
|
9432
|
-
"flags": {
|
|
9433
|
-
"json": {
|
|
9434
|
-
"description": "Format output as json.",
|
|
9435
|
-
"helpGroup": "GLOBAL",
|
|
9436
|
-
"name": "json",
|
|
9437
|
-
"allowNo": false,
|
|
9438
|
-
"type": "boolean"
|
|
9439
|
-
},
|
|
9440
|
-
"flags-dir": {
|
|
9441
|
-
"helpGroup": "GLOBAL",
|
|
9442
|
-
"name": "flags-dir",
|
|
9443
|
-
"summary": "Import flag values from a directory.",
|
|
9444
|
-
"hasDynamicHelp": false,
|
|
9445
|
-
"multiple": false,
|
|
9446
|
-
"type": "option"
|
|
9447
|
-
},
|
|
9448
|
-
"debug": {
|
|
9449
|
-
"char": "d",
|
|
9450
|
-
"description": "Activate debug mode (more logs)",
|
|
9451
|
-
"name": "debug",
|
|
9452
|
-
"allowNo": false,
|
|
9453
|
-
"type": "boolean"
|
|
9454
|
-
},
|
|
9455
|
-
"websocket": {
|
|
9456
|
-
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
9457
|
-
"name": "websocket",
|
|
9458
|
-
"hasDynamicHelp": false,
|
|
9459
|
-
"multiple": false,
|
|
9460
|
-
"type": "option"
|
|
9461
|
-
},
|
|
9462
|
-
"skipauth": {
|
|
9463
|
-
"description": "Skip authentication check when a default username is required",
|
|
9464
|
-
"name": "skipauth",
|
|
9465
|
-
"allowNo": false,
|
|
9466
|
-
"type": "boolean"
|
|
9467
|
-
}
|
|
9468
|
-
},
|
|
9469
|
-
"hasDynamicHelp": false,
|
|
9470
|
-
"hiddenAliases": [],
|
|
9471
|
-
"id": "hardis:project:audit:remotesites",
|
|
9472
|
-
"pluginAlias": "sfdx-hardis",
|
|
9473
|
-
"pluginName": "sfdx-hardis",
|
|
9474
|
-
"pluginType": "core",
|
|
9475
|
-
"strict": true,
|
|
9476
|
-
"enableJsonFlag": true,
|
|
9477
|
-
"title": "Audit Remote Sites",
|
|
9478
|
-
"requiresProject": true,
|
|
9479
|
-
"isESM": true,
|
|
9480
|
-
"relativePath": [
|
|
9481
|
-
"lib",
|
|
9482
|
-
"commands",
|
|
9483
|
-
"hardis",
|
|
9484
|
-
"project",
|
|
9485
|
-
"audit",
|
|
9486
|
-
"remotesites.js"
|
|
9487
|
-
],
|
|
9488
|
-
"aliasPermutations": [],
|
|
9489
|
-
"permutations": [
|
|
9490
|
-
"hardis:project:audit:remotesites",
|
|
9491
|
-
"project:hardis:audit:remotesites",
|
|
9492
|
-
"project:audit:hardis:remotesites",
|
|
9493
|
-
"project:audit:remotesites:hardis",
|
|
9494
|
-
"hardis:audit:project:remotesites",
|
|
9495
|
-
"audit:hardis:project:remotesites",
|
|
9496
|
-
"audit:project:hardis:remotesites",
|
|
9497
|
-
"audit:project:remotesites:hardis",
|
|
9498
|
-
"hardis:audit:remotesites:project",
|
|
9499
|
-
"audit:hardis:remotesites:project",
|
|
9500
|
-
"audit:remotesites:hardis:project",
|
|
9501
|
-
"audit:remotesites:project:hardis",
|
|
9502
|
-
"hardis:project:remotesites:audit",
|
|
9503
|
-
"project:hardis:remotesites:audit",
|
|
9504
|
-
"project:remotesites:hardis:audit",
|
|
9505
|
-
"project:remotesites:audit:hardis",
|
|
9506
|
-
"hardis:remotesites:project:audit",
|
|
9507
|
-
"remotesites:hardis:project:audit",
|
|
9508
|
-
"remotesites:project:hardis:audit",
|
|
9509
|
-
"remotesites:project:audit:hardis",
|
|
9510
|
-
"hardis:remotesites:audit:project",
|
|
9511
|
-
"remotesites:hardis:audit:project",
|
|
9512
|
-
"remotesites:audit:hardis:project",
|
|
9513
|
-
"remotesites:audit:project:hardis"
|
|
9514
|
-
]
|
|
9515
|
-
},
|
|
9516
|
-
"hardis:project:configure:auth": {
|
|
9517
|
-
"aliases": [],
|
|
9518
|
-
"args": {},
|
|
9519
|
-
"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",
|
|
9520
|
-
"examples": [
|
|
9521
|
-
"$ sf hardis:project:configure:auth"
|
|
9522
|
-
],
|
|
9523
|
-
"flags": {
|
|
9524
|
-
"json": {
|
|
9525
|
-
"description": "Format output as json.",
|
|
9526
|
-
"helpGroup": "GLOBAL",
|
|
9527
|
-
"name": "json",
|
|
9528
|
-
"allowNo": false,
|
|
9529
|
-
"type": "boolean"
|
|
9530
|
-
},
|
|
9531
|
-
"flags-dir": {
|
|
9532
|
-
"helpGroup": "GLOBAL",
|
|
9533
|
-
"name": "flags-dir",
|
|
9534
|
-
"summary": "Import flag values from a directory.",
|
|
9535
|
-
"hasDynamicHelp": false,
|
|
9536
|
-
"multiple": false,
|
|
9537
|
-
"type": "option"
|
|
9538
|
-
},
|
|
9539
|
-
"devhub": {
|
|
9540
|
-
"char": "b",
|
|
9541
|
-
"description": "Configure project DevHub",
|
|
9542
|
-
"name": "devhub",
|
|
9543
|
-
"allowNo": false,
|
|
9544
|
-
"type": "boolean"
|
|
9545
|
-
},
|
|
9546
|
-
"debug": {
|
|
9547
|
-
"char": "d",
|
|
9548
|
-
"description": "Activate debug mode (more logs)",
|
|
9549
|
-
"name": "debug",
|
|
9550
|
-
"allowNo": false,
|
|
9551
|
-
"type": "boolean"
|
|
9552
|
-
},
|
|
9553
|
-
"websocket": {
|
|
9554
|
-
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
9555
|
-
"name": "websocket",
|
|
9556
|
-
"hasDynamicHelp": false,
|
|
9557
|
-
"multiple": false,
|
|
9558
|
-
"type": "option"
|
|
9559
|
-
},
|
|
9560
|
-
"skipauth": {
|
|
9561
|
-
"description": "Skip authentication check when a default username is required",
|
|
9562
|
-
"name": "skipauth",
|
|
9563
|
-
"allowNo": false,
|
|
9564
|
-
"type": "boolean"
|
|
9565
|
-
},
|
|
9566
|
-
"target-org": {
|
|
9567
|
-
"aliases": [
|
|
9568
|
-
"targetusername",
|
|
9569
|
-
"u"
|
|
9570
|
-
],
|
|
9571
|
-
"char": "o",
|
|
9572
|
-
"deprecateAliases": true,
|
|
9573
|
-
"name": "target-org",
|
|
9574
|
-
"noCacheDefault": true,
|
|
9575
|
-
"summary": "Username or alias of the target org.",
|
|
9576
|
-
"hasDynamicHelp": true,
|
|
9577
|
-
"multiple": false,
|
|
9578
|
-
"type": "option"
|
|
9579
|
-
},
|
|
9580
|
-
"target-dev-hub": {
|
|
9581
|
-
"aliases": [
|
|
9582
|
-
"targetdevhubusername"
|
|
9583
|
-
],
|
|
9584
|
-
"char": "v",
|
|
9585
|
-
"deprecateAliases": true,
|
|
9586
|
-
"name": "target-dev-hub",
|
|
9587
|
-
"noCacheDefault": true,
|
|
9588
|
-
"required": false,
|
|
9589
|
-
"summary": "Username or alias of the Dev Hub org.",
|
|
9590
|
-
"hasDynamicHelp": true,
|
|
9591
|
-
"multiple": false,
|
|
9592
|
-
"type": "option"
|
|
9593
|
-
}
|
|
9594
|
-
},
|
|
9595
|
-
"hasDynamicHelp": true,
|
|
9596
|
-
"hiddenAliases": [],
|
|
9597
|
-
"id": "hardis:project:configure:auth",
|
|
9598
|
-
"pluginAlias": "sfdx-hardis",
|
|
9599
|
-
"pluginName": "sfdx-hardis",
|
|
9600
|
-
"pluginType": "core",
|
|
9601
|
-
"strict": true,
|
|
9602
|
-
"enableJsonFlag": true,
|
|
9603
|
-
"title": "Configure authentication",
|
|
9604
|
-
"requiresProject": false,
|
|
9605
|
-
"requiresDependencies": [
|
|
9606
|
-
"openssl"
|
|
9607
|
-
],
|
|
9608
|
-
"isESM": true,
|
|
9609
|
-
"relativePath": [
|
|
9610
|
-
"lib",
|
|
9611
|
-
"commands",
|
|
9612
|
-
"hardis",
|
|
9613
|
-
"project",
|
|
9614
|
-
"configure",
|
|
9615
|
-
"auth.js"
|
|
9616
|
-
],
|
|
9617
|
-
"aliasPermutations": [],
|
|
9618
|
-
"permutations": [
|
|
9619
|
-
"hardis:project:configure:auth",
|
|
9620
|
-
"project:hardis:configure:auth",
|
|
9621
|
-
"project:configure:hardis:auth",
|
|
9622
|
-
"project:configure:auth:hardis",
|
|
9623
|
-
"hardis:configure:project:auth",
|
|
9624
|
-
"configure:hardis:project:auth",
|
|
9625
|
-
"configure:project:hardis:auth",
|
|
9626
|
-
"configure:project:auth:hardis",
|
|
9627
|
-
"hardis:configure:auth:project",
|
|
9628
|
-
"configure:hardis:auth:project",
|
|
9629
|
-
"configure:auth:hardis:project",
|
|
9630
|
-
"configure:auth:project:hardis",
|
|
9631
|
-
"hardis:project:auth:configure",
|
|
9632
|
-
"project:hardis:auth:configure",
|
|
9633
|
-
"project:auth:hardis:configure",
|
|
9634
|
-
"project:auth:configure:hardis",
|
|
9635
|
-
"hardis:auth:project:configure",
|
|
9636
|
-
"auth:hardis:project:configure",
|
|
9637
|
-
"auth:project:hardis:configure",
|
|
9638
|
-
"auth:project:configure:hardis",
|
|
9639
|
-
"hardis:auth:configure:project",
|
|
9640
|
-
"auth:hardis:configure:project",
|
|
9641
|
-
"auth:configure:hardis:project",
|
|
9642
|
-
"auth:configure:project:hardis"
|
|
9643
|
-
]
|
|
9644
|
-
},
|
|
9645
|
-
"hardis:project:convert:profilestopermsets": {
|
|
9646
|
-
"aliases": [],
|
|
9647
|
-
"args": {},
|
|
9648
|
-
"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",
|
|
9428
|
+
"description": "\n## Command Behavior\n\n**Audits Salesforce Remote Site Settings in your project, providing a comprehensive overview of external endpoints accessed by your Salesforce org.**\n\nThis command is crucial for security reviews, compliance checks, and understanding the external integrations of your Salesforce environment. It helps identify all configured remote sites, their URLs, activity status, and associated protocols.\n\nKey functionalities:\n\n- **Remote Site Discovery:** Scans your project for RemoteSiteSetting metadata files (.remoteSite-meta.xml or .remoteSite).\n- **URL Extraction:** Extracts the URL, active status, and description for each remote site.\n- **Protocol and Domain Identification:** Determines the protocol (HTTP/HTTPS) and extracts the domain from each URL, providing a clearer picture of the external systems being accessed.\n- **Reporting:** Generates a CSV report summarizing all detected remote sites, including their protocol, domain, name, URL, active status, and description.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **File Discovery:** Uses `glob` to find all RemoteSiteSetting metadata files within the project.\n- **Content Analysis:** Reads the content of each XML file and uses regular expressions (/<url>(.*?)<\\/url>/gim, /<isActive>(.*?)<\\/isActive>/gim, /<description>(.*?)<\\/description>/gim) to extract relevant details.\n- **`catchMatches` Utility:** This utility function is used to apply the defined regular expressions to each file and extract all matching occurrences.\n- **URL Parsing:** Uses Node.js's `url` module to parse the extracted URLs and `psl` (Public Suffix List) to extract the domain name from the hostname.\n- **Data Structuring:** Organizes the extracted information into a structured format, including the remote site's name, file name, namespace, URL, active status, description, protocol, and domain.\n- **Reporting:** Uses `generateReports` to create a CSV report and display a table in the console, summarizing the audit findings.\n</details>\n",
|
|
9649
9429
|
"examples": [
|
|
9650
|
-
"$ sf hardis:project:
|
|
9430
|
+
"$ sf hardis:project:audit:remotesites"
|
|
9651
9431
|
],
|
|
9652
9432
|
"flags": {
|
|
9653
9433
|
"json": {
|
|
@@ -9665,15 +9445,6 @@
|
|
|
9665
9445
|
"multiple": false,
|
|
9666
9446
|
"type": "option"
|
|
9667
9447
|
},
|
|
9668
|
-
"except": {
|
|
9669
|
-
"char": "e",
|
|
9670
|
-
"description": "List of filters",
|
|
9671
|
-
"name": "except",
|
|
9672
|
-
"default": [],
|
|
9673
|
-
"hasDynamicHelp": false,
|
|
9674
|
-
"multiple": true,
|
|
9675
|
-
"type": "option"
|
|
9676
|
-
},
|
|
9677
9448
|
"debug": {
|
|
9678
9449
|
"char": "d",
|
|
9679
9450
|
"description": "Activate debug mode (more logs)",
|
|
@@ -9697,52 +9468,49 @@
|
|
|
9697
9468
|
},
|
|
9698
9469
|
"hasDynamicHelp": false,
|
|
9699
9470
|
"hiddenAliases": [],
|
|
9700
|
-
"id": "hardis:project:
|
|
9471
|
+
"id": "hardis:project:audit:remotesites",
|
|
9701
9472
|
"pluginAlias": "sfdx-hardis",
|
|
9702
9473
|
"pluginName": "sfdx-hardis",
|
|
9703
9474
|
"pluginType": "core",
|
|
9704
9475
|
"strict": true,
|
|
9705
9476
|
"enableJsonFlag": true,
|
|
9706
|
-
"title": "
|
|
9477
|
+
"title": "Audit Remote Sites",
|
|
9707
9478
|
"requiresProject": true,
|
|
9708
|
-
"requiresSfdxPlugins": [
|
|
9709
|
-
"shane-sfdx-plugins"
|
|
9710
|
-
],
|
|
9711
9479
|
"isESM": true,
|
|
9712
9480
|
"relativePath": [
|
|
9713
9481
|
"lib",
|
|
9714
9482
|
"commands",
|
|
9715
9483
|
"hardis",
|
|
9716
9484
|
"project",
|
|
9717
|
-
"
|
|
9718
|
-
"
|
|
9485
|
+
"audit",
|
|
9486
|
+
"remotesites.js"
|
|
9719
9487
|
],
|
|
9720
9488
|
"aliasPermutations": [],
|
|
9721
9489
|
"permutations": [
|
|
9722
|
-
"hardis:project:
|
|
9723
|
-
"project:hardis:
|
|
9724
|
-
"project:
|
|
9725
|
-
"project:
|
|
9726
|
-
"hardis:
|
|
9727
|
-
"
|
|
9728
|
-
"
|
|
9729
|
-
"
|
|
9730
|
-
"hardis:
|
|
9731
|
-
"
|
|
9732
|
-
"
|
|
9733
|
-
"
|
|
9734
|
-
"hardis:project:
|
|
9735
|
-
"project:hardis:
|
|
9736
|
-
"project:
|
|
9737
|
-
"project:
|
|
9738
|
-
"hardis:
|
|
9739
|
-
"
|
|
9740
|
-
"
|
|
9741
|
-
"
|
|
9742
|
-
"hardis:
|
|
9743
|
-
"
|
|
9744
|
-
"
|
|
9745
|
-
"
|
|
9490
|
+
"hardis:project:audit:remotesites",
|
|
9491
|
+
"project:hardis:audit:remotesites",
|
|
9492
|
+
"project:audit:hardis:remotesites",
|
|
9493
|
+
"project:audit:remotesites:hardis",
|
|
9494
|
+
"hardis:audit:project:remotesites",
|
|
9495
|
+
"audit:hardis:project:remotesites",
|
|
9496
|
+
"audit:project:hardis:remotesites",
|
|
9497
|
+
"audit:project:remotesites:hardis",
|
|
9498
|
+
"hardis:audit:remotesites:project",
|
|
9499
|
+
"audit:hardis:remotesites:project",
|
|
9500
|
+
"audit:remotesites:hardis:project",
|
|
9501
|
+
"audit:remotesites:project:hardis",
|
|
9502
|
+
"hardis:project:remotesites:audit",
|
|
9503
|
+
"project:hardis:remotesites:audit",
|
|
9504
|
+
"project:remotesites:hardis:audit",
|
|
9505
|
+
"project:remotesites:audit:hardis",
|
|
9506
|
+
"hardis:remotesites:project:audit",
|
|
9507
|
+
"remotesites:hardis:project:audit",
|
|
9508
|
+
"remotesites:project:hardis:audit",
|
|
9509
|
+
"remotesites:project:audit:hardis",
|
|
9510
|
+
"hardis:remotesites:audit:project",
|
|
9511
|
+
"remotesites:hardis:audit:project",
|
|
9512
|
+
"remotesites:audit:hardis:project",
|
|
9513
|
+
"remotesites:audit:project:hardis"
|
|
9746
9514
|
]
|
|
9747
9515
|
},
|
|
9748
9516
|
"hardis:project:clean:emptyitems": {
|
|
@@ -11230,12 +10998,12 @@
|
|
|
11230
10998
|
"xml:clean:project:hardis"
|
|
11231
10999
|
]
|
|
11232
11000
|
},
|
|
11233
|
-
"hardis:project:
|
|
11001
|
+
"hardis:project:convert:profilestopermsets": {
|
|
11234
11002
|
"aliases": [],
|
|
11235
11003
|
"args": {},
|
|
11236
|
-
"description": "\n## Command Behavior\n\n**
|
|
11004
|
+
"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",
|
|
11237
11005
|
"examples": [
|
|
11238
|
-
"$ sf hardis:project:
|
|
11006
|
+
"$ sf hardis:project:convert:profilestopermsets"
|
|
11239
11007
|
],
|
|
11240
11008
|
"flags": {
|
|
11241
11009
|
"json": {
|
|
@@ -11253,13 +11021,13 @@
|
|
|
11253
11021
|
"multiple": false,
|
|
11254
11022
|
"type": "option"
|
|
11255
11023
|
},
|
|
11256
|
-
"
|
|
11257
|
-
"char": "
|
|
11258
|
-
"description": "
|
|
11259
|
-
"name": "
|
|
11260
|
-
"default":
|
|
11024
|
+
"except": {
|
|
11025
|
+
"char": "e",
|
|
11026
|
+
"description": "List of filters",
|
|
11027
|
+
"name": "except",
|
|
11028
|
+
"default": [],
|
|
11261
11029
|
"hasDynamicHelp": false,
|
|
11262
|
-
"multiple":
|
|
11030
|
+
"multiple": true,
|
|
11263
11031
|
"type": "option"
|
|
11264
11032
|
},
|
|
11265
11033
|
"debug": {
|
|
@@ -11281,76 +11049,64 @@
|
|
|
11281
11049
|
"name": "skipauth",
|
|
11282
11050
|
"allowNo": false,
|
|
11283
11051
|
"type": "boolean"
|
|
11284
|
-
},
|
|
11285
|
-
"target-org": {
|
|
11286
|
-
"aliases": [
|
|
11287
|
-
"targetusername",
|
|
11288
|
-
"u"
|
|
11289
|
-
],
|
|
11290
|
-
"char": "o",
|
|
11291
|
-
"deprecateAliases": true,
|
|
11292
|
-
"name": "target-org",
|
|
11293
|
-
"noCacheDefault": true,
|
|
11294
|
-
"required": true,
|
|
11295
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
11296
|
-
"hasDynamicHelp": true,
|
|
11297
|
-
"multiple": false,
|
|
11298
|
-
"type": "option"
|
|
11299
11052
|
}
|
|
11300
11053
|
},
|
|
11301
|
-
"hasDynamicHelp":
|
|
11054
|
+
"hasDynamicHelp": false,
|
|
11302
11055
|
"hiddenAliases": [],
|
|
11303
|
-
"id": "hardis:project:
|
|
11056
|
+
"id": "hardis:project:convert:profilestopermsets",
|
|
11304
11057
|
"pluginAlias": "sfdx-hardis",
|
|
11305
11058
|
"pluginName": "sfdx-hardis",
|
|
11306
11059
|
"pluginType": "core",
|
|
11307
11060
|
"strict": true,
|
|
11308
11061
|
"enableJsonFlag": true,
|
|
11309
|
-
"title": "
|
|
11062
|
+
"title": "Convert Profiles into Permission Sets",
|
|
11310
11063
|
"requiresProject": true,
|
|
11064
|
+
"requiresSfdxPlugins": [
|
|
11065
|
+
"shane-sfdx-plugins"
|
|
11066
|
+
],
|
|
11311
11067
|
"isESM": true,
|
|
11312
11068
|
"relativePath": [
|
|
11313
11069
|
"lib",
|
|
11314
11070
|
"commands",
|
|
11315
11071
|
"hardis",
|
|
11316
11072
|
"project",
|
|
11317
|
-
"
|
|
11318
|
-
"
|
|
11073
|
+
"convert",
|
|
11074
|
+
"profilestopermsets.js"
|
|
11319
11075
|
],
|
|
11320
11076
|
"aliasPermutations": [],
|
|
11321
11077
|
"permutations": [
|
|
11322
|
-
"hardis:project:
|
|
11323
|
-
"project:hardis:
|
|
11324
|
-
"project:
|
|
11325
|
-
"project:
|
|
11326
|
-
"hardis:
|
|
11327
|
-
"
|
|
11328
|
-
"
|
|
11329
|
-
"
|
|
11330
|
-
"hardis:
|
|
11331
|
-
"
|
|
11332
|
-
"
|
|
11333
|
-
"
|
|
11334
|
-
"hardis:project:
|
|
11335
|
-
"project:hardis:
|
|
11336
|
-
"project:
|
|
11337
|
-
"project:
|
|
11338
|
-
"hardis:
|
|
11339
|
-
"
|
|
11340
|
-
"
|
|
11341
|
-
"
|
|
11342
|
-
"hardis:
|
|
11343
|
-
"
|
|
11344
|
-
"
|
|
11345
|
-
"
|
|
11078
|
+
"hardis:project:convert:profilestopermsets",
|
|
11079
|
+
"project:hardis:convert:profilestopermsets",
|
|
11080
|
+
"project:convert:hardis:profilestopermsets",
|
|
11081
|
+
"project:convert:profilestopermsets:hardis",
|
|
11082
|
+
"hardis:convert:project:profilestopermsets",
|
|
11083
|
+
"convert:hardis:project:profilestopermsets",
|
|
11084
|
+
"convert:project:hardis:profilestopermsets",
|
|
11085
|
+
"convert:project:profilestopermsets:hardis",
|
|
11086
|
+
"hardis:convert:profilestopermsets:project",
|
|
11087
|
+
"convert:hardis:profilestopermsets:project",
|
|
11088
|
+
"convert:profilestopermsets:hardis:project",
|
|
11089
|
+
"convert:profilestopermsets:project:hardis",
|
|
11090
|
+
"hardis:project:profilestopermsets:convert",
|
|
11091
|
+
"project:hardis:profilestopermsets:convert",
|
|
11092
|
+
"project:profilestopermsets:hardis:convert",
|
|
11093
|
+
"project:profilestopermsets:convert:hardis",
|
|
11094
|
+
"hardis:profilestopermsets:project:convert",
|
|
11095
|
+
"profilestopermsets:hardis:project:convert",
|
|
11096
|
+
"profilestopermsets:project:hardis:convert",
|
|
11097
|
+
"profilestopermsets:project:convert:hardis",
|
|
11098
|
+
"hardis:profilestopermsets:convert:project",
|
|
11099
|
+
"profilestopermsets:hardis:convert:project",
|
|
11100
|
+
"profilestopermsets:convert:hardis:project",
|
|
11101
|
+
"profilestopermsets:convert:project:hardis"
|
|
11346
11102
|
]
|
|
11347
11103
|
},
|
|
11348
|
-
"hardis:project:
|
|
11104
|
+
"hardis:project:configure:auth": {
|
|
11349
11105
|
"aliases": [],
|
|
11350
11106
|
"args": {},
|
|
11351
|
-
"description": "\n## Command Behavior\n\n**
|
|
11107
|
+
"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",
|
|
11352
11108
|
"examples": [
|
|
11353
|
-
"$ sf hardis:project:
|
|
11109
|
+
"$ sf hardis:project:configure:auth"
|
|
11354
11110
|
],
|
|
11355
11111
|
"flags": {
|
|
11356
11112
|
"json": {
|
|
@@ -11368,14 +11124,12 @@
|
|
|
11368
11124
|
"multiple": false,
|
|
11369
11125
|
"type": "option"
|
|
11370
11126
|
},
|
|
11371
|
-
"
|
|
11372
|
-
"char": "
|
|
11373
|
-
"description": "
|
|
11374
|
-
"name": "
|
|
11375
|
-
"
|
|
11376
|
-
"
|
|
11377
|
-
"multiple": false,
|
|
11378
|
-
"type": "option"
|
|
11127
|
+
"devhub": {
|
|
11128
|
+
"char": "b",
|
|
11129
|
+
"description": "Configure project DevHub",
|
|
11130
|
+
"name": "devhub",
|
|
11131
|
+
"allowNo": false,
|
|
11132
|
+
"type": "boolean"
|
|
11379
11133
|
},
|
|
11380
11134
|
"debug": {
|
|
11381
11135
|
"char": "d",
|
|
@@ -11396,53 +11150,84 @@
|
|
|
11396
11150
|
"name": "skipauth",
|
|
11397
11151
|
"allowNo": false,
|
|
11398
11152
|
"type": "boolean"
|
|
11153
|
+
},
|
|
11154
|
+
"target-org": {
|
|
11155
|
+
"aliases": [
|
|
11156
|
+
"targetusername",
|
|
11157
|
+
"u"
|
|
11158
|
+
],
|
|
11159
|
+
"char": "o",
|
|
11160
|
+
"deprecateAliases": true,
|
|
11161
|
+
"name": "target-org",
|
|
11162
|
+
"noCacheDefault": true,
|
|
11163
|
+
"summary": "Username or alias of the target org.",
|
|
11164
|
+
"hasDynamicHelp": true,
|
|
11165
|
+
"multiple": false,
|
|
11166
|
+
"type": "option"
|
|
11167
|
+
},
|
|
11168
|
+
"target-dev-hub": {
|
|
11169
|
+
"aliases": [
|
|
11170
|
+
"targetdevhubusername"
|
|
11171
|
+
],
|
|
11172
|
+
"char": "v",
|
|
11173
|
+
"deprecateAliases": true,
|
|
11174
|
+
"name": "target-dev-hub",
|
|
11175
|
+
"noCacheDefault": true,
|
|
11176
|
+
"required": false,
|
|
11177
|
+
"summary": "Username or alias of the Dev Hub org.",
|
|
11178
|
+
"hasDynamicHelp": true,
|
|
11179
|
+
"multiple": false,
|
|
11180
|
+
"type": "option"
|
|
11399
11181
|
}
|
|
11400
11182
|
},
|
|
11401
|
-
"hasDynamicHelp":
|
|
11183
|
+
"hasDynamicHelp": true,
|
|
11402
11184
|
"hiddenAliases": [],
|
|
11403
|
-
"id": "hardis:project:
|
|
11185
|
+
"id": "hardis:project:configure:auth",
|
|
11404
11186
|
"pluginAlias": "sfdx-hardis",
|
|
11405
11187
|
"pluginName": "sfdx-hardis",
|
|
11406
11188
|
"pluginType": "core",
|
|
11407
11189
|
"strict": true,
|
|
11408
|
-
"enableJsonFlag": true,
|
|
11409
|
-
"title": "
|
|
11410
|
-
"requiresProject":
|
|
11411
|
-
"
|
|
11412
|
-
|
|
11413
|
-
|
|
11414
|
-
|
|
11415
|
-
|
|
11416
|
-
"
|
|
11417
|
-
"
|
|
11418
|
-
"
|
|
11419
|
-
|
|
11420
|
-
|
|
11421
|
-
|
|
11422
|
-
|
|
11423
|
-
|
|
11424
|
-
|
|
11425
|
-
"project:
|
|
11426
|
-
"hardis:
|
|
11427
|
-
"
|
|
11428
|
-
"
|
|
11429
|
-
"
|
|
11430
|
-
"hardis:
|
|
11431
|
-
"
|
|
11432
|
-
"
|
|
11433
|
-
"
|
|
11434
|
-
"hardis:project
|
|
11435
|
-
"
|
|
11436
|
-
"project:
|
|
11437
|
-
"project:
|
|
11438
|
-
"hardis:
|
|
11439
|
-
"
|
|
11440
|
-
"
|
|
11441
|
-
"
|
|
11442
|
-
"hardis:
|
|
11443
|
-
"
|
|
11444
|
-
"
|
|
11445
|
-
"
|
|
11190
|
+
"enableJsonFlag": true,
|
|
11191
|
+
"title": "Configure authentication",
|
|
11192
|
+
"requiresProject": false,
|
|
11193
|
+
"requiresDependencies": [
|
|
11194
|
+
"openssl"
|
|
11195
|
+
],
|
|
11196
|
+
"isESM": true,
|
|
11197
|
+
"relativePath": [
|
|
11198
|
+
"lib",
|
|
11199
|
+
"commands",
|
|
11200
|
+
"hardis",
|
|
11201
|
+
"project",
|
|
11202
|
+
"configure",
|
|
11203
|
+
"auth.js"
|
|
11204
|
+
],
|
|
11205
|
+
"aliasPermutations": [],
|
|
11206
|
+
"permutations": [
|
|
11207
|
+
"hardis:project:configure:auth",
|
|
11208
|
+
"project:hardis:configure:auth",
|
|
11209
|
+
"project:configure:hardis:auth",
|
|
11210
|
+
"project:configure:auth:hardis",
|
|
11211
|
+
"hardis:configure:project:auth",
|
|
11212
|
+
"configure:hardis:project:auth",
|
|
11213
|
+
"configure:project:hardis:auth",
|
|
11214
|
+
"configure:project:auth:hardis",
|
|
11215
|
+
"hardis:configure:auth:project",
|
|
11216
|
+
"configure:hardis:auth:project",
|
|
11217
|
+
"configure:auth:hardis:project",
|
|
11218
|
+
"configure:auth:project:hardis",
|
|
11219
|
+
"hardis:project:auth:configure",
|
|
11220
|
+
"project:hardis:auth:configure",
|
|
11221
|
+
"project:auth:hardis:configure",
|
|
11222
|
+
"project:auth:configure:hardis",
|
|
11223
|
+
"hardis:auth:project:configure",
|
|
11224
|
+
"auth:hardis:project:configure",
|
|
11225
|
+
"auth:project:hardis:configure",
|
|
11226
|
+
"auth:project:configure:hardis",
|
|
11227
|
+
"hardis:auth:configure:project",
|
|
11228
|
+
"auth:hardis:configure:project",
|
|
11229
|
+
"auth:configure:hardis:project",
|
|
11230
|
+
"auth:configure:project:hardis"
|
|
11446
11231
|
]
|
|
11447
11232
|
},
|
|
11448
11233
|
"hardis:project:deploy:notify": {
|
|
@@ -12620,6 +12405,221 @@
|
|
|
12620
12405
|
"validate:deploy:project:hardis"
|
|
12621
12406
|
]
|
|
12622
12407
|
},
|
|
12408
|
+
"hardis:project:fix:profiletabs": {
|
|
12409
|
+
"aliases": [],
|
|
12410
|
+
"args": {},
|
|
12411
|
+
"description": "\n## Command Behavior\n\n**Interactively updates tab visibility settings in Salesforce profiles, addressing a common issue where tab visibilities are not correctly retrieved by `sf project retrieve start`.**\n\nThis command provides a user-friendly interface to manage tab settings within your profile XML files, ensuring that your local project accurately reflects the intended tab configurations in your Salesforce org.\n\nKey functionalities:\n\n- **Interactive Tab Selection:** Displays a multi-select menu of all available tabs in your org, allowing you to choose which tabs to update.\n- **Visibility Control:** Lets you set the visibility for the selected tabs to either `DefaultOn` (Visible) or `Hidden`.\n- **Profile Selection:** Presents a multi-select menu of all .profile-meta.xml files in your project, allowing you to apply the tab visibility changes to specific profiles.\n- **XML Updates:** Modifies the <tabVisibilities> section of the selected profile XML files to reflect the chosen tab settings. If a tab visibility setting already exists for a selected tab, it will be updated; otherwise, a new one will be added.\n- **Sorted Output:** The <tabVisibilities> in the updated profile XML files are sorted alphabetically for consistency and readability.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **SOQL Queries (Tooling API):** It queries the `TabDefinition` object using `soqlQueryTooling` to retrieve a list of all available tabs in the target org.\n- **File Discovery:** Uses `glob` to find all .profile-meta.xml files within the specified project path.\n- **Interactive Prompts:** Leverages the `prompts` library to create interactive menus for selecting tabs, visibility settings, and profiles.\n- **XML Parsing and Manipulation:** Uses `parseXmlFile` to read the content of profile XML files and `writeXmlFile` to write the modified content back. It manipulates the `tabVisibilities` array within the parsed XML to add or update tab settings.\n- **Array Sorting:** Employs the `sort-array` library to sort the `tabVisibilities` alphabetically by tab name.\n- **Logging:** Provides feedback to the user about which profiles have been updated and a summary of the changes.\n</details>\n",
|
|
12412
|
+
"examples": [
|
|
12413
|
+
"$ sf hardis:project:fix:profiletabs"
|
|
12414
|
+
],
|
|
12415
|
+
"flags": {
|
|
12416
|
+
"json": {
|
|
12417
|
+
"description": "Format output as json.",
|
|
12418
|
+
"helpGroup": "GLOBAL",
|
|
12419
|
+
"name": "json",
|
|
12420
|
+
"allowNo": false,
|
|
12421
|
+
"type": "boolean"
|
|
12422
|
+
},
|
|
12423
|
+
"flags-dir": {
|
|
12424
|
+
"helpGroup": "GLOBAL",
|
|
12425
|
+
"name": "flags-dir",
|
|
12426
|
+
"summary": "Import flag values from a directory.",
|
|
12427
|
+
"hasDynamicHelp": false,
|
|
12428
|
+
"multiple": false,
|
|
12429
|
+
"type": "option"
|
|
12430
|
+
},
|
|
12431
|
+
"path": {
|
|
12432
|
+
"char": "p",
|
|
12433
|
+
"description": "Root folder",
|
|
12434
|
+
"name": "path",
|
|
12435
|
+
"default": "/home/runner/work/sfdx-hardis/sfdx-hardis",
|
|
12436
|
+
"hasDynamicHelp": false,
|
|
12437
|
+
"multiple": false,
|
|
12438
|
+
"type": "option"
|
|
12439
|
+
},
|
|
12440
|
+
"debug": {
|
|
12441
|
+
"char": "d",
|
|
12442
|
+
"description": "Activate debug mode (more logs)",
|
|
12443
|
+
"name": "debug",
|
|
12444
|
+
"allowNo": false,
|
|
12445
|
+
"type": "boolean"
|
|
12446
|
+
},
|
|
12447
|
+
"websocket": {
|
|
12448
|
+
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
12449
|
+
"name": "websocket",
|
|
12450
|
+
"hasDynamicHelp": false,
|
|
12451
|
+
"multiple": false,
|
|
12452
|
+
"type": "option"
|
|
12453
|
+
},
|
|
12454
|
+
"skipauth": {
|
|
12455
|
+
"description": "Skip authentication check when a default username is required",
|
|
12456
|
+
"name": "skipauth",
|
|
12457
|
+
"allowNo": false,
|
|
12458
|
+
"type": "boolean"
|
|
12459
|
+
},
|
|
12460
|
+
"target-org": {
|
|
12461
|
+
"aliases": [
|
|
12462
|
+
"targetusername",
|
|
12463
|
+
"u"
|
|
12464
|
+
],
|
|
12465
|
+
"char": "o",
|
|
12466
|
+
"deprecateAliases": true,
|
|
12467
|
+
"name": "target-org",
|
|
12468
|
+
"noCacheDefault": true,
|
|
12469
|
+
"required": true,
|
|
12470
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
12471
|
+
"hasDynamicHelp": true,
|
|
12472
|
+
"multiple": false,
|
|
12473
|
+
"type": "option"
|
|
12474
|
+
}
|
|
12475
|
+
},
|
|
12476
|
+
"hasDynamicHelp": true,
|
|
12477
|
+
"hiddenAliases": [],
|
|
12478
|
+
"id": "hardis:project:fix:profiletabs",
|
|
12479
|
+
"pluginAlias": "sfdx-hardis",
|
|
12480
|
+
"pluginName": "sfdx-hardis",
|
|
12481
|
+
"pluginType": "core",
|
|
12482
|
+
"strict": true,
|
|
12483
|
+
"enableJsonFlag": true,
|
|
12484
|
+
"title": "Fix profiles to add tabs that are not retrieved by SF CLI",
|
|
12485
|
+
"requiresProject": true,
|
|
12486
|
+
"isESM": true,
|
|
12487
|
+
"relativePath": [
|
|
12488
|
+
"lib",
|
|
12489
|
+
"commands",
|
|
12490
|
+
"hardis",
|
|
12491
|
+
"project",
|
|
12492
|
+
"fix",
|
|
12493
|
+
"profiletabs.js"
|
|
12494
|
+
],
|
|
12495
|
+
"aliasPermutations": [],
|
|
12496
|
+
"permutations": [
|
|
12497
|
+
"hardis:project:fix:profiletabs",
|
|
12498
|
+
"project:hardis:fix:profiletabs",
|
|
12499
|
+
"project:fix:hardis:profiletabs",
|
|
12500
|
+
"project:fix:profiletabs:hardis",
|
|
12501
|
+
"hardis:fix:project:profiletabs",
|
|
12502
|
+
"fix:hardis:project:profiletabs",
|
|
12503
|
+
"fix:project:hardis:profiletabs",
|
|
12504
|
+
"fix:project:profiletabs:hardis",
|
|
12505
|
+
"hardis:fix:profiletabs:project",
|
|
12506
|
+
"fix:hardis:profiletabs:project",
|
|
12507
|
+
"fix:profiletabs:hardis:project",
|
|
12508
|
+
"fix:profiletabs:project:hardis",
|
|
12509
|
+
"hardis:project:profiletabs:fix",
|
|
12510
|
+
"project:hardis:profiletabs:fix",
|
|
12511
|
+
"project:profiletabs:hardis:fix",
|
|
12512
|
+
"project:profiletabs:fix:hardis",
|
|
12513
|
+
"hardis:profiletabs:project:fix",
|
|
12514
|
+
"profiletabs:hardis:project:fix",
|
|
12515
|
+
"profiletabs:project:hardis:fix",
|
|
12516
|
+
"profiletabs:project:fix:hardis",
|
|
12517
|
+
"hardis:profiletabs:fix:project",
|
|
12518
|
+
"profiletabs:hardis:fix:project",
|
|
12519
|
+
"profiletabs:fix:hardis:project",
|
|
12520
|
+
"profiletabs:fix:project:hardis"
|
|
12521
|
+
]
|
|
12522
|
+
},
|
|
12523
|
+
"hardis:project:fix:v53flexipages": {
|
|
12524
|
+
"aliases": [],
|
|
12525
|
+
"args": {},
|
|
12526
|
+
"description": "\n## Command Behavior\n\n**Fixes Salesforce FlexiPages for compatibility with API Version 53.0 (Winter '22 release) by adding missing identifiers to component instances.**\n\nSalesforce introduced a change in API Version 53.0 that requires `identifier` tags within `componentInstance` and `fieldInstance` elements in FlexiPage metadata. If these identifiers are missing, deployments to orgs with API version 53.0 or higher will fail. This command automates the process of adding these missing identifiers, ensuring your FlexiPages remain deployable.\n\nKey functionalities:\n\n- **Targeted FlexiPage Processing:** Scans all .flexipage-meta.xml files within the specified root folder (defaults to current working directory).\n- **Identifier Injection:** Inserts a unique `identifier` tag (e.g., `SFDX_HARDIS_REPLACEMENT_ID`) into `componentInstance` and `fieldInstance` elements that lack one.\n\n**Important Note:** After running this command, ensure you update your `apiVersion` to `53.0` (or higher) in your `package.xml` and `sfdx-project.json` files.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **File Discovery:** Uses `glob` to find all .flexipage-meta.xml files.\n- **Content Reading:** Reads the XML content of each FlexiPage file.\n- **Regular Expression Replacement:** Employs a set of regular expressions to identify specific XML patterns (componentName.../componentName.../componentInstance, componentName.../componentName.../visibilityRule, fieldItem.../fieldItem.../fieldInstance) that are missing the `identifier` tag.\n- **Dynamic ID Generation:** For each match, it generates a unique identifier (e.g., `sfdxHardisIdX`) and injects it into the XML structure.\n- **File Writing:** If changes are made, the modified XML content is written back to the FlexiPage file using `fs.writeFile`.\n- **Logging:** Provides messages about which FlexiPages are being processed and a summary of the total number of identifiers added.\n</details>\n",
|
|
12527
|
+
"examples": [
|
|
12528
|
+
"$ sf hardis:project:fix:v53flexipages"
|
|
12529
|
+
],
|
|
12530
|
+
"flags": {
|
|
12531
|
+
"json": {
|
|
12532
|
+
"description": "Format output as json.",
|
|
12533
|
+
"helpGroup": "GLOBAL",
|
|
12534
|
+
"name": "json",
|
|
12535
|
+
"allowNo": false,
|
|
12536
|
+
"type": "boolean"
|
|
12537
|
+
},
|
|
12538
|
+
"flags-dir": {
|
|
12539
|
+
"helpGroup": "GLOBAL",
|
|
12540
|
+
"name": "flags-dir",
|
|
12541
|
+
"summary": "Import flag values from a directory.",
|
|
12542
|
+
"hasDynamicHelp": false,
|
|
12543
|
+
"multiple": false,
|
|
12544
|
+
"type": "option"
|
|
12545
|
+
},
|
|
12546
|
+
"path": {
|
|
12547
|
+
"char": "p",
|
|
12548
|
+
"description": "Root folder",
|
|
12549
|
+
"name": "path",
|
|
12550
|
+
"default": "/home/runner/work/sfdx-hardis/sfdx-hardis",
|
|
12551
|
+
"hasDynamicHelp": false,
|
|
12552
|
+
"multiple": false,
|
|
12553
|
+
"type": "option"
|
|
12554
|
+
},
|
|
12555
|
+
"debug": {
|
|
12556
|
+
"char": "d",
|
|
12557
|
+
"description": "Activate debug mode (more logs)",
|
|
12558
|
+
"name": "debug",
|
|
12559
|
+
"allowNo": false,
|
|
12560
|
+
"type": "boolean"
|
|
12561
|
+
},
|
|
12562
|
+
"websocket": {
|
|
12563
|
+
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
12564
|
+
"name": "websocket",
|
|
12565
|
+
"hasDynamicHelp": false,
|
|
12566
|
+
"multiple": false,
|
|
12567
|
+
"type": "option"
|
|
12568
|
+
},
|
|
12569
|
+
"skipauth": {
|
|
12570
|
+
"description": "Skip authentication check when a default username is required",
|
|
12571
|
+
"name": "skipauth",
|
|
12572
|
+
"allowNo": false,
|
|
12573
|
+
"type": "boolean"
|
|
12574
|
+
}
|
|
12575
|
+
},
|
|
12576
|
+
"hasDynamicHelp": false,
|
|
12577
|
+
"hiddenAliases": [],
|
|
12578
|
+
"id": "hardis:project:fix:v53flexipages",
|
|
12579
|
+
"pluginAlias": "sfdx-hardis",
|
|
12580
|
+
"pluginName": "sfdx-hardis",
|
|
12581
|
+
"pluginType": "core",
|
|
12582
|
+
"strict": true,
|
|
12583
|
+
"enableJsonFlag": true,
|
|
12584
|
+
"title": "Fix flexipages for v53",
|
|
12585
|
+
"requiresProject": true,
|
|
12586
|
+
"isESM": true,
|
|
12587
|
+
"relativePath": [
|
|
12588
|
+
"lib",
|
|
12589
|
+
"commands",
|
|
12590
|
+
"hardis",
|
|
12591
|
+
"project",
|
|
12592
|
+
"fix",
|
|
12593
|
+
"v53flexipages.js"
|
|
12594
|
+
],
|
|
12595
|
+
"aliasPermutations": [],
|
|
12596
|
+
"permutations": [
|
|
12597
|
+
"hardis:project:fix:v53flexipages",
|
|
12598
|
+
"project:hardis:fix:v53flexipages",
|
|
12599
|
+
"project:fix:hardis:v53flexipages",
|
|
12600
|
+
"project:fix:v53flexipages:hardis",
|
|
12601
|
+
"hardis:fix:project:v53flexipages",
|
|
12602
|
+
"fix:hardis:project:v53flexipages",
|
|
12603
|
+
"fix:project:hardis:v53flexipages",
|
|
12604
|
+
"fix:project:v53flexipages:hardis",
|
|
12605
|
+
"hardis:fix:v53flexipages:project",
|
|
12606
|
+
"fix:hardis:v53flexipages:project",
|
|
12607
|
+
"fix:v53flexipages:hardis:project",
|
|
12608
|
+
"fix:v53flexipages:project:hardis",
|
|
12609
|
+
"hardis:project:v53flexipages:fix",
|
|
12610
|
+
"project:hardis:v53flexipages:fix",
|
|
12611
|
+
"project:v53flexipages:hardis:fix",
|
|
12612
|
+
"project:v53flexipages:fix:hardis",
|
|
12613
|
+
"hardis:v53flexipages:project:fix",
|
|
12614
|
+
"v53flexipages:hardis:project:fix",
|
|
12615
|
+
"v53flexipages:project:hardis:fix",
|
|
12616
|
+
"v53flexipages:project:fix:hardis",
|
|
12617
|
+
"hardis:v53flexipages:fix:project",
|
|
12618
|
+
"v53flexipages:hardis:fix:project",
|
|
12619
|
+
"v53flexipages:fix:hardis:project",
|
|
12620
|
+
"v53flexipages:fix:project:hardis"
|
|
12621
|
+
]
|
|
12622
|
+
},
|
|
12623
12623
|
"hardis:project:generate:bypass": {
|
|
12624
12624
|
"aliases": [],
|
|
12625
12625
|
"args": {},
|
|
@@ -15102,5 +15102,5 @@
|
|
|
15102
15102
|
]
|
|
15103
15103
|
}
|
|
15104
15104
|
},
|
|
15105
|
-
"version": "6.0.7-
|
|
15105
|
+
"version": "6.0.7-beta202508231327.0"
|
|
15106
15106
|
}
|