-
Notifications
You must be signed in to change notification settings - Fork 374
/
Copy pathDotNet.json
2208 lines (2208 loc) · 111 KB
/
DotNet.json
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
{
"$schema": "https://raw.githubusercontent.com/nuke-build/nuke/master/source/Nuke.Tooling.Generator/schema.json",
"references": [
"https://raw.githubusercontent.com/dotnet/docs/main/docs/core/tools/dotnet-test.md",
"https://raw.githubusercontent.com/dotnet/docs/main/docs/core/tools/dotnet-run.md",
"https://raw.githubusercontent.com/dotnet/docs/main/docs/core/tools/dotnet-restore.md",
"https://raw.githubusercontent.com/dotnet/docs/main/docs/core/tools/dotnet-pack.md",
"https://raw.githubusercontent.com/dotnet/docs/main/docs/core/tools/dotnet-build.md",
"https://raw.githubusercontent.com/dotnet/docs/main/docs/core/tools/dotnet-clean.md",
"https://raw.githubusercontent.com/dotnet/docs/main/docs/core/tools/dotnet-publish.md",
"https://raw.githubusercontent.com/dotnet/docs/main/docs/core/tools/dotnet-nuget-push.md",
"https://raw.githubusercontent.com/dotnet/docs/main/docs/core/tools/dotnet-nuget-delete.md",
"https://raw.githubusercontent.com/dotnet/docs/main/docs/core/tools/dotnet-nuget-sign.md",
"https://raw.githubusercontent.com/dotnet/docs/main/docs/core/tools/dotnet-nuget-verify.md",
"https://raw.githubusercontent.com/dotnet/docs/main/docs/core/tools/dotnet-tool-install.md",
"https://raw.githubusercontent.com/dotnet/docs/main/docs/core/tools/dotnet-tool-uninstall.md",
"https://raw.githubusercontent.com/dotnet/docs/main/docs/core/tools/dotnet-tool-update.md",
"https://raw.githubusercontent.com/dotnet/docs/main/docs/core/tools/dotnet-msbuild.md",
"https://raw.githubusercontent.com/dotnet/docs/main/docs/core/tools/dotnet-format.md",
"https://raw.githubusercontent.com/dotnet/docs/main/docs/core/tools/dotnet-workload-install.md",
"https://raw.githubusercontent.com/dotnet/docs/main/docs/core/tools/dotnet-workload-repair.md",
"https://raw.githubusercontent.com/dotnet/docs/main/docs/core/tools/dotnet-workload-restore.md",
"https://raw.githubusercontent.com/dotnet/docs/main/docs/core/tools/dotnet-workload-uninstall.md",
"https://raw.githubusercontent.com/dotnet/docs/main/docs/core/tools/dotnet-workload-update.md"
],
"name": "DotNet",
"officialUrl": "https://docs.microsoft.com/en-us/dotnet/core/tools/",
"pathExecutable": "dotnet",
"customLogger": true,
"tasks": [
{
"help": "The <c>dotnet test</c> command is used to execute unit tests in a given project. Unit tests are console application projects that have dependencies on the unit test framework (for example, MSTest, NUnit, or xUnit) and the dotnet test runner for the unit testing framework. These are packaged as NuGet packages and are restored as ordinary dependencies for the project.",
"postfix": "Test",
"commonPropertySets": [
"restore",
"restore-runtime"
],
"definiteArgument": "test",
"settingsClass": {
"properties": [
{
"name": "ProjectFile",
"type": "string",
"format": "{value}",
"position": 1,
"help": "Specifies a path to the test project. If omitted, it defaults to current directory."
},
{
"name": "TestAdapterPath",
"type": "string",
"format": "--test-adapter-path {value}",
"help": "Use the custom test adapters from the specified path in the test run."
},
{
"name": "Configuration",
"type": "string",
"format": "--configuration {value}",
"help": "Configuration under which to build. The default value is <c>Debug</c>, but your project's configuration could override this default SDK setting."
},
{
"name": "DataCollector",
"type": "string",
"format": "--collect {value}",
"help": "Enables data collector for the test run. For more information, see <a href=\"https://aka.ms/vstest-collect\">Monitor and analyze test run</a>."
},
{
"name": "DiagnosticsFile",
"type": "string",
"format": "--diag {value}",
"help": "Enables diagnostic mode for the test platform and write diagnostic messages to the specified file."
},
{
"name": "Framework",
"type": "string",
"format": "--framework {value}",
"help": "Looks for test binaries for a specific <a href=\"https://docs.microsoft.com/en-us/dotnet/standard/frameworks\">framework</a>."
},
{
"name": "Filter",
"type": "string",
"format": "--filter {value}",
"help": "Filters out tests in the current project using the given expression. For more information, see the <a href=\"https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-test#filter-option-details\">Filter option details</a> section. For additional information and examples on how to use selective unit test filtering, see <a href=\"https://docs.microsoft.com/en-us/dotnet/core/testing/selective-unit-tests\">Running selective unit tests</a>."
},
{
"name": "Loggers",
"type": "List<string>",
"format": "--logger {value}",
"help": "Specifies a logger for test results. Specify the parameter multiple times to enable multiple loggers."
},
{
"name": "NoBuild",
"type": "bool",
"format": "--no-build",
"help": "Does not build the test project prior to running it."
},
{
"name": "NoRestore",
"type": "bool",
"format": "--no-restore",
"help": "Doesn't perform an implicit restore when running the command."
},
{
"name": "Output",
"type": "string",
"format": "--output {value}",
"help": "Directory in which to find the binaries to run."
},
{
"name": "ResultsDirectory",
"type": "string",
"format": "--results-directory {value}",
"help": "The directory where the test results are going to be placed. The specified directory will be created if it doesn't exist."
},
{
"name": "SettingsFile",
"type": "string",
"format": "--settings {value}",
"help": "Settings to use when running tests."
},
{
"name": "ListTests",
"type": "bool",
"format": "--list-tests",
"help": "List all of the discovered tests in the current project."
},
{
"name": "Verbosity",
"type": "DotNetVerbosity",
"format": "--verbosity {value}",
"help": "Sets the verbosity level of the command. Allowed values are <c>q[uiet]</c>, <c>m[inimal]</c>, <c>n[ormal]</c>, <c>d[etailed]</c>, and <c>diag[nostic]</c>."
},
{
"name": "Properties",
"type": "Dictionary<string, object>",
"format": "/property:{key}={value}",
"disallowedCharacter": ";",
"help": "<p>Set or override the specified project-level properties, where name is the property name and value is the property value. Specify each property separately, or use a semicolon or comma to separate multiple properties, as the following example shows:</p><p><c>/property:WarningLevel=2;OutDir=bin\\Debug</c></p>"
},
{
"name": "BlameMode",
"type": "bool",
"format": "--blame",
"help": "Runs the tests in blame mode. This option is helpful in isolating the problematic tests causing test host to crash. It creates an output file in the current directory as <em>Sequence.xml</em> that captures the order of tests execution before the crash."
},
{
"name": "BlameCrash",
"type": "bool",
"format": "--blame-crash",
"help": "<p>Runs the tests in blame mode and collects a crash dump when the test host exits unexpectedly. This option depends on the version of .NET used, the type of error, and the operating system.</p><p>For exceptions in managed code, a dump will be automatically collected on .NET 5.0 and later versions. It will generate a dump for testhost or any child process that also ran on .NET 5.0 and crashed. Crashes in native code will not generate a dump. This option works on Windows, macOS, and Linux.</p><p>Crash dumps in native code, or when using .NET Core 3.1 or earlier versions, can only be collected on Windows, by using Procdump. A directory that contains procdump.exe and procdump64.exe must be in the PATH or PROCDUMP_PATH environment variable. <a href=\"https://docs.microsoft.com/en-us/sysinternals/downloads/procdump\">Download the tools</a>. Implies <em>--blame</em>.</p><p>To collect a crash dump from a native application running on .NET 5.0 or later, the usage of Procdump can be forced by setting the <em>VSTEST_DUMP_FORCEPROCDUMP</em> environment variable to <em>1</em>.</p>"
},
{
"name": "BlameCrashDumpType",
"type": "string",
"format": "--blame-crash-dump-type {value}",
"help": "The type of crash dump to be collected. Implies <em>--blame-crash</em>."
},
{
"name": "BlameCrashCollectAlways",
"type": "bool",
"format": "--blame-crash-collect-always",
"help": "Collects a crash dump on expected as well as unexpected test host exit."
},
{
"name": "BlameHang",
"type": "bool",
"format": "--blame-hang",
"help": "Run the tests in blame mode and collects a hang dump when a test exceeds the given timeout."
},
{
"name": "BlameHangDumpType",
"type": "string",
"format": "--blame-hang-dump-type {value}",
"help": "The type of crash dump to be collected. It should be <em>full</em>, <em>mini</em>, or <em>none</em>. When <em>none</em> is specified, test host is terminated on timeout, but no dump is collected. Implies <em>--blame-hang</em>."
},
{
"name": "BlameHangTimeout",
"type": "string",
"format": "--blame-hang-timeout {value}",
"help": "<p>Per-test timeout, after which a hang dump is triggered and the test host process and all of its child processes are dumped and terminated. The timeout value is specified in one of the following formats:</p><p><ul><li>1.5h, 1.5hour, 1.5hours</li><li>90m, 90min, 90minute, 90minutes</li><li>5400s, 5400sec, 5400second, 5400seconds</li><li>5400000ms, 5400000mil, 5400000millisecond, 5400000milliseconds</li></ul></p><p>When no unit is used (for example, 5400000), the value is assumed to be in milliseconds. When used together with data driven tests, the timeout behavior depends on the test adapter used. For xUnit and NUnit the timeout is renewed after every test case. For MSTest, the timeout is used for all test cases. This option is supported on Windows with netcoreapp2.1 and later, on Linux with netcoreapp3.1 and later, and on macOS with net5.0 or later. Implies <em>--blame</em> and <em>--blame-hang</em>.</p>"
},
{
"name": "RunSettings",
"type": "Dictionary<string, object>",
"format": "-- {key}={value}",
"separator": " ",
"position": -1
},
{
"name": "NoLogo",
"type": "bool",
"format": "--nologo",
"help": "Run test(s), without displaying Microsoft Testplatform banner. Available since .NET Core 3.0 SDK."
},
{
"name": "ArtifactsPath",
"type": "string",
"format": "--artifacts-path {value}",
"help": "All build output files from the executed command will go in subfolders under the specified path, separated by project. For more information see <a href=\"https://learn.microsoft.com/en-us/dotnet/core/sdk/artifacts-output\">Artifacts Output Layout</a>. Available since .NET 8 SDK."
}
]
}
},
{
"help": "<p>The <c>dotnet run</c> command provides a convenient option to run your application from the source code with one command. It's useful for fast iterative development from the command line. The command depends on the <a href=\"https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-build\"><c>dotnet build</c></a> command to build the code. Any requirements for the build, such as that the project must be restored first, apply to <c>dotnet run</c> as well.</p><p>Output files are written into the default location, which is <c>bin/<configuration>/<target></c>. For example if you have a <c>netcoreapp1.0</c> application and you run <c>dotnet run</c>, the output is placed in <c>bin/Debug/netcoreapp1.0</c>. Files are overwritten as needed. Temporary files are placed in the <c>obj</c> directory.</p><p>If the project specifies multiple frameworks, executing <c>dotnet run</c> results in an error unless the <c>-f|--framework <FRAMEWORK></c> option is used to specify the framework.</p><p>The <c>dotnet run</c> command is used in the context of projects, not built assemblies. If you're trying to run a framework-dependent application DLL instead, you must use <a href=\"https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet\">dotnet</a> without a command. For example, to run <c>myapp.dll</c>, use: <c>dotnet myapp.dll</c></p><p>For more information on the <c>dotnet</c> driver, see the <a href=\"https://docs.microsoft.com/en-us/dotnet/core/tools/index\">.NET Core Command Line Tools (CLI)</a> topic.</p><p>In order to run the application, the <c>dotnet run</c> command resolves the dependencies of the application that are outside of the shared runtime from the NuGet cache. Because it uses cached dependencies, it's not recommended to use <c>dotnet run</c> to run applications in production. Instead, <a href=\"https://docs.microsoft.com/en-us/dotnet/core/deploying/index\">create a deployment</a> using the <a href=\"https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-publish\"><c>dotnet publish</c></a> command and deploy the published output.</p>",
"postfix": "Run",
"commonPropertySets": [
"restore",
"restore-runtime"
],
"definiteArgument": "run",
"settingsClass": {
"properties": [
{
"name": "Architecture",
"type": "string",
"format": "--arch {value}",
"help": "Specifies the target architecture. This is a shorthand syntax for setting the <a href=\"https://learn.microsoft.com/en-us/dotnet/core/rid-catalog\">Runtime Identifier (RID)</a>, where the provided value is combined with the default RID. For example, on a win-x64 machine, specifying --arch x86 sets the RID to win-x86. If you use this option, don't use the -r|--runtime option. Available since .NET 6 Preview 7."
},
{
"name": "Configuration",
"type": "string",
"format": "--configuration {value}",
"help": "Configuration to use for building the project. The default value is Debug."
},
{
"name": "DisableBuildServers",
"type": "bool",
"format": "--disable-build-servers",
"help": "Force the command to ignore any persistent build servers. This option provides a consistent way to disable all use of build caching, which forces a build from scratch. A build that doesn't rely on caches is useful when the caches might be corrupted or incorrect for some reason. Available since .NET 7 SDK."
},
{
"name": "Framework",
"type": "string",
"format": "--framework {value}",
"help": "Builds and runs the app using the specified framework. The framework must be specified in the project file."
},
{
"name": "LaunchProfile",
"type": "string",
"format": "--launch-profile {value}",
"help": "The name of the launch profile (if any) to use when launching the application. Launch profiles are defined in the <em>launchSettings.json</em> file and are typically called <c>Development</c>, <c>Staging</c> and <c>Production</c>. For more information, see <a href=\"https://docs.microsoft.com/en-us/aspnetcore/fundamentals/environments\">Working with multiple environments</a>."
},
{
"name": "Interactive",
"type": "bool",
"format": "--interactive",
"help": "Allows the command to stop and wait for user input or action. For example, to complete authentication. Available since .NET Core 3.0 SDK."
},
{
"name": "NoBuild",
"type": "bool",
"format": "--no-build",
"help": "Doesn't build the project before running."
},
{
"name": "NoLaunchProfile",
"type": "bool",
"format": "--no-launch-profile",
"help": "Doesn't attempt to use <em>launchSettings.json</em> to configure the application."
},
{
"name": "NoRestore",
"type": "bool",
"format": "--no-restore",
"help": "Doesn't perform an implicit restore when running the command."
},
{
"name": "NoSelfContained",
"type": "bool",
"format": "--no-self-contained",
"help": "Publish your application as a framework dependent application. A compatible .NET runtime must be installed on the target machine to run your application."
},
{
"name": "OperatingSystem",
"type": "string",
"format": "--os {value}",
"help": "Specifies the target operating system (OS). This is a shorthand syntax for setting the <a href=\"https://learn.microsoft.com/en-us/dotnet/core/rid-catalog\">Runtime Identifier (RID)</a>, where the provided value is combined with the default RID. For example, on a win-x64 machine, specifying --os linux sets the RID to linux-x64. If you use this option, don't use the -r|--runtime option. Available since .NET 6."
},
{
"name": "ProjectFile",
"type": "string",
"format": "--project {value}",
"help": "Specifies the path and name of the project file. (See the NOTE.) It defaults to the current directory if not specified."
},
{
"name": "Runtime",
"type": "string",
"format": "--runtime {value}",
"help": "Specifies the target runtime. For a list of Runtime Identifiers (RIDs), see the <a href=\"https://docs.microsoft.com/en-us/dotnet/core/rid-catalog\">RID catalog</a>."
},
{
"name": "SelfContained",
"type": "bool",
"format": "--self-contained {value}",
"help": "Publishes the .NET runtime with the application so the runtime doesn't need to be installed on the target machine. The default is <c>false</c>. However, when targeting .NET 7 or lower, the default is <c>true</c> if a runtime identifier is specified."
},
{
"name": "Verbosity",
"type": "DotNetVerbosity",
"format": "--verbosity {value}",
"help": "Sets the verbosity level of the command. Allowed values are <c>q[uiet]</c>, <c>m[inimal]</c>, <c>n[ormal]</c>, <c>d[etailed]</c>, and <c>diag[nostic]</c>."
},
{
"name": "ApplicationArguments",
"type": "List<string>",
"format": "-- {value}",
"separator": " ",
"position": -1,
"customValue": true,
"help": "Arguments passed to the application being run."
},
{
"name": "ArtifactsPath",
"type": "string",
"format": "--artifacts-path {value}",
"help": "All build output files from the executed command will go in subfolders under the specified path, separated by project. For more information see <a href=\"https://learn.microsoft.com/en-us/dotnet/core/sdk/artifacts-output\">Artifacts Output Layout</a>. Available since .NET 8 SDK."
}
]
}
},
{
"help": "<p>The <c>dotnet restore</c> command uses NuGet to restore dependencies as well as project-specific tools that are specified in the project file. By default, the restoration of dependencies and tools are performed in parallel.</p><p>Starting with .NET Core 2.0, you don't have to run <a href=\"https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-restore\"><c>dotnet restore</c></a> because it's run implicitly by all commands, such as <c>dotnet build</c> and <c>dotnet run</c>, that require a restore to occur. It's still a valid command in certain scenarios where doing an explicit restore makes sense, such as <a href=\"https://docs.microsoft.com/en-us/vsts/build-release/apps/aspnet/build-aspnet-core\">continuous integration builds in Visual Studio Team Services</a> or in build systems that need to explicitly control the time at which the restore occurs.</p><p>In order to restore the dependencies, NuGet needs the feeds where the packages are located. Feeds are usually provided via the <em>NuGet.config</em> configuration file. A default configuration file is provided when the CLI tools are installed. You specify additional feeds by creating your own <em>NuGet.config</em> file in the project directory. You also specify additional feeds per invocation at a command prompt.</p><p>For dependencies, you specify where the restored packages are placed during the restore operation using the <c>--packages</c> argument. If not specified, the default NuGet package cache is used, which is found in the <c>.nuget/packages</c> directory in the user's home directory on all operating systems (for example, <em>/home/user1</em> on Linux or <em>C:\\Users\\user1</em> on Windows).</p><p>For project-specific tooling, <c>dotnet restore</c> first restores the package in which the tool is packed, and then proceeds to restore the tool's dependencies as specified in its project file.</p><p>The behavior of the <c>dotnet restore</c> command is affected by some of the settings in the <em>Nuget.Config</em> file, if present. For example, setting the <c>globalPackagesFolder</c> in <em>NuGet.Config</em> places the restored NuGet packages in the specified folder. This is an alternative to specifying the <c>--packages</c> option on the <c>dotnet restore</c> command. For more information, see the <a href=\"https://docs.microsoft.com/nuget/schema/nuget-config-file\">NuGet.Config reference</a>.</p>",
"postfix": "Restore",
"commonPropertySets": [
"restore",
"restore-runtime"
],
"definiteArgument": "restore",
"settingsClass": {
"properties": [
{
"name": "ProjectFile",
"type": "string",
"format": "{value}",
"position": 1,
"createOverload": true,
"help": "Optional path to the project file to restore."
},
{
"name": "ConfigFile",
"type": "string",
"format": "--configfile {value}",
"help": "The NuGet configuration file (<em>NuGet.config</em>) to use for the restore operation."
},
{
"name": "Verbosity",
"type": "DotNetVerbosity",
"format": "--verbosity {value}",
"help": "Sets the verbosity level of the command. Allowed values are <c>q[uiet]</c>, <c>m[inimal]</c>, <c>n[ormal]</c>, <c>d[etailed]</c>, and <c>diag[nostic]</c>."
}
]
}
},
{
"help": "<p>The <c>dotnet pack</c> command builds the project and creates NuGet packages. The result of this command is a NuGet package. If the <c>--include-symbols</c> option is present, another package containing the debug symbols is created.</p><p>NuGet dependencies of the packed project are added to the <em>.nuspec</em> file, so they're properly resolved when the package is installed. Project-to-project references aren't packaged inside the project. Currently, you must have a package per project if you have project-to-project dependencies.</p><p>By default, <c>dotnet pack</c> builds the project first. If you wish to avoid this behavior, pass the <c>--no-build</c> option. This is often useful in Continuous Integration (CI) build scenarios where you know the code was previously built.</p><p>You can provide MSBuild properties to the <c>dotnet pack</c> command for the packing process. For more information, see <a href=\"https://docs.microsoft.com/en-us/dotnet/core/tools/csproj#nuget-metadata-properties\">NuGet metadata properties</a> and the <a href=\"https://docs.microsoft.com/en-us/visualstudio/msbuild/msbuild-command-line-reference\">MSBuild Command-Line Reference</a>.</p>",
"postfix": "Pack",
"commonPropertySets": [
"restore",
"restore-runtime"
],
"definiteArgument": "pack",
"settingsClass": {
"properties": [
{
"name": "Project",
"type": "string",
"format": "{value}",
"position": 1,
"createOverload": true,
"help": "The project to pack. It's either a path to a csproj file or to a directory. If omitted, it defaults to the current directory."
},
{
"name": "Configuration",
"type": "string",
"format": "--configuration {value}",
"help": "Configuration to use when building the project. If not specified, configuration defaults to <c>Debug</c>."
},
{
"name": "IncludeSource",
"type": "bool",
"format": "--include-source",
"help": "Includes the source files in the NuGet package. The sources files are included in the <c>src</c> folder within the <c>nupkg</c>."
},
{
"name": "IncludeSymbols",
"type": "bool",
"format": "--include-symbols",
"help": "Generates the symbols <c>nupkg</c>."
},
{
"name": "NoBuild",
"type": "bool",
"format": "--no-build",
"help": "Don't build the project before packing."
},
{
"name": "NoRestore",
"type": "bool",
"format": "--no-restore",
"help": "Doesn't perform an implicit restore when running the command."
},
{
"name": "OutputDirectory",
"type": "string",
"format": "--output {value}",
"help": "Places the built packages in the directory specified."
},
{
"name": "Serviceable",
"type": "bool",
"format": "--serviceable",
"help": "Sets the serviceable flag in the package. For more information, see <a href=\"https://aka.ms/nupkgservicing\">.NET Blog: .NET 4.5.1 Supports Microsoft Security Updates for .NET NuGet Libraries</a>."
},
{
"name": "Verbosity",
"type": "DotNetVerbosity",
"format": "--verbosity {value}",
"help": "Sets the verbosity level of the command. Allowed values are <c>q[uiet]</c>, <c>m[inimal]</c>, <c>n[ormal]</c>, <c>d[etailed]</c>, and <c>diag[nostic]</c>."
},
{
"name": "VersionSuffix",
"type": "string",
"format": "--version-suffix {value}",
"help": "Defines the value for the <c>$(VersionSuffix)</c> MSBuild property in the project."
},
{
"name": "NoLogo",
"type": "bool",
"format": "--nologo",
"help": "Doesn't display the startup banner or the copyright message. Available since .NET Core 3.0 SDK."
},
{
"name": "ArtifactsPath",
"type": "string",
"format": "--artifacts-path {value}",
"help": "All build output files from the executed command will go in subfolders under the specified path, separated by project. For more information see <a href=\"https://learn.microsoft.com/en-us/dotnet/core/sdk/artifacts-output\">Artifacts Output Layout</a>. Available since .NET 8 SDK."
}
]
}
},
{
"help": "<p>The <c>dotnet build</c> command builds the project and its dependencies into a set of binaries. The binaries include the project's code in Intermediate Language (IL) files with a <em>.dll</em> extension and symbol files used for debugging with a <em>.pdb</em> extension. A dependencies JSON file (<em>*.deps.json</em>) is produced that lists the dependencies of the application. A <em>.runtimeconfig.json</em> file is produced, which specifies the shared runtime and its version for the application.</p><p>If the project has third-party dependencies, such as libraries from NuGet, they're resolved from the NuGet cache and aren't available with the project's built output. With that in mind, the product of <c>dotnet build</c>d isn't ready to be transferred to another machine to run. This is in contrast to the behavior of the .NET Framework in which building an executable project (an application) produces output that's runnable on any machine where the .NET Framework is installed. To have a similar experience with .NET Core, you use the <a href=\"https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-publish\"><c>dotnet publish</c></a> command. For more information, see <a href=\"https://docs.microsoft.com/en-us/dotnet/core/deploying/index\">.NET Core Application Deployment</a>.</p><p>Building requires the <em>project.assets.json</em> file, which lists the dependencies of your application. The file is created <a href=\"https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-restore\"><c>dotnet restore</c></a> is executed. Without the assets file in place, the tooling cannot resolve reference assemblies, which will result in errors. With .NET Core 1.x SDK, you needed to explicitily run the <c>dotnet restore</c> before running <c>dotnet build</c>. Starting with .NET Core 2.0 SDK, <c>dotnet restore</c> runs implicitily when you run <c>dotnet build</c>. If you want to disable implicit restore when running the build command, you can pass the <c>--no-restore</c> option.</p><p><c>dotnet build</c> uses MSBuild to build the project; thus, it supports both parallel and incremental builds. Refer to <a href=\"https://docs.microsoft.com/visualstudio/msbuild/incremental-builds\">Incremental Builds</a> for more information.</p><p>In addition to its options, the <c>dotnet build</c> command accepts MSBuild options, such as <c>/p</c> for setting properties or <c>/l</c> to define a logger. Learn more about these options in the <a href=\"https://docs.microsoft.com/visualstudio/msbuild/msbuild-command-line-reference\">MSBuild Command-Line Reference</a>.</p>",
"postfix": "Build",
"commonPropertySets": [
"restore"
],
"definiteArgument": "build",
"settingsClass": {
"properties": [
{
"name": "ProjectFile",
"type": "string",
"format": "{value}",
"position": 1,
"createOverload": true,
"help": "The project file to build. If a project file is not specified, MSBuild searches the current working directory for a file that has a file extension that ends in proj and uses that file."
},
{
"name": "Configuration",
"type": "string",
"format": "--configuration {value}",
"help": "Defines the build configuration. If omitted, the build configuration defaults to <c>Debug</c>. Use <c>Release</c> build a Release configuration."
},
{
"name": "Framework",
"type": "string",
"format": "--framework {value}",
"help": "Compiles for a specific <a href=\"https://docs.microsoft.com/en-us/dotnet/standard/frameworks\">framework</a>. The framework must be defined in the <a href=\"https://docs.microsoft.com/en-us/dotnet/core/tools/csproj\">project file</a>."
},
{
"name": "NoIncremental",
"type": "bool",
"format": "--no-incremental",
"help": "Marks the build as unsafe for incremental build. This turns off incremental compilation and forces a clean rebuild of the project's dependency graph."
},
{
"name": "NoRestore",
"type": "bool",
"format": "--no-restore",
"help": "Doesn't perform an implicit restore during build."
},
{
"name": "OutputDirectory",
"type": "string",
"format": "--output {value}",
"help": "Directory in which to place the built binaries. You also need to define <c>--framework</c> when you specify this option."
},
{
"name": "SelfContained",
"type": "bool",
"format": "--self-contained {value}",
"help": "Publishes the .NET runtime with the application so the runtime doesn't need to be installed on the target machine. The default is <c>true</c> if a runtime identifier is specified. Available since .NET 6 SDK"
},
{
"name": "Runtime",
"type": "string",
"format": "--runtime {value}",
"help": "Specifies the target runtime. For a list of Runtime Identifiers (RIDs), see the <a href=\"https://docs.microsoft.com/en-us/dotnet/core/rid-catalog\">RID catalog</a>."
},
{
"name": "Verbosity",
"type": "DotNetVerbosity",
"format": "--verbosity {value}",
"help": "Sets the verbosity level of the command. Allowed values are <c>q[uiet]</c>, <c>m[inimal]</c>, <c>n[ormal]</c>, <c>d[etailed]</c>, and <c>diag[nostic]</c>."
},
{
"name": "VersionSuffix",
"type": "string",
"format": "--version-suffix {value}",
"help": "Defines the version suffix for an asterisk (<c>*</c>) in the version field of the project file. The format follows NuGet's version guidelines."
},
{
"name": "Loggers",
"type": "List<string>",
"format": "/logger:{value}",
"help": "Specifies the loggers to use to log events from MSBuild."
},
{
"name": "NoConsoleLogger",
"type": "bool",
"format": "/noconsolelogger",
"help": "Disable the default console logger, and don't log events to the console."
},
{
"name": "NoLogo",
"type": "bool",
"format": "--nologo",
"help": "Doesn't display the startup banner or the copyright message. Available since .NET Core 3.0 SDK."
},
{
"name": "BinaryLog",
"type": "string",
"format": "-bl:{value}",
"help": "Generare MSBuild <a href=\"https://github.com/dotnet/msbuild/blob/main/documentation/wiki/Binary-Log.md\">binary log</a>."
},
{
"name": "ArtifactsPath",
"type": "string",
"format": "--artifacts-path {value}",
"help": "All build output files from the executed command will go in subfolders under the specified path, separated by project. For more information see <a href=\"https://learn.microsoft.com/en-us/dotnet/core/sdk/artifacts-output\">Artifacts Output Layout</a>. Available since .NET 8 SDK."
}
]
}
},
{
"help": "The <c>dotnet msbuild</c> command allows access to a fully functional MSBuild.<para/>The command has the exact same capabilities as the existing MSBuild command-line client for SDK-style projects only. The options are all the same. For more information about the available options, see the <a href=\"https://docs.microsoft.com/en-us/visualstudio/msbuild/msbuild-command-line-reference\">MSBuild command-line reference</a>.<para/>The <a href=\"https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-build\">dotnet build</a> command is equivalent to <c>dotnet msbuild -restore</c>. When you don't want to build the project and you have a specific target you want to run, use <c>dotnet build</c> or <c>dotnet msbuild</c> and specify the target.",
"postfix": "MSBuild",
"omitCommonProperties": true,
"definiteArgument": "msbuild",
"settingsClass": {
"properties": [
{
"name": "TargetPath",
"type": "string",
"format": "{value}",
"position": 1,
"createOverload": true,
"help": "The solution or project file on which MSBuild is executed."
},
{
"name": "DetailedSummary",
"type": "bool",
"format": "/detailedsummary",
"help": "Show detailed information at the end of the build log about the configurations that were built and how they were scheduled to nodes."
},
{
"name": "MaxCpuCount",
"type": "int",
"format": "/maxcpucount:{value}",
"help": "<p>Specifies the maximum number of concurrent processes to use when building. If you don't include this switch, the default value is 1. If you include this switch without specifying a value, MSBuild will use up to the number of processors in the computer. For more information, see <a href=\"https://msdn.microsoft.com/en-us/library/bb651793.aspx\">Building Multiple Projects in Parallel</a>.</p><p>The following example instructs MSBuild to build using three MSBuild processes, which allows three projects to build at the same time:</p><p><c>msbuild myproject.proj /maxcpucount:3</c></p>"
},
{
"name": "NodeReuse",
"type": "bool",
"format": "/nodeReuse:{value}",
"help": "<p>Enable or disable the re-use of MSBuild nodes. You can specify the following values: <ul><li><c>true</c>: Nodes remain after the build finishes so that subsequent builds can use them (default).</li><li><c>false</c>. Nodes don't remain after the build completes.</li></ul></p><p>A node corresponds to a project that's executing. If you include the <c>/maxcpucount</c> switch, multiple nodes can execute concurrently.</p>"
},
{
"name": "NoLogo",
"type": "bool",
"format": "/nologo",
"help": "Don't display the startup banner or the copyright message."
},
{
"name": "Restore",
"type": "bool",
"format": "/restore",
"help": "Runs the <c>Restore</c> target prior to building the actual targets."
},
{
"name": "Targets",
"type": "List<string>",
"format": "/target:{value}",
"separator": ";",
"help": "<p>Build the specified targets in the project. Specify each target separately, or use a semicolon or comma to separate multiple targets, as the following example shows:<br/><c>/target:Resources;Compile</c></p><p>If you specify any targets by using this switch, they are run instead of any targets in the DefaultTargets attribute in the project file. For more information, see <a href=\"https://msdn.microsoft.com/en-us/library/ee216359.aspx\">Target Build Order</a> and <a href=\"https://msdn.microsoft.com/en-us/library/ms171463.aspx\">How to: Specify Which Target to Build First</a>.</p><p>A target is a group of tasks. For more information, see <a href=\"https://msdn.microsoft.com/en-us/library/ms171462.aspx\">Targets</a>.</p>"
},
{
"name": "Verbosity",
"type": "DotNetVerbosity",
"format": "/verbosity:{value}",
"help": "<p>Specifies the amount of information to display in the build log. Each logger displays events based on the verbosity level that you set for that logger.</p><p>You can specify the following verbosity levels: <c>q[uiet]</c>, <c>m[inimal]</c>, <c>n[ormal]</c>, <c>d[etailed]</c>, and <c>diag[nostic]</c>.</p><p>The following setting is an example: <c>/verbosity:quiet</c></p>"
},
{
"name": "Loggers",
"type": "List<string>",
"format": "/logger:{value}",
"help": "Specifies the loggers to use to log events from MSBuild."
},
{
"name": "NoConsoleLogger",
"type": "bool",
"format": "/noconsolelogger",
"help": "Disable the default console logger, and don't log events to the console."
},
{
"name": "Configuration",
"type": "string",
"format": "/property:Configuration={value}",
"help": "Defines the build configuration. The default value is <c>Debug</c>. This option is only required when cleaning if you specified it during build time."
},
{
"name": "GraphBuild",
"type": "bool",
"format": "/graphBuild",
"help": "Causes MSBuild to construct and build a project graph. Constructing a graph involves identifying project references to form dependencies. Building that graph involves attempting to build project references prior to the projects that reference them, differing from traditional MSBuild scheduling. Requires MSBuild 16 or later."
},
{
"name": "BinaryLog",
"type": "string",
"format": "-bl:{value}",
"help": "Generate MSBuild <a href=\"https://github.com/dotnet/msbuild/blob/main/documentation/wiki/Binary-Log.md\">binary log</a>."
},
{
"name": "Properties",
"type": "Dictionary<string, object>",
"format": "/property:{key}={value}",
"disallowedCharacter": ";",
"help": "<p>Set or override the specified project-level properties, where name is the property name and value is the property value. Specify each property separately, or use a semicolon or comma to separate multiple properties, as the following example shows:</p><p><c>/property:WarningLevel=2;OutDir=bin\\Debug</c></p>",
"delegates": [
{
"name": "RunCodeAnalysis",
"type": "bool"
},
{
"name": "NoWarn",
"type": "List<int>",
"separator": ";"
},
{
"name": "WarningsAsErrors",
"type": "List<int>",
"separator": ";"
},
{
"name": "WarningLevel",
"type": "int"
},
{
"name": "TreatWarningsAsErrors",
"type": "bool"
},
{
"name": "AssemblyVersion",
"type": "string"
},
{
"name": "FileVersion",
"type": "string"
},
{
"name": "InformationalVersion",
"type": "string"
},
{
"name": "PackageId",
"type": "string"
},
{
"name": "Version",
"type": "string"
},
{
"name": "VersionPrefix",
"type": "string"
},
{
"name": "Authors",
"type": "List<string>",
"separator": ","
},
{
"name": "Title",
"type": "string"
},
{
"name": "Description",
"type": "string"
},
{
"name": "Copyright",
"type": "string"
},
{
"name": "PackageRequireLicenseAcceptance",
"type": "bool"
},
{
"name": "PackageLicenseUrl",
"type": "string"
},
{
"name": "PackageProjectUrl",
"type": "string"
},
{
"name": "PackageIconUrl",
"type": "string"
},
{
"name": "PackageTags",
"type": "List<string>",
"separator": " "
},
{
"name": "PackageReleaseNotes",
"type": "string"
},
{
"name": "RepositoryUrl",
"type": "string"
},
{
"name": "RepositoryType",
"type": "string"
},
{
"name": "SymbolPackageFormat",
"type": "DotNetSymbolPackageFormat",
"help": "Format for packaging symbols."
},
{
"name": "PublishReadyToRun",
"type": "bool",
"help": "Compiles application assemblies as ReadyToRun (R2R) format. R2R is a form of ahead-of-time (AOT) compilation. For more information, see <a href=\"https://docs.microsoft.com/en-us/dotnet/core/deploying/ready-to-run\">ReadyToRun images</a>. Available since .NET Core 3.0 SDK.<para/>We recommend that you specify this option in a publish profile rather than on the command line. For more information, see <a href=\"https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-publish#msbuild\">MSBuild</a>."
},
{
"name": "PublishSingleFile",
"type": "bool",
"help": "Packages the app into a platform-specific single-file executable. The executable is self-extracting and contains all dependencies (including native) that are required to run the app. When the app is first run, the application is extracted to a directory based on the app name and build identifier. Startup is faster when the application is run again. The application doesn't need to extract itself a second time unless a new version is used. Available since .NET Core 3.0 SDK.<para/> For more information about single-file publishing, see the <a href=\"https://github.com/dotnet/designs/blob/master/accepted/2020/single-file/design.md\">single-file bundler design document</a>.<para/>We recommend that you specify this option in a publish profile rather than on the command line. For more information, see <a href=\"https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-publish#msbuild\">MSBuild</a>."
},
{
"name": "PublishTrimmed",
"type": "bool",
"help": "Trims unused libraries to reduce the deployment size of an app when publishing a self-contained executable. For more information, see <a href=\"https://docs.microsoft.com/en-us/dotnet/core/deploying/trim-self-contained\">Trim self-contained deployments and executables</a>. Available since .NET Core 3.0 SDK as a preview feature.<para/>We recommend that you specify this option in a publish profile rather than on the command line. For more information, see <a href=\"https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-publish#msbuild\">MSBuild</a>."
},
{
"name": "PublishProfile",
"type": "string"
},
{
"name": "Platform",
"type": "string"
},
{
"name": "ContinuousIntegrationBuild",
"type": "bool"
},
{
"name": "DeterministicSourcePaths",
"type": "bool"
},
{
"name": "Deterministic",
"type": "bool"
}
]
}
]
}
},
{
"help": "<p>The <c>dotnet clean</c> command cleans the output of the previous build. It's implemented as an <a href=\"https://docs.microsoft.com/en-us/visualstudio/msbuild/msbuild-targets\">MSBuild target</a>, so the project is evaluated when the command is run. Only the outputs created during the build are cleaned. Both intermediate <em>(obj)</em> and final output <em>(bin)</em> folders are cleaned.</p>",
"postfix": "Clean",
"definiteArgument": "clean",
"settingsClass": {
"properties": [
{
"name": "Project",
"type": "string",
"format": "{value}",
"position": 1,
"createOverload": true,
"help": "The MSBuild project to clean. If a project file is not specified, MSBuild searches the current working directory for a file that has a file extension that ends in <em>proj</em> and uses that file."
},
{
"name": "Configuration",
"type": "string",
"format": "--configuration {value}",
"help": "Defines the build configuration. The default value is <c>Debug</c>. This option is only required when cleaning if you specified it during build time."
},
{
"name": "Framework",
"type": "string",
"format": "--framework {value}",
"help": "The <a href=\"https://docs.microsoft.com/en-us/dotnet/standard/frameworks\">framework</a> that was specified at build time. The framework must be defined in the <a href=\"https://docs.microsoft.com/en-us/dotnet/core/tools/csproj\">project file</a>. If you specified the framework at build time, you must specify the framework when cleaning."
},
{
"name": "Output",
"type": "string",
"format": "--output {value}",
"help": "Directory in which the build outputs are placed. Specify the <c>--framework</c> switch with the output directory switch if you specified the framework when the project was built."
},
{
"name": "Runtime",
"type": "string",
"format": "--runtime {value}",
"help": "Cleans the output folder of the specified runtime. This is used when a <a href=\"https://docs.microsoft.com/en-us/dotnet/core/deploying/index#self-contained-deployments-scd\">self-contained deployment</a> was created."
},
{
"name": "Verbosity",
"type": "DotNetVerbosity",
"format": "--verbosity {value}",
"help": "Sets the verbosity level of the command. Allowed levels are q[uiet], m[inimal], n[ormal], d[etailed], and diag[nostic]."
},
{
"name": "NoLogo",
"type": "bool",
"format": "--nologo",
"help": "Doesn't display the startup banner or the copyright message. Available since .NET Core 3.0 SDK."
},
{
"name": "ArtifactsPath",
"type": "string",
"format": "--artifacts-path {value}",
"help": "All build output files from the executed command will go in subfolders under the specified path, separated by project. For more information see <a href=\"https://learn.microsoft.com/en-us/dotnet/core/sdk/artifacts-output\">Artifacts Output Layout</a>. Available since .NET 8 SDK."
}
]
}
},
{
"help": "<c>dotnet format</c> is a code formatter that applies style preferences to a project or solution. Preferences will be read from an *.editorconfig* file, if present, otherwise a default set of preferences will be used. For more information, see the <a href=\"https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/configuration-files#editorconfig\">EditorConfig documentation</a>",
"postfix": "Format",
"definiteArgument": "format",
"settingsClass": {
"properties": [
{
"name": "Project",
"type": "string",
"format": "{value}",
"position": 1,
"createOverload": true,
"help": "The MSBuild project or solution to run code formatting on. If a project or solution file is not specified, MSBuild searches the current working directory for a file that has a file extension that ends in <em>proj</em> or <em>sln</em>, and uses that file."
},
{
"name": "Severity",
"type": "DotNetFormatSeverity",
"format": "--severity {value}",
"help": "The minimum severity of diagnostics to fix. Allowed values are info, warn, and error. The default value is warn."
},
{
"name": "NoRestore",
"type": "bool",
"format": "--no-restore",
"help": "Doesn't execute an implicit restore before formatting. Default is to do implicit restore."
},
{
"name": "VerifyNoChanges",
"type": "bool",
"format": "--verify-no-changes",
"help": "Verifies that no formatting changes would be performed. Terminates with a non zero exit code if any files would have been formatted."
},
{
"name": "Include",
"type": "List<string>",
"format": "--include {value}",
"help": "A space-separated list of relative file or folder paths to include in formatting. The default is all files in the solution or project."
},
{
"name": "Exclude",
"type": "List<string>",
"format": "--exclude {value}",
"help": "A space-separated list of relative file or folder paths to exclude from formatting. The default is none."
},
{
"name": "IncludeGenerated",
"type": "bool",
"format": "--include-generated",
"help": "Formats files generated by the SDK."
},
{
"name": "Verbosity",
"type": "DotNetVerbosity",
"format": "--verbosity {value}",
"help": "Sets the verbosity level. Allowed levels are q[uiet], m[inimal], n[ormal], d[etailed], and diag[nostic]."
},
{
"name": "BinaryLog",
"type": "string",
"format": "--binarylog {value}",
"help": "Logs all project or solution load information to a binary log file."
},
{
"name": "Report",
"type": "string",
"format": "--report {value}",
"help": "Produces a JSON report in the directory specified by <c>REPORT_PATH</c>."
}
]
}
},
{
"help": "<c>dotnet publish</c> compiles the application, reads through its dependencies specified in the project file, and publishes the resulting set of files to a directory. The output will contain the following:<para/><ul><li>Intermediate Language (IL) code in an assembly with a <em>dll</em> extension.</li><li><em>.deps.json</em> file that contains all of the dependencies of the project.</li><li><em>.runtime.config.json</em> file that specifies the shared runtime that the application expects, as well as other configuration options for the runtime (for example, garbage collection type).</li><li>The application's dependencies. These are copied from the NuGet cache into the output folder.</li></ul><para/>The <c>dotnet publish</c> command's output is ready for deployment to a hosting system (for example, a server, PC, Mac, laptop) for execution and is the only officially supported way to prepare the application for deployment. Depending on the type of deployment that the project specifies, the hosting system may or may not have the .NET Core shared runtime installed on it. For more information, see <a href=\"https://docs.microsoft.com/en-us/dotnet/core/deploying/index\">.NET Core Application Deployment</a>. For the directory structure of a published application, see <a href=\"https://docs.microsoft.com/en-us/aspnet/core/hosting/directory-structure\">Directory structure</a>.",
"postfix": "Publish",
"commonPropertySets": [
"restore"
],
"definiteArgument": "publish",
"settingsClass": {
"properties": [
{
"name": "Project",
"type": "string",
"format": "{value}",
"position": 1,
"help": "The project to publish, which defaults to the current directory if not specified."
},
{
"name": "Architecture",
"type": "string",
"format": "--arch {value}",
"help": "Specifies the target architecture. This is a shorthand syntax for setting the <a href=\"https://learn.microsoft.com/en-us/dotnet/core/rid-catalog\">Runtime Identifier (RID)</a>, where the provided value is combined with the default RID. For example, on a win-x64 machine, specifying --arch x86 sets the RID to win-x86. If you use this option, don't use the -r|--runtime option. Available since .NET 6 Preview 7."
},
{
"name": "Configuration",
"type": "string",
"format": "--configuration {value}",
"help": "Defines the build configuration. The default value is <c>Debug</c>."
},
{
"name": "Framework",
"type": "string",
"format": "--framework {value}",
"help": "Publishes the application for the specified <a href=\"https://docs.microsoft.com/en-us/dotnet/standard/frameworks\">target framework</a>. You must specify the target framework in the project file."
},
{
"name": "Manifest",
"type": "string",
"format": "--manifest {value}",
"help": "Specifies one or several <a href=\"https://docs.microsoft.com/en-us/dotnet/core/deploying/runtime-store\">target manifests</a> to use to trim the set of packages published with the app. The manifest file is part of the output of the <a href=\"https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-store\"><c>dotnet store</c></a> command. To specify multiple manifests, add a <c>--manifest</c> option for each manifest. This option is available starting with .NET Core 2.0 SDK."
},
{
"name": "NoRestore",
"type": "bool",
"format": "--no-restore",
"help": "Doesn't perform an implicit restore when running the command."
},
{
"name": "NoBuild",
"type": "bool",
"format": "--no-build",
"help": "Doesn't build the project before publishing. It also implicitly sets the <c>--no-restore</c> flag."
},
{
"name": "Output",
"type": "string",
"format": "--output {value}",
"help": "Specifies the path for the output directory. If not specified, it defaults to <em>./bin/[configuration]/[framework]/</em> for a framework-dependent deployment or <em>./bin/[configuration]/[framework]/[runtime]</em> for a self-contained deployment.<para/>If a relative path is provided, the output directory generated is relative to the project file location, not to the current working directory."
},
{
"name": "OperatingSystem",
"type": "string",
"format": "--os {value}",
"help": "Specifies the target operating system (OS). This is a shorthand syntax for setting the <a href=\"https://learn.microsoft.com/en-us/dotnet/core/rid-catalog\">Runtime Identifier (RID)</a>, where the provided value is combined with the default RID. For example, on a win-x64 machine, specifying --os linux sets the RID to linux-x64. If you use this option, don't use the -r|--runtime option. Available since .NET 6."
},
{
"name": "SelfContained",
"type": "bool",
"format": "--self-contained {value}",
"help": "Publishes the .NET Core runtime with your application so the runtime doesn't need to be installed on the target machine. If a runtime identifier is specified, its default value is <c>true</c>. For more information about the different deployment types, see <a href=\"https://docs.microsoft.com/en-us/dotnet/core/deploying/index\">.NET Core application deployment</a>."
},
{
"name": "Runtime",
"type": "string",
"format": "--runtime {value}",
"help": "Publishes the application for a given runtime. This is used when creating a <a href=\"https://docs.microsoft.com/en-us/dotnet/core/deploying/index#self-contained-deployments-scd\">self-contained deployment (SCD)</a>. For a list of Runtime Identifiers (RIDs), see the <a href=\"https://docs.microsoft.com/en-us/dotnet/core/rid-catalog\">RID catalog</a>. Default is to publish a <a href=\"https://docs.microsoft.com/en-us/dotnet/core/deploying/index#framework-dependent-deployments-fdd\">framework-dependent deployment (FDD)</a>."
},
{
"name": "Verbosity",
"type": "DotNetVerbosity",
"format": "--verbosity {value}",
"help": "Sets the verbosity level of the command. Allowed values are <c>q[uiet]</c>, <c>m[inimal]</c>, <c>n[ormal]</c>, <c>d[etailed]</c>, and <c>diag[nostic]</c>."
},
{
"name": "VersionSuffix",
"type": "string",
"format": "--version-suffix {value}",
"help": "Defines the version suffix for an asterisk (<c>*</c>) in the version field of the project file. The format follows NuGet's version guidelines."
},
{
"name": "NoLogo",