UNPKG

30.4 kBMarkdownView Raw
1sfpowerkit
2==========
3
4[![NPM](https://img.shields.io/npm/v/sfpowerkit.svg)](https://www.npmjs.com/package/sfpowerkit) [![Board Status](https://dev.azure.com/cloudfirstanz/f7a91473-0e1c-490e-b0a0-80f9f8d82c14/c97f3cbd-bd4a-4d08-b123-9ebdd5c7c79f/_apis/work/boardbadge/6d1336f9-991b-4cb5-8cce-4173c4dcdca8?columnOptions=1)](https://dev.azure.com/cloudfirstanz/f7a91473-0e1c-490e-b0a0-80f9f8d82c14/_boards/board/t/c97f3cbd-bd4a-4d08-b123-9ebdd5c7c79f/Microsoft.RequirementCategory) [![Build status](https://dev.azure.com/cloudfirstanz/SFPowerkit/_apis/build/status/SFPowerkit-CI)](https://dev.azure.com/cloudfirstanz/SFPowerkit/_build/latest?definitionId=5)
5
6
7
8Salesforce DevOps Helper Extensions
9
10
11## `sfpowerkit auth:login`
12
13Allows to authenticate against an org using username/password and Security Token. Security Token requirement
14can be removed by ensuring the particular user profile is allowed to connect to Salesforce from different IP
15ranges.
16
17```
18USAGE
19 $ sfdx sfpowerkit:auth:login -u <string> -p <string> [-s <string>] [ -r <url> ] [-a <string>] [--apiversion
20 <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]
21
22OPTIONS
23 -u, --username=username (required) Username of the org
24
25 -e, --email=email (required) Password of the org
26
27 -r, --url=url URL of the org, by default it points to test.salesforce.com
28
29 -s --securitytoken=securitytoken Security Token for this particular user
30
31 -a, --alias=alias alias for the target org
32
33 --apiversion=apiversion override the api version used for api requests made by this command
34
35 --json format output as json
36
37 --loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this command invocation
38
39EXAMPLE
40 $ sfdx sfpowerkit:auth:login -u azlam@sfdc.com -p Xasdax2w2 -a prod
41 Authorized to azlam@sfdc.com
42
43```
44
45
46## `sfpowerkit org:connectedapp:create`
47
48Creates a connected app in the target org for JWT based authentication, Please note it only creates Connected App with All users may self authorize option, You would need to manually edit the policies to enable admin users are pre-approved and add your profile to this connected app. API, Web and RefreshToken Scope are added to every app that is being created.
49
50```
51USAGE
52 $ sfdx sfpowerkit:org:connectedapp:create -n <string> -c <filepath> -e <email> [-u <string>] [--apiversion
53 <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]
54
55OPTIONS
56 -c, --pathtocertificate=pathtocertificate (required) Filepath to the private certificate for the connected app
57 to be created
58
59 -e, --email=email (required) Email of the connected app to be created
60
61 -n, --name=name (required) Name of the connected app to be created
62
63 -u, --targetusername=targetusername username or alias for the target org; overrides default target org
64
65 --apiversion=apiversion override the api version used for api requests made by this command
66
67 --json format output as json
68
69 --loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this command invocation
70
71EXAMPLE
72 $ sfdx sfpowerkit:org:connectedapp:create -u myOrg@example.com -n AzurePipelines -c id_rsa -e
73 azlam.salamm@invalid.com
74 Created Connected App AzurePipelines in Target Org
75```
76
77_See code: [src\commands\sfpowerkit\org\connectedapp\create.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/org/connectedapp/create.ts)_
78
79
80
81## `sfpowerkit org:connectedapp:retrieve`
82
83Useful if you want to retreive a connected app key especially in CI/CD system after a sandbox refresh. Use the auth command to login to the sandbox and then use this command. Use JSON format if you want to retrieve the entire metadata of the connected app, Without the json flag, it only displays the key
84
85```
86USAGE
87 $ sfdx sfpowerkit:org:connectedapp:retrieve -n <string> -u <string> [-r <url>] [--json] [--loglevel trace|debug|info|warn|error|fatal]
88
89OPTIONS
90 -n, --name=name (required) Name of the connected app to be
91 retreived
92 -u, --targetusername=targetusername username or alias for the target org; overrides default target org
93 --json format output as json
94
95 --loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this
96 command invocation
97
98EXAMPLE
99 $ sfdx sfpowerkit:org:connectedapp:retrieve -u azlam@sfdc.com -p Xasdax2w2 -n
100 AzurePipelines
101 Retrived AzurePipelines Consumer Key : XSD21Sd23123w21321
102```
103
104_See code: [src\commands\sfpowerkit\org\connectedapp\retrieve.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/org/connectedapp/retrieve.ts)_
105
106
107## `sfpowerkit:org:duplicaterule:deactivate`
108
109Deactivates a duplicate rule in the target org
110
111```
112USAGE
113 $ sfdx sfpowerkit:org:duplicaterule:deactivate -n <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel
114 trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
115
116OPTIONS
117 -n, --name=name (required) Name of the duplicate rule
118
119 -u, --targetusername=targetusername username or alias for the target org; overrides default target org
120
121 --json format output as json
122
123 --loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this
124 command invocation
125
126EXAMPLE
127 $ sfdx sfpowerkit:org:duplicaterule:deactivate -n Account.CRM_Account_Rule_1 -u sandbox
128 Polling for Retrieval Status
129 Retrieved Duplicate Rule with label : CRM Account Rule 2
130 Preparing Deactivation
131 Deploying Deactivated Rule with ID 0Af4Y000003OdTWSA0
132 Polling for Deployment Status
133 Polling for Deployment Status
134 Duplicate Rule CRM Account Rule 2 deactivated
135```
136
137_See code: [src\commands\sfpowerkit\org\duplicaterule\deactivate.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/org/deactivate.ts)_
138
139## `sfpowerkit:org:matchingrule:deactivate`
140
141Deactivates a matching rule in the target org, Please ensure all duplicate rules are deactivated before using this
142
143```
144USAGE
145 $ sfdx sfpowerkit:org:matchingrule:deactivate -n <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel
146 trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
147
148OPTIONS
149 -n, --name=name (required) Name of the object
150 -u, --targetusername=targetusername username or alias for the target org; overrides default target org
151
152 --json format output as json
153
154 --loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this
155 command invocation
156
157EXAMPLE
158 $ sfdx sfpowerkit:org:matchingrule:deactivate -n Account -u sandbox
159 Polling for Retrieval Status
160 Retrieved Matching Rule for Object : Account
161 Preparing Deactivation
162 Deploying Deactivated Matching Rule with ID 0Af4Y000003OePkSAK
163 Polling for Deployment Status
164 Polling for Deployment Status
165 Matching Rule for Account deactivated
166```
167
168_See code: [src\commands\sfpowerkit\org\matchingrule\deactivate.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/org/matchingrule/deactivate.ts)_
169
170
171## `sfpowerkit:org:orgwideemail:create`
172
173Create organisation wide email address
174
175```
176USAGE
177 $ sfdx sfpowerkit:org:orgwideemail:create -e <email> -n <string> [-p] [-u <string>] [--apiversion <string>] [--json] [--loglevel
178 trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
179
180OPTIONS
181 -e, --address=emailaddress (required) Email Address
182 -n, --displayname=displayname (required) Display name of the org wide email
183 -p, --allprofile (Optional) Specify if the orgwide email is available for all profile
184 -u, --targetusername=targetusername username or alias for the target org; overrides default target org
185
186 --json format output as json
187
188 --loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this
189 command invocation
190
191EXAMPLE
192 $ sfdx sfpowerkit:org:orgwideemail:create -e test@example.com -n TestEmail -p -u sandbox
193 Creating email test@example.com
194 Org wide email created with Id 0D20E00000003wtSAA
195 Run the folowing command to verify it
196 sfdx sfpowerkit:org:orgwideemail:verify -i 0D20E00000003wtSAA -u test-qvoqbs1ofjd0@example.com
197```
198
199_See code: [src\commands\sfpowerkit\org\orgwideemail\create.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/org/orgwideemail/create.ts)_
200
201
202## `sfpowerkit:org:orgwideemail:verify`
203
204Verify organisation wide email address
205
206```
207USAGE
208 $ sfdx sfpowerkit:org:orgwideemail:verify -i <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel
209 trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
210
211OPTIONS
212 -i, --emailid=emailid (required) Org Wide Email Id
213 -u, --targetusername=targetusername username or alias for the target org; overrides default target org
214
215 --json format output as json
216
217 --loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this
218 command invocation
219
220EXAMPLE
221 $ sfdx sfpowerkit:org:orgwideemail:verify -i 0D20E00000003wtSAA -u sandbox
222 Verify email 0D21l0000008QgYCAU
223 Org wide email address verified
224```
225
226_See code: [src\commands\sfpowerkit\org\orgwideemail\verify.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/org/orgwideemail/verify.ts)_
227
228
229## `sfpowerkit:org:trigger:deactivate`
230
231Deactivates a trigger in the target org
232
233```
234USAGE
235 $ sfdx sfpowerkit:org:trigger:deactivate -n <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel
236 trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
237
238OPTIONS
239 -n, --name=name (required) Name of the ApexTrigger
240 -u, --targetusername=targetusername username or alias for the target org; overrides default target org
241
242 --json format output as json
243
244 --loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this
245 command invocation
246
247EXAMPLE
248 $ sfdx sfpowerkit:org:trigger:deactivate -n AccountTrigger -u sandbox
249 Polling for Retrieval Status
250 Preparing Deactivation
251 Deploying Deactivated ApexTrigger with ID 0Af4Y000003Q7GySAK
252 Polling for Deployment Status
253 Polling for Deployment Status
254 ApexTrigger AccountTrigger deactivated
255```
256
257_See code: [src\commands\sfpowerkit\org\trigger\deactivate.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/org/trigger/deactivate.ts)_
258
259## `sfpowerkit:org:trigger:activate`
260
261Activates a trigger in the target org
262
263```
264USAGE
265 $ sfdx sfpowerkit:org:trigger:activate -n <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel
266 trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
267
268OPTIONS
269 -n, --name=name (required) Name of the ApexTrigger
270 -u, --targetusername=targetusername username or alias for the target org; overrides default target org
271
272 --json format output as json
273
274 --loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this
275 command invocation
276
277EXAMPLE
278 $ sfdx sfpowerkit:org:trigger:deactivate -n AccountTrigger -u sandbox
279 Polling for Retrieval Status
280 Preparing Activation
281 Deploying Activated ApexTrigger with ID 0Af4Y000003Q7GySAK
282 Polling for Deployment Status
283 Polling for Deployment Status
284 ApexTrigger AccountTrigger Ativated
285```
286
287_See code: [src\commands\sfpowerkit\org\trigger\activate.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/org/trigger/activate.ts)_
288
289
290
291## `sfpowerkit:org:healthcheck`
292
293Gets the health details of an org against the Salesforce baseline
294
295```
296USAGE
297 $ sfdx sfpowerkit:org:healthcheck [-u <string>] [--apiversion <string>] [--json] [--loglevel
298 trace|debug|info|warn|error|fatal]
299
300OPTIONS
301 -u, --targetusername=targetusername username or alias for the target org; overrides default target org
302 --apiversion=apiversion override the api version used for api requests made by this command
303 --json format output as json
304 --loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this command invocation
305
306EXAMPLE
307 $ sfdx sfpowerkit:org:healthcheck -u myOrg@example.com
308 Successfully Retrived the healthstatus of the org
309```
310
311_See code: [src\commands\sfpowerkit\org\healthcheck.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/org/healthcheck.ts)_
312
313## `sfpowerkit:org:orgcoverage`
314
315Gets the apex tests coverage of an org
316
317```
318USAGE
319 $ sfdx sfpowerkit:org:orgcoverage [-u <string>] [--apiversion <string>] [--json] [--loglevel
320 trace|debug|info|warn|error|fatal]
321
322OPTIONS
323 -u, --targetusername=targetusername username or alias for the target org;
324 --apiversion=apiversion override the api version used for api requests made by this command
325 --json format output as json
326 --loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this command invocation
327
328EXAMPLE
329 $ sfdx sfpowerkit:org:orgcoverage -u myOrg@example.com
330 Successfully Retrieved the Apex Test Coverage of the org 00D0k000000DmdpEAC
331 coverage:85
332```
333
334_See code: [src\commands\sfpowerkit\org\orgcoverage.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/org/orgcoverage.ts)_
335
336
337## `sfpowerkit:org:sandbox:create`
338
339Creates a sandbox using the tooling api, ensure the user has the required permissions before using this command
340
341```
342USAGE
343 $ sfdx sfpowerkit:org:sandbox:create -n <string> -d <string> -l <string> [-a <string>] [-f <string>] [-v
344 <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]
345
346OPTIONS
347 -a, --apexclass=apexclass A reference to the ID of an Apex class that runs after each
348 copy of the sandbox
349
350 -d, --description=description (required) Description of the sandbox
351
352 -f, --clonefrom=clonefrom A reference to the ID of a SandboxInfo that serves as the
353 source org for a cloned sandbox.
354
355 -l, --licensetype=DEVELOPER|DEVELOPER_PRO|PARTIAL|FULL (required) Type of the sandbox. Valid values are
356 DEVELOPER,DEVELOPER_PRO,PARTIAL,FULL
357
358 -n, --name=name (required) Name of the sandbox
359
360 -v, --targetdevhubusername=targetdevhubusername (required) username or alias for the dev hub org; overrides default dev hub org
361
362 --apiversion=apiversion override the api version used for api requests made by this
363 command
364
365 --json format output as json
366
367 --loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this command invocation
368
369EXAMPLE
370 $ sfdx sfpowerkit:org:sandbox:create -d Testsandbox -l DEVELOPER -n test2 -v myOrg@example.com
371 Successfully Enqueued Creation of Sandbox
372```
373
374_See code: [src\commands\sfpowerkit\org\sandbox\create.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/org/sandbox/create.ts)_
375
376## ` sfpowerkit:org:sandbox:info`
377
378Gets the status of a sandbox
379
380```
381USAGE
382 $ sfdx sfpowerkit:org:sandbox:info -n <string> [-s] [-v <string>] [--apiversion <string>] [--json] [--loglevel
383 trace|debug|info|warn|error|fatal]
384
385OPTIONS
386 -n, --name=name (required) Name of the sandbox
387 -s, --showonlylatest Shows only the latest info of the sandbox record
388 -v, --targetdevhubusername=targetdevhubusername (required) username or alias for the dev hub org; overrides default dev hub org
389 --apiversion=apiversion override the api version used for api requests made by this command
390 --json format output as json
391 --loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this command invocation
392
393EXAMPLE
394 $ sfdx sfpowerkit:org:sandbox:info -n test2 -u myOrg@example.com
395 Successfully Enqueued Refresh of Sandbox
396```
397
398_See code: [src\commands\sfpowerkit\org\sandbox\info.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/org/sandbox/info.ts)_
399
400## `sfpowerkit:org:sandbox:refresh`
401
402Refresh a sandbox using the tooling api, ensure the user has the required permissions before using this command
403
404```
405USAGE
406 $ sfdx sfpowerkit:org:sandbox:refresh -n <string> [-f <string>] [-v <string>] [--apiversion <string>] [--json]
407 [--loglevel trace|debug|info|warn|error|fatal]
408
409OPTIONS
410 -f, --clonefrom=clonefrom A reference to the ID of a SandboxInfo that serves as the source org
411 for a cloned sandbox.
412
413 -n, --name=name (required) Name of the sandbox
414
415 -v, --targetdevhubusername=targetdevhubusername (required) username or alias for the dev hub org; overrides default dev hub org
416
417 --apiversion=apiversion override the api version used for api requests made by this command
418
419 --json format output as json
420
421 --loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this command invocation
422
423EXAMPLE
424 $ sfdx sfpowerkit:org:sandbox:refresh -n test2 -f sitSandbox -u myOrg@example.com
425 Successfully Enqueued Refresh of Sandbox
426```
427
428_See code: [src\commands\sfpowerkit\org\sandbox\refresh.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/org/sandbox/refresh.ts)_
429
430
431## `sfpowerkit:org:scratchorg:usage`
432
433Gets the active count of scratch org by users in a devhub
434
435```
436USAGE
437 $ sfdx sfpowerkit:org:scratchorg:usage -v <string>
438 [--loglevel trace|debug|info|warn|error|fatal]
439
440OPTIONS
441 -v, --targetdevhubusername=targetdevhubusername (required) username or alias for the dev hub org; overrides default dev hub org
442
443
444EXAMPLE
445 $ sfdx sfpowerkit:org:scratchorg:usage -v devhub
446 Active Scratch Orgs Remaining: 42 out of 100
447 Daily Scratch Orgs Remaining: 171 out of 200
448
449 IN_USE SIGNUPEMAIL
450 ───────────────── ─────────────────
451 2 XYZ@KYZ.COM
452 2 JFK@KYZ.COM
453 Total number of records retrieved: 4.
454```
455
456_See code: [src\commands\sfpowerkit\org\scratchorg\usage.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/org/scratchorg/usage.ts)_
457
458
459## `sfpowerkit:org:scratchorg:delete`
460
461Delete the scratch org for a paritcular user
462
463```
464USAGE
465 $ sfdx sfpowerkit:org:scratchorg:delete -v <string> -e <string>
466 [--loglevel trace|debug|info|warn|error|fatal]
467
468OPTIONS
469 -v, --targetdevhubusername=targetdevhubusername (required) username or alias for the dev hub org; overrides default dev hub org
470
471 -e, --email=email (required) Email of the user account's whose scratch org to be deleted
472
473
474EXAMPLE
475 $ sfdx sfpowerkit:org:scratchorg:delete -e xyz@kyz.com -v devhub
476 Found Scratch Org Ids for user xyz@kyz.com
477 2AS6F000000XbxVWAS
478 Deleting Scratch Orgs
479 Deleted Scratch Org 2AS6F000000XbxVWAS
480```
481
482_See code: [src\commands\sfpowerkit\org\scratchorg\usage.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/org/scratchorg/usage.ts)_
483
484
485## `sfpowerkit:package:dependencies:install`
486
487Install dependencies of a package
488
489```
490USAGE
491 $ sfdx sfpowerkit:package:dependencies:install [-p <string>] [-k <string>] [-b <string>] [-w <string>] [-r] [-v
492 <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]
493
494OPTIONS
495 -b, --branch=branch the package version’s branch
496
497 -k, --installationkeys=installationkeys installation key for key-protected packages (format is
498 1:MyPackage1Key 2: 3:MyPackage3Key... to allow some packages without
499 installation key)
500
501 -p, --individualpackage=individualpackage Installs a specific package especially for upgrade scenario
502
503 -r, --noprompt allow Remote Site Settings and Content Security Policy websites to
504 send or receive data without confirmation
505
506 -u, --targetusername=targetusername username or alias for the target org; overrides default target org
507
508 -v, --targetdevhubusername=targetdevhubusername username or alias for the dev hub org; overrides default dev hub org
509
510 -w, --wait=wait number of minutes to wait for installation status (also used for
511 publishwait). Default is 10
512
513 --apiversion=apiversion override the api version used for api requests made by this command
514
515 --json format output as json
516
517 --loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this command invocation
518
519EXAMPLE
520 $ sfpowerkit package:dependencies:install -u MyScratchOrg -v MyDevHub -k "1:MyPackage1Key 2: 3:MyPackage3Key" -b "DEV"
521```
522
523_See code: [src\commands\sfpowerkit\package\dependencies\install.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/package/dependencies/install.ts)_
524
525## `sfpowerkit:package:valid`
526
527Validates a package to check whether it only contains valid metadata as per metadata coverage
528
529```
530USAGE
531 $ sfdx sfpowerkit:package:valid [-n <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]
532
533OPTIONS
534 -n, --package=package the package to analyze
535 --json format output as json
536 --loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this command invocation
537
538EXAMPLE
539 $ sfdx sfpowerkit:package:valid -n testPackage
540 Now analyzing inspections
541 Converting package testPackage
542 Source was successfully converted to Metadata API format and written to the location:
543 D:projects estPackage emp_sfpowerkitmdapi
544 Elements supported included in your package testPackage are
545 [
546 "AuraDefinitionBundle",
547 "CustomApplication",
548 "ApexClass",
549 "ContentAsset",
550 "WorkflowRule"
551 ]
552
553```
554_See code: [src\commands\sfpowerkit\package\valid.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/package/valid.ts)_
555
556## `sfpowerkit:source:customlabel:create`
557
558Creates a custom label (with default namespace) with parameters
559```
560
561USAGE
562 $ sfdx sfpowerkit:source:customlabel:create -n <string> -v <string> -s <string> [-c <string>] [-l <string>] [-p <string>] [-i] [-u <string>]
563 [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
564
565OPTIONS
566 -c, --categories=categories Comma Separated Category Values
567
568 -i, --ignorenamespace Ignores the addition of the namespace into the fullname
569 (API Name)
570
571 -l, --language=language Language of the custom label (Default: en_US)
572
573 -n, --fullname=fullname (required) Name of the custom label (API Name)
574
575 -p, --protected=protected Protected State of the custom label (Default: false)
576
577 -s, --shortdescription=shortdescription (required) Short Description of the custom label
578
579 -u, --targetusername=targetusername username or alias for the target org; overrides default
580 target org
581
582 -v, --value=value (required) Value of the custom label
583
584 --apiversion=apiversion override the api version used for api requests made by this
585 command
586
587 --json format output as json
588
589 --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for this command invocation
590
591EXAMPLE
592 $ sfdx sfpowerkit:source:customlabel:create -u fancyScratchOrg1 -n FlashError -v "Memory leaks aren't for the faint hearted" -s "A flashing
593 error"
594 Created CustomLabel FlashError in Target Org
595```
596
597## `sfpowerkit:source:customlabel:clean`
598
599Removes the namespace from the custom labels
600
601```
602USAGE
603 $ sfdx sfpowerkit:source:customlabel:clean -p <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel
604 trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
605
606OPTIONS
607 -p, --path=path (required) Path to the CustomLabels.labels-meta.xml file
608
609 -u, --targetusername=targetusername username or alias for the target org; overrides default
610 target org
611
612 --apiversion=apiversion override the api version used for api requests made by this
613 command
614
615 --json format output as json
616
617 --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for this command invocation
618
619EXAMPLE
620 $ sfdx sfpowerkit:source:customlabel:clean -p path/to/customlabelfile.xml
621 Cleaned The Custom Labels
622``
623```
624
625## `sfpowerkit:source:apextestsuite:convert`
626
627Converts an apex test suite to its consituent apex classes as a single line separated by commas, so that it can be used for metadata api deployment
628
629```
630USAGE
631 $ sfdx sfpowerkit:source:apextestsuite:convert -n <string> [ -p <string> ] [ -o <string> ] [--json] [--loglevel trace|debug|info|warn|error|fatal]
632
633OPTIONS
634 -n, --name=name (required) the name of the apextestsuite (the file name minus the apex test suite)
635 -p, --package=package [default:picks up the default package] The package where the apex test suite exists
636 -o, --pathoverride=pathoverride [default:/main/default] Use this if your path to test suite is in a different folder location
637 within the package directory
638
639 --json format output as json
640 --loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this command invocation
641
642EXAMPLE
643 $ sfdx sfpowerkit:source:apextestsuite:convert -n MyApexTestSuite
644 "ABC2,ABC1Test"
645```
646
647## `sfpowerkit:project:diff`
648
649Generate a subset of the project base on a diff file generated by a git diff --raw command. You can ommit the diff file and provide the revisionFrom and optionally revisionTo insted.
650```
651
652USAGE
653 $ sfdx sfpowerkit:project:diff -d <string> [-f <string>] [ -e <string> ] [ -r <string> ] [ -t <string> ] [--json] [--loglevel trace|debug|info|warn|error|fatal]
654
655OPTIONS
656 -d, --output=output (required) the output dir where the files will be placed
657 -f, --difffile=difffile the diff file generate with the command [git diff --raw] you can skip this parameter and set the revisionfrom and optionally revisionto parameter
658 -e, --encoding=encoding [default:utf8] diff file encoding
659 -r, --revisionfrom=revisionfrom base revision to generate the diff. required if diff file ommited
660 -t, --revisionto=revisionto [default:head]target revision to generate the diff
661
662 --json format output as json
663 --loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this command invocation
664
665EXAMPLE
666 $ sfdx sfpowerkit:project:diff --revisionfrom revisionfrom --revisionto revisionto --output OutputFolder
667 {
668 "status": 0,
669 "result": {
670 "deleted": [],
671 "addedEdited": [
672 "scripts\\Alias.sh",
673 "sfdx-project.json",
674 ]
675 }
676 }
677```
678
679
\No newline at end of file