forked from dxatscale/sfpowerkit
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.md
1061 lines (732 loc) · 56.5 KB
/
README.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# sfpowerkit
[](https://www.npmjs.com/package/sfpowerkit)  [](https://dev.azure.com/cloudfirstanz/SFPowerkit/_build/latest?definitionId=5) [](https://greenkeeper.io/)
A Salesforce DX Plugin with multiple functionalities aimed at improving development and operational workflows
Read the blog here https://accenture.github.io/blog/2019/06/27/sfpowerkit.html
## Installation
To install the stable version from the release branch, use the following command
```
$ sfdx plugins:install sfpowerkit
```
If you need to install automatically the plugin, via a CI process or Dockerfile, use the following line:
```
$ echo 'y' | sfdx plugins:install sfpowerkit
```
Beta versions are the latest versions that are in being reviewed/ undergoing testing etc and built from the master branch and can be downloaded using the following command
```
$ sfdx plugins:install sfpowerkit@beta
```
To review a pull request (for contributors/reviewers), the best option is to clone the repository, checkout to the particular branch and utilize the following command from the project directory
```
$ sfdx plugins:link
```
## Source Related Functionalities
These commands manipulate the metadata configuration/code locally or during the packaging process.
## `sfpowerkit:source:pmd`
This command is a wrapper around PMD ( downloads PMD for the first time) with some predefined defaults, such as ruleset, output format, output file. The command is to be run from the project directory
```
USAGE
$ sfdx sfpowerkit:source:pmd [-d <string>] [-r <string>] [-f <string>] [-o <string>] [--javahome <string>] [--supressoutput] [--version <string> [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-d, --directory=directory [default: Default project directory as mentioned in sfdx-project.json ] Override this to set a different directory in the project folder
-f, --format=format [default: text] The format for the pmd output, Possible values are available at https://pmd.github.io/latest/pmd_userdocs_cli_reference.html#available-report-formats
-o, --report=report [default: pmd-output] The path to where the output of the analysis should be written
-r, --ruleset=ruleset [default: [sfpowerkit](https://github.com/Accenture/sfpowerkit/blob/master/resources/pmd-ruleset.xml)] The pmd ruleset that will be utilzied for analyzing the apex classes, Checkout https://pmd.github.io/pmd_userdocs_making_rulesets.html to create your own ruleset
--javahome=javahome The command will try to locate the javahome path to execute PMD automatically, set this flag to override it to another javahome path
--supressoutput [default: false] Supress the ouptut of the analysis to be displayed in the console
--version=version [default: 6.18.0] [default: 6.18.0] The version of the pmd to be utilized for the analysis, this version will be downloaded to sfpowerkit's cache directory
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for this command invocation
EXAMPLE
$ sfdx sfpowerkit:source:pmd
```
_See code: [src\commands\sfpowerkit\source\pmd.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/source/pmd.ts)_
## `sfpowerkit:source:profile:retrieve [BETA]`
Retrieve profiles from the salesforce org with all its associated permissions. Common use case for this command is to migrate profile changes from a integration environment to other higher environments [overcomes SFDX CLI Profile retrieve issue where it doesnt fetch the full profile unless the entire metadata is present in source], or retrieving profiles from production to lower environments for testing.
This command is of sufficient quality, however proceed with caution while adopting in your workflow
```
USAGE
$ sfdx sfpowerkit:source:profile:retrieve [-f <array>] [-n <array>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-f, --folder=folder retrieve only updated versions of profiles found in this directory, If ignored, all profiles will be retrieved.
-n, --profilelist=profilelist comma separated list of profiles to be retrieved. Use it for selectively retrieving an existing profile or retrieving a new profile
-d, --delete set this flag to delete profile files that does not exist in the org, when retrieving in bulk
-u, --targetusername=targetusername username or alias for the target org; overrides default target org
--apiversion=apiversion override the api version used for api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for this command invocation
EXAMPLES
$ sfdx sfpowerkit:source:profile:retrieve -u prod
$ sfdx sfpowerkit:source:profile:retrieve -f force-app -n "My Profile" -u prod
$ sfdx sfpowerkit:source:profile:retrieve -f "module1, module2, module3" -n "My Profile1, My profile2" -u prod
```
_See code: [src\commands\sfpowerkit\profile\retrieve.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/profile/retrieve.ts)_
## `sfpowerkit:source:profile:reconcile`
This command is used in the lower environments such as ScratchOrgs , Development / System Testing Sandboxes, where a retrieved profile from production has to be cleaned up only for the metadata that is contained in the environment or base it only as per the metadata that is contained in the packaging directory.
Please read more about the command especially for ignoring user permissions [here](https://github.com/Accenture/sfpowerkit/wiki/Profile-Reconcile-:-Ignore-User-Permissions)
```
USAGE
$ sfdx sfpowerkit:source:profile:reconcile [-f <array>] [-n <array>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-f, --folder=folder path to the project folder, if the profiles are reconciled in source only mode
-d, --destfolder=destfolder the destination folder for reconciled profiles, if omitted existing profiles will be reconciled and will be rewritten in the current location
-n, --profilelist=profilelist list of profiles to be reconciled. If ommited, all the profiles components will be reconciled.
-s, --sourceonly set this flag to reconcile profiles only against component available in the project only. Configure ignored perissions in sfdx-project.json file in the array plugins->sfpowerkit->ignoredPermissions.
-u, --targetorg=targetorg org against which profiles will be reconciled. this parameter can be ommited if sourceonly flag is used.
--apiversion=apiversion override the api version used for api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for this command invocation
EXAMPLES
$ sfdx sfpowerkit:source:profile:reconcile --folder force-app -d destfolder -s
$ sfdx sfpowerkit:source:profile:reconcile --folder force-app,module2,module3 -u sandbox -d destfolder
$ sfdx sfpowerkit:source:profile:reconcile -u myscratchorg -d destfolder
```
_See code: [src\commands\sfpowerkit\profile\reconcile.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/profile/reconcile.ts)_
## `sfpowerkit:source:profile:merge [BETA]`
This command is used in the lower environments such as ScratchOrgs , Development / System Testing Sandboxes, inorder to apply the changes made in the environment to retrieved profile, so that it can be deployed to the higher environments
This command is of sufficient quality, however proceed with caution while adopting in your workflow
```
USAGE
$ sfdx sfpowerkit:source:profile:merge [-f <array>] [-n <array>] [-m <array>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-f, --folder=folder path to the folder which contains the profiles to be merged,if project contain multiple package directories, please provide a comma seperated list, if omitted, all the package directories will be checked for profiles
-m, --metadata=metadata comma separated list of metadata for which the permissions will be retrieved.
-n, --profilelist=profilelist comma separated list of profiles. If ommited, all the profiles found in the folder(s) will be merged
-d, --delete set this flag to delete profile files that does not exist in the org.
-u, --targetusername=targetusername username or alias for the target org; overrides default target org
--apiversion=apiversion override the api version used for api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for this command invocation
EXAMPLES
$ sfdx sfpowerkit:source:profile:merge -u sandbox
$ sfdx sfpowerkit:source:profile:merge -f force-app -n "My Profile" -r -u sandbox
$ sfdx sfpowerkit:source:profile:merge -f "module1, module2, module3" -n "My Profile1, My profile2" -u sandbox
```
_See code: [src\commands\sfpowerkit\profile\merge.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/profile/merge.ts)_
## `sfpowerkit:source:customlabel:create`
Custom Labels are org wide, hence when the metadata is pulled down from scratch org, the entire custom label metadata file is pulled down in a package repo. This results in often packaging failures, when developers forget to clean the customlabels only to contain what the package needs, as unlocked package does not support duplicate items.The custom labels has to be then cleaned up per package.
This command is a helper command to create customlabel with pacakage names prepended for easy reconcilation.
```
USAGE
$ sfdx sfpowerkit:source:customlabel:create -n <string> -v <string> -s <string> [-c <string>] [-l <string>] [-p <string>] [-i] [-u <string>]
[--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-c, --categories=categories Comma Separated Category Values
-l, --language=language Language of the custom label (Default: en_US)
-n, --fullname=fullname (required) Name of the custom label (API Name)
-p, --protected=protected Protected State of the custom label (Default: false)
-s, --shortdescription=shortdescription (required) Short Description of the custom label
-u, --targetusername=targetusername username or alias for the target org; overrides default
target org
-v, --value=value (required) Value of the custom label
--package Name of the package that needs to be appended, omit this if ignore namespace is used
-i, --ignorepackage Ignores the addition of the namespace into the fullname
(API Name)
--apiversion=apiversion override the api version used for api requests made by this
command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for this command invocation
EXAMPLE
$ sfdx sfpowerkit:source:customlabel:create -u fancyScratchOrg1 -n FlashError -v "Memory leaks aren't for the faint hearted" -s "A flashing
error" --package core
Created CustomLabel FlashError in target org with core_ prefix, You may now pull and utilize the customlabel:reconcile command
```
## `sfpowerkit:source:customlabel:reconcile`
Custom Labels are org wide, hence when the metadata is pulled down from scratch org, the entire custom label metadata file is pulled down in a package repo. This results in often packaging failures, when developers forget to clean the customlabels only to contain what the package needs, as unlocked package does not support duplicate items.The custom labels has to be then cleaned up per package.
This command reconcile the updated custom labels to include only the labels that have the API name starting with package name (packagename\_ ) or created using the custom label create command
```
USAGE
$ sfdx sfpowerkit:source:customlabel:reconcile -d <string> -p <string> [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-d, --path=path (required) Path to the CustomLabels.labels-meta.xml file
-p, --package (required) Name of the package
--apiversion=apiversion override the api version used for api requests made by this
command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for this command invocation
EXAMPLE
$ sfdx sfpowerkit:source:customlabel:reconcile -p path/to/customlabelfile.xml -d core
Package ::: core
Reconciled The Custom Labels, only to have core labels (labels with full name beginning with core_)
``
```
## `sfpowerkit:source:apextestsuite:convert`
Converts an apex test suite to its consituent apex classes as a single line separated by commas, so that it can be used along with metadata validate only deployment
```
USAGE
$ sfdx sfpowerkit:source:apextestsuite:convert -n <string> [ -p <string> ] [ -o <string> ] [--json] [--loglevel trace|debug|info|warn|error|fatal]
OPTIONS
-n, --name=name (required) the name of the apextestsuite (the file name minus the apex test suite)
-p, --package=package [default:picks up the default package] The package where the apex test suite exists
-o, --pathoverride=pathoverride [default:/main/default] Use this if your path to test suite is in a different folder location
within the package directory
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this command invocation
EXAMPLE
$ sfdx sfpowerkit:source:apextestsuite:convert -n MyApexTestSuite
"ABC2,ABC1Test"
```
## `sfpowerkit:project:diff [BETA]`
Generate a delta 'changeset' between two diff commits so that the incremental changes can be deployed to the target org.To be used for an org based deployment when the size of the metadata is large that the project cannot not be deployed in a single attempt.
This command works with a source format based repository only. Utilize the command during a transition phase where an org is transformed to a modular architecture composing of multiple projects.
This command is of sufficient quality, however proceed with caution while adopting in your workflow
```
USAGE
$ sfdx sfpowerkit:project:diff -d <string> [-r <string>] [-t <string>] [-x] [-b <array>] [-p <array>] [--apiversion <string>] [--json]
[--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-b, --bypass=bypass list of path to ignore, if diff found on the repo
-d, --output=output (required) The output dir where the incremental project will be created
-p, --packagedirectories=packagedirectories project paths to run diff, if this is passed then override the path in sfdx-project.json
-r, --revisionfrom=revisionfrom Base revision from where diff is to be generated, required if diff file is ommited
-t, --revisionto=revisionto [default:HEAD] Target revision to generate the diff
-x, --generatedestructive If set to true, the command will also generate a destructiveChangePost.xml file in the
output folder.
--apiversion=apiversion override the api version used for api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: info] logging level for this command invocation
EXAMPLE
$ sfdx sfpowerkit:project:diff --revisionfrom revisionfrom --revisionto revisionto --output OutputFolder
```
## `sfpowerkit:project:orgdiff [BETA]`
Compare source files of a project against the salesforce org and display differences. The command also add diff conflict markers in changed files to let the developer accept or reject changes manually using a git merge tool. The idea behind this command is used to track changes done on an unlocked package or a modular repo against the changes done in a higher environment. This command is not yet ready to work on a single repo against the whole metadata in the org
This command is of sufficient quality, however proceed with caution while adopting in your workflow
```
USAGE
$ sfdx sfpowerkit:project:orgdiff -f <array> [-c] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-c, --noconflictmarkers If set to true, the command will not add diff conflict marker to each compared file.
-f, --filesorfolders=filesorfolders (required) List of fils or folder to compare. Should be only Apex classes, trigger, Aura Components, Lightning Web Components or any unsplitted metadata.
-u, --targetusername=targetusername username or alias for the target org; overrides default target org
--apiversion=apiversion override the api version used for api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: info] logging level for this command invocation
EXAMPLE
$ sfdx sfpowerkit:project:orgdiff --folder directory --noconflictmarkers --targetusername sandbox
$ sfdx sfpowerkit:project:orgdiff --filename fileName --targetusername sandbox
```
## Unlocked Package Related Functionalities
Various helper commands in aiding with Salesforce DX Unlocked Package Development
## `sfpowerkit:package:dependencies:install`
Install unlocked package dependencies of a package
```
USAGE
$ sfdx sfpowerkit:package:dependencies:install [-p <string>] [-k <string>] [-b <string>] [-w <string>] [-r] [-v
<string>] [-a] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]
OPTIONS
-b, --branch=branch the package version’s branch
-k, --installationkeys=installationkeys installation key for key-protected packages (format is
1:MyPackage1Key 2: 3:MyPackage3Key... to allow some packages without
installation key)
-p, --individualpackage=individualpackage Installs a specific package especially for upgrade scenario
-r, --noprompt allow Remote Site Settings and Content Security Policy websites to
send or receive data without confirmation
-u, --targetusername=targetusername username or alias for the target org; overrides default target org
-v, --targetdevhubusername=targetdevhubusername username or alias for the dev hub org; overrides default dev hub org
-w, --wait=wait number of minutes to wait for installation status (also used for
publishwait). Default is 10
-a, --apexcompileonlypackage=apexcompileonlypackage Compile the apex only in the package, by default only the
compilation of the apex in the entire org is triggered
--apiversion=apiversion override the api version used for api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this command invocation
EXAMPLE
$ sfpowerkit package:dependencies:install -u MyScratchOrg -v MyDevHub -k "1:MyPackage1Key 2: 3:MyPackage3Key" -b "DEV"
```
_See code: [src\commands\sfpowerkit\package\dependencies\install.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/package/dependencies/install.ts)_
## `sfpowerkit:source:picklist:generatepatch [DEPRECATED]`
This command generates a patch in the format of a metadata packed together as a static resource with the intent of solving the following issues.
1. Changes to picklist values are not updated in the target org through a unlocked package upgrade.
2. Standard Value are non packageable, hence any picklist that has a modified standardvalueset as the controlling field will fail to package, The optional fixstandardvalueset flag will strip of the controlling field and puts the original code into the patch
3. Fix for business process and recordtype, that depend on a modified standard valueset and fail to package.
These command is to be run just before the package:version: create command and any changes made by the command should not be committed to the repo. Once a patch is generated and the package is installed in the target org, run the apply patch command tofix the above issues.
This command is now deprecated and will be removed shortly, please use standard methods.
```
USAGE
$ sfdx sfpowerkit:source:picklist:generatepatch [-p <string>] [-d <string>] [-f <boolean>] [-r <boolean>]
OPTIONS
-d, --objectsdir=objectsdir Path for Objects folder located in project
-p, --package=package Name of the package to generate the picklist
patch
-f, --fixstandardvalueset Consider patching for standard value set controlled picklists, Warning: This modifies the source code in your package by removing references to standardvalueset from the particular picklist.
-m. --mmovestandardvalueset Consider patching for standard valueset inside source repo, Warning: This modifies the source code in your package
-r, --fixrecordtypes Consider patching for standard value set in RecordTypes, Warning: This modifies the source code in your package
--apiversion=apiversion The api version to be used for the static resource to be generated
EXAMPLE
sfdx sfpowerkit:source:picklist:generatepatch -p sfpowerkit_test -d force-app/main/default/objects/ -f
Scanning for fields of type picklist
Found 2 fields of type picklist
Processing and adding the following fields to patch
Copied Original to Patch: force-app\main\default\objects\Case\fields\test_standard2__c.field-meta.xml
Modified Original in Packaging: force-app\main\default\objects\Case\fields\test_standard2__c.field-meta.xml
Copied Original to Patch: force-app\main\default\objects\Case\fields\test_standard__c.field-meta.xml
Added 2 fields of field type picklist into patch after'removing fields picklist fields in cmdt objects
Added 1 fields of field type picklist that have standard value sets as controlling types
Source was successfully converted to Metadata API format and written to the location: C:\Projects\sfpowerkit_test\temp_sfpowerkit\mdapi
Generating static resource file : force-app/main/default/staticresources/sfpowerkit_test_picklist.resource-meta.xml
Patch sfpowerkit_test_picklist generated successfully.
```
_See code: [src\commands\sfpowerkit\source\picklist\generatepatch.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/source/picklist/generatepatch.ts)_
## `sfpowerkit:source:permissionset:generatepatch [DEPRECATED]`
Search permissionsets inside project and create a static resource file with permissionsets, used to solve the recordtype assignment upgrade issue in dx unlock package.
This command is now deprecated and will be removed shortly, please use standard methods. refer https://success.salesforce.com/issues_view?id=a1p3A0000003UjTQAU for more information.
```
USAGE
$ sfdx sfpowerkit:source:permissionset:generatepatch [-p <string>] [-d <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-d, --permsetdir=permsetdir Path for permissionset folder located in project
-p, --package=package Name of the package to generate the permissionset patch
--apiversion=apiversion The api version to be used for the static resource to be generated
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for this command invocation
EXAMPLE
$ sfdx sfpowerkit:source:permissionset:generatepatch -p Core -d src/core/main/default/permissionsets
Scanning for permissionsets
Found 30 permissionsets
Source was successfully converted to Metadata API format and written to the location: .../temp_sfpowerkit/mdapi
Generating static resource file : src/core/main/default/staticresources/Core_permissionsets.resource-meta.xml
Patch Core_permissionsets generated successfully.
```
_See code: [src\commands\sfpowerkit\source\permissionset\generatepatch.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/source/permissionset/generatepatch.ts)_
## `sfpowerkit:package:applypatch`
Retrieves and applies the patch, This command is exclusively used to apply the patched created by the generatepatch command, see source: picklist:generatepatch and source:permissionset:generatepatch. The command will download the static reource (collection of patched metadata) from the target org, unzips and apply to the target org using mdapi
```
USAGE
$ sfdx sfpowerkit:package:applypatch -n <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-n, --name=name (required) Name of the static resource to be patched
-u, --targetusername=targetusername username or alias for the target org; overrides default target org
--apiversion=apiversion override the api version used for api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for this command invocation
EXAMPLE
$ sfdx sfpowerkit:package:applypatch -n customer_picklist -u sandbox
Preparing Patch
Deploying Patch with ID 0Af4Y000003Q7GySAK
Polling for Deployment Status
Polling for Deployment Status
Patch customer_picklist Deployed successfully.
```
_See code: [src\commands\sfpowerkit\package\applypatch.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/package/applypatch.ts)_
## `sfpowerkit:package:version:codecoverage`
This command is used to get the apex test coverage details of an unlocked package
```
USAGE
$ sfdx sfpowerkit:package:version:codecoverage [-p <string>] [-n <string>] [-i <array>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-i, --versionid=versionid Package version Id to check the code coverage
-n, --versionnumber=versionnumber The complete version number format is major.minor.patch (Beta build)—for example, 1.2.0 (Beta 5), packageName is required when
packageVersionNumber is used
-p, --package=package Name of the unlocked package to check the code coverage, packageVersionNumber is required when packageName is used
-u, --targetusername=targetusername username or alias for the target org; overrides default target org
--apiversion=apiversion API version
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: info] [default: info] logging level for this command invocation
EXAMPLE
$ sfdx sfpowerkit:package:version:codecoverage -u [email protected] -i 04tXXXXXXXXXXXXXXX
$ sfdx sfpowerkit:package:version:codecoverage -u [email protected] -i 04tXXXXXXXXXXXXXXX,04tXXXXXXXXXXXXXXX,04tXXXXXXXXXXXXXXX
$ sfdx sfpowerkit:package:version:codecoverage -u [email protected] -p core -n 1.2.0.45
$ sfdx sfpowerkit:package:version:codecoverage -u [email protected] -p 0HoXXXXXXXXXXXXXXX -n 1.2.0.45
```
_See code: [src\commands\sfpowerkit\package\version\codecoverage.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/package/version/codecoverage.ts)_
## `sfpowerkit:package:valid`
Validates a package directory to check whether it only contains valid metadata as per metadata coverage
```
USAGE
$ sfdx sfpowerkit:package:valid [-n <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]
OPTIONS
-b, --bypass=bypass metadatatypes to skip the package validation check
-n, --package=package the package to analyze
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this command invocation
EXAMPLE
$ sfdx sfpowerkit:package:valid -n testPackage -b sharingrules,sharingownerrule
Now analyzing testPackage
Converting package testPackage
Source was successfully converted to Metadata API format and written to the location:
D:projects estPackage emp_sfpowerkitmdapi
Elements supported included in your package testPackage are
AuraDefinitionBundle
CustomApplication
ApexClass
ContentAsset
WorkflowRule
--------------------------------------------------------------------------------
Unsupported elements to bypass in your package sample are
sharingrules
sharingownerrule
--------------------------------------------------------------------------------
```
_See code: [src\commands\sfpowerkit\package\valid.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/package/valid.ts)_
## Org Related Functionalities
These commands are helpful in managing functionalities are related to a Salesforce Org
## `sfpowerkit org:destruct`
This is a helper command to ease the deployment of destructiveChanges.xml. The command will create the empty package.xml and package the passed destructive manifest and deploy it to the org
```
USAGE
$ sfdx sfpowerkit:org:destruct -m <filepath> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]
OPTIONS
-m, --manifest (required) The path to xml containing the members that need to be destructed,follow the instructions here to create such a file [here](https://developer.salesforce.com/docs/atlas.en-us.daas.meta/daas/daas_destructive_changes.htm)
-u, --targetusername=targetusername username or alias for the target org; overrides default target org
--apiversion=apiversion override the api version used for api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal) [default: info] logging level for this command invocation
EXAMPLE
$ sfdx sfpowerkit:org:destruct -u [email protected] -m destructiveChanges.xml
```
_See code: [src\commands\sfpowerkit\org\destruct.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/org/destruct.ts)_
## `sfpowerkit org:connectedapp:create`
Creates a connected app in the target org for JWT based authentication, Please note it only creates Connected App with All users may self authorize option, You would need to manually edit the policies to enable admin users are pre-approved and add your profile to this connected app. API, Web and RefreshToken Scope are added to every app that is being created.
```
USAGE
$ sfdx sfpowerkit:org:connectedapp:create -n <string> -c <filepath> -e <email> [-u <string>] [--apiversion
<string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]
OPTIONS
-c, --pathtocertificate=pathtocertificate (required) Filepath to the private certificate for the connected app
to be created
-e, --email=email (required) Email of the connected app to be created
-n, --name=name (required) Name of the connected app to be created
-u, --targetusername=targetusername username or alias for the target org; overrides default target org
--apiversion=apiversion override the api version used for api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this command invocation
EXAMPLE
$ sfdx sfpowerkit:org:connectedapp:create -u [email protected] -n AzurePipelines -c id_rsa -e
Created Connected App AzurePipelines in Target Org
```
_See code: [src\commands\sfpowerkit\org\connectedapp\create.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/org/connectedapp/create.ts)_
## `sfpowerkit org:connectedapp:retrieve`
Useful if you want to retreive a connected app key especially in CI/CD system after a sandbox refresh. Use the auth command to login to the sandbox and then use this command. Use JSON format if you want to retrieve the entire metadata of the connected app, Without the json flag, it only displays the key
```
USAGE
$ sfdx sfpowerkit:org:connectedapp:retrieve -n <string> -u <string> [-r <url>] [--json] [--loglevel trace|debug|info|warn|error|fatal]
OPTIONS
-n, --name=name (required) Name of the connected app to be
retreived
-u, --targetusername=targetusername username or alias for the target org; overrides default target org
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this
command invocation
EXAMPLE
$ sfdx sfpowerkit:org:connectedapp:retrieve -u [email protected] -p Xasdax2w2 -n
AzurePipelines
Retrived AzurePipelines Consumer Key : XSD21Sd23123w21321
```
_See code: [src\commands\sfpowerkit\org\connectedapp\retrieve.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/org/connectedapp/retrieve.ts)_
## `sfpowerkit:org:duplicaterule:deactivate`
Deactivates a duplicate rule in the target org. Deactivate active rules before pushing the changes to the target org
```
USAGE
$ sfdx sfpowerkit:org:duplicaterule:deactivate -n <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-n, --name=name (required) Name of the duplicate rule
-u, --targetusername=targetusername username or alias for the target org; overrides default target org
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this
command invocation
EXAMPLE
$ sfdx sfpowerkit:org:duplicaterule:deactivate -n Account.CRM_Account_Rule_1 -u sandbox
Polling for Retrieval Status
Retrieved Duplicate Rule with label : CRM Account Rule 2
Preparing Deactivation
Deploying Deactivated Rule with ID 0Af4Y000003OdTWSA0
Polling for Deployment Status
Polling for Deployment Status
Duplicate Rule CRM Account Rule 2 deactivated
```
_See code: [src\commands\sfpowerkit\org\duplicaterule\deactivate.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/org/deactivate.ts)_
## `sfpowerkit:org:duplicaterule:activate`
Activates a matching rule in the target org
```
USAGE
$ sfdx sfpowerkit:org:duplicaterule:activate -n <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-n, --name=name (required) Name of the duplicate rule
-u, --targetusername=targetusername username or alias for the target org; overrides default target org
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this
command invocation
EXAMPLE
$ sfdx sfpowerkit:org:duplicaterule:activate -n Account.CRM_Account_Rule_1 -u sandbox
Polling for Retrieval Status
Retrieved Duplicate Rule with label : CRM Account Rule 2
Preparing Activation
Deploying Activated Rule with ID 0Af4Y000003OdTWSA0
Polling for Deployment Status
Polling for Deployment Status
Duplicate Rule CRM Account Rule 2 Activated
```
_See code: [src\commands\sfpowerkit\org\duplicaterule\activate.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/org/activate.ts)_
## `sfpowerkit:org:matchingrule:deactivate`
Deactivates a matching rule in the target org, Please ensure all duplicate rules are deactivated before using this
```
USAGE
$ sfdx sfpowerkit:org:matchingrule:deactivate -n <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-n, --name=name (required) Name of the object
-u, --targetusername=targetusername username or alias for the target org; overrides default target org
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this
command invocation
EXAMPLE
$ sfdx sfpowerkit:org:matchingrule:deactivate -n Account -u sandbox
Polling for Retrieval Status
Retrieved Matching Rule for Object : Account
Preparing Deactivation
Deploying Deactivated Matching Rule with ID 0Af4Y000003OePkSAK
Polling for Deployment Status
Polling for Deployment Status
Matching Rule for Account deactivated
```
_See code: [src\commands\sfpowerkit\org\matchingrule\deactivate.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/org/matchingrule/deactivate.ts)_
## `sfpowerkit:org:matchingrule:activate`
Activates a matching rule in the target org, Please ensure all duplicate rules are activated before using this
```
USAGE
$ sfdx sfpowerkit:org:matchingrule:activate -n <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-n, --name=name (required) Name of the object
-u, --targetusername=targetusername username or alias for the target org; overrides default target org
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this
command invocation
EXAMPLE
$ sfdx sfpowerkit:org:matchingrules:activate -n Account -u sandbox
Polling for Retrieval Status
Retrieved Matching Rule for Object : Account
Preparing Activation
Deploying Activated Rule with ID 0Af4Y000003OdTWSA0
Polling for Deployment Status
Polling for Deployment Status
Matching Rule for Account activated
```
_See code: [src\commands\sfpowerkit\org\matchingrule\activate.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/org/matchingrule/activate.ts)_
## `sfpowerkit:org:trigger:deactivate`
Deactivates a trigger in the target org
```
USAGE
$ sfdx sfpowerkit:org:trigger:deactivate -n <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-n, --name=name (required) Name of the ApexTrigger
-u, --targetusername=targetusername username or alias for the target org; overrides default target org
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this
command invocation
EXAMPLE
$ sfdx sfpowerkit:org:trigger:deactivate -n AccountTrigger -u sandbox
Polling for Retrieval Status
Preparing Deactivation
Deploying Deactivated ApexTrigger with ID 0Af4Y000003Q7GySAK
Polling for Deployment Status
Polling for Deployment Status
ApexTrigger AccountTrigger deactivated
```
_See code: [src\commands\sfpowerkit\org\trigger\deactivate.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/org/trigger/deactivate.ts)_
## `sfpowerkit:org:trigger:activate`
Activates a trigger in the target org
```
USAGE
$ sfdx sfpowerkit:org:trigger:activate -n <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-n, --name=name (required) Name of the ApexTrigger
-u, --targetusername=targetusername username or alias for the target org; overrides default target org
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this
command invocation
EXAMPLE
$ sfdx sfpowerkit:org:trigger:deactivate -n AccountTrigger -u sandbox
Polling for Retrieval Status
Preparing Activation
Deploying Activated ApexTrigger with ID 0Af4Y000003Q7GySAK
Polling for Deployment Status
Polling for Deployment Status
ApexTrigger AccountTrigger Ativated
```
_See code: [src\commands\sfpowerkit\org\trigger\activate.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/org/trigger/activate.ts)_
## `sfpowerkit:org:healthcheck`
Gets the health details of an org against the Salesforce baseline
```
USAGE
$ sfdx sfpowerkit:org:healthcheck [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal]
OPTIONS
-u, --targetusername=targetusername username or alias for the target org; overrides default target org
--apiversion=apiversion override the api version used for api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this command invocation
EXAMPLE
$ sfdx sfpowerkit:org:healthcheck -u [email protected]
Successfully Retrived the healthstatus of the org
```
_See code: [src\commands\sfpowerkit\org\healthcheck.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/org/healthcheck.ts)_
## `sfpowerkit:org:manifest:build [BETA]`
Generate a complete manifest of all the metadata from the specified org. Once the manifest is generated use source:retrieve or mdapi:retrieve to retrieve the metadata.
This command is of sufficient quality, however proceed with caution while adopting in your workflow
```
USAGE
$ sfdx sfpowerkit:org:manifest:build [-q <string>] [-x] [-o <filepath>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]
OPTIONS
-o, --outputfile=outputfile The output path where the manifest file will be created
-q, --quickfilter=quickfilter comma separated values of metadata type, member or file names to be excluded while building the manifest
-u, --targetusername=targetusername username or alias for the target org; overrides default
target org
-x, --excludemanaged exclude managed packages components from the manifest
--apiversion=apiversion override the api version used for api requests made by this
command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for this command invocation
EXAMPLES
$ sfdx sfpowerkit:org:manifest:build --targetusername [email protected] -o package.xml
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">...</Package>
$ sfdx sfpowerkit:org:manifest:build --targetusername [email protected] -o package.xml -q 'ApexClass, CustomObject, Report'
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">...</Package>
```
_See code: [src\commands\sfpowerkit\org\manifest\build.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/org/manifest/build.ts)_
## `sfpowerkit:org:orgcoverage`
Gets the apex tests coverage of an org
```
USAGE
$ sfdx sfpowerkit:org:orgcoverage [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal]
OPTIONS
-u, --targetusername=targetusername username or alias for the target org;
--apiversion=apiversion override the api version used for api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this command invocation
EXAMPLE
$ sfdx sfpowerkit:org:orgcoverage -u [email protected]
Successfully Retrieved the Apex Test Coverage of the org 00D0k000000DmdpEAC
coverage:85
```
_See code: [src\commands\sfpowerkit\org\orgcoverage.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/org/orgcoverage.ts)_
## `sfpowerkit:org:sandbox:create`
Creates a sandbox using the tooling api, ensure the user has the required permissions before using this command
```
USAGE
$ sfdx sfpowerkit:org:sandbox:create -n <string> -d <string> -l <string> [-a <string>] [-f <string>] [-v
<string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]
OPTIONS
-a, --apexclass=apexclass A reference to the ID of an Apex class that runs after each
copy of the sandbox
-d, --description=description (required) Description of the sandbox
-f, --clonefrom=clonefrom A reference to the ID of a SandboxInfo that serves as the
source org for a cloned sandbox.
-l, --licensetype=DEVELOPER|DEVELOPER_PRO|PARTIAL|FULL (required) Type of the sandbox. Valid values are
DEVELOPER,DEVELOPER_PRO,PARTIAL,FULL
-n, --name=name (required) Name of the sandbox
-v, --targetdevhubusername=targetdevhubusername (required) username or alias for the dev hub org; overrides default dev hub org
--apiversion=apiversion override the api version used for api requests made by this
command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this command invocation
EXAMPLE
$ sfdx sfpowerkit:org:sandbox:create -d Testsandbox -l DEVELOPER -n test2 -v [email protected]
Successfully Enqueued Creation of Sandbox
```
_See code: [src\commands\sfpowerkit\org\sandbox\create.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/org/sandbox/create.ts)_
## `sfpowerkit:org:sandbox:info`
Gets the status of a sandbox
```
USAGE
$ sfdx sfpowerkit:org:sandbox:info -n <string> [-s] [-v <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal]
OPTIONS
-n, --name=name (required) Name of the sandbox
-s, --showonlylatest Shows only the latest info of the sandbox record
-v, --targetdevhubusername=targetdevhubusername (required) username or alias for the dev hub org; overrides default dev hub org
--apiversion=apiversion override the api version used for api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this command invocation
EXAMPLE
$ sfdx sfpowerkit:org:sandbox:info -n test2 -u [email protected]
Successfully Enqueued Refresh of Sandbox
```
_See code: [src\commands\sfpowerkit\org\sandbox\info.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/org/sandbox/info.ts)_
## `sfpowerkit:org:sandbox:refresh`
Refresh a sandbox using the tooling api, ensure the user has the required permissions before using this command
```
USAGE
$ sfdx sfpowerkit:org:sandbox:refresh -n <string> [-f <string>] [-v <string>] [--apiversion <string>] [--json]
[--loglevel trace|debug|info|warn|error|fatal]
OPTIONS
-f, --clonefrom=clonefrom A reference to the ID of a SandboxInfo that serves as the source org
for a cloned sandbox.
-n, --name=name (required) Name of the sandbox
-v, --targetdevhubusername=targetdevhubusername (required) username or alias for the dev hub org; overrides default dev hub org
--apiversion=apiversion override the api version used for api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level for this command invocation
EXAMPLE
$ sfdx sfpowerkit:org:sandbox:refresh -n test2 -f sitSandbox -u [email protected]
Successfully Enqueued Refresh of Sandbox
```
_See code: [src\commands\sfpowerkit\org\sandbox\refresh.ts](https://github.com/Accenture/sfpowerkit/blob/master/src/commands/sfpowerkit/org/sandbox/refresh.ts)_
## `sfpowerkit:org:scratchorg:usage`
Gets the active count of scratch org by users in a devhub
```
USAGE
$ sfdx sfpowerkit:org:scratchorg:usage -v <string>
[--loglevel trace|debug|info|warn|error|fatal]
OPTIONS
-v, --targetdevhubusername=targetdevhubusername (required) username or alias for the dev hub org; overrides default dev hub org
EXAMPLE
$ sfdx sfpowerkit:org:scratchorg:usage -v devhub
Active Scratch Orgs Remaining: 42 out of 100
Daily Scratch Orgs Remaining: 171 out of 200
IN_USE SIGNUPEMAIL
───────────────── ─────────────────
Total number of records retrieved: 4.
```