{ "$schema": "https://opencli.org/draft.json", "opencli": "0.1", "command": { "name": "dotnet", "arguments": [ { "name": "path-to-application", "description": "The path to an application .dll file to execute.", "arity": { "minimum": 0, "maximum": 1 } } ], "options": [ { "name": "--cli-schema", "description": "Display the command schema as JSON.", "recursive": true, "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--diagnostics", "aliases": [ "-d" ], "description": "Enable diagnostic output.", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--help", "aliases": [ "-?", "-h", "/?", "/h" ], "description": "Show command line help.", "recursive": true, "metadata": [ { "name": "x-value-type", "value": "System.Void" } ] }, { "name": "--info", "description": "Display .NET information.", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--list-runtimes", "description": "Display the installed runtimes.", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--list-sdks", "description": "Display the installed SDKs.", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--version", "description": "Display .NET SDK version in use.", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--additionalprobingpath", "arguments": [ { "name": "path", "required": true, "arity": { "minimum": 1, "maximum": 1 }, "description": "The additional probing path." } ], "group": "Runtime", "description": "Path containing probing policy and assemblies to probe for." }, { "name": "--additional-deps", "arguments": [ { "name": "path", "required": true, "arity": { "minimum": 1, "maximum": 1 }, "description": "The path to the additional deps.json file." } ], "group": "Runtime", "description": "Path to additional deps.json file." }, { "name": "--depsfile", "group": "Runtime", "description": "Path to .deps.json file.", "arguments": [ { "name": "path", "required": true, "arity": { "minimum": 1, "maximum": 1 }, "description": "The path to the deps.json file." } ] }, { "name": "--fx-version", "arguments": [ { "name": "version", "required": true, "arity": { "minimum": 1, "maximum": 1 }, "description": "The runtime version, for example 9.0.0." } ], "group": "Runtime", "description": "Version of the installed Shared Framework to use to run the application." }, { "name": "--roll-forward", "arguments": [ { "name": "setting", "required": true, "arity": { "minimum": 1, "maximum": 1 }, "description": "The roll forward policy to apply." } ], "group": "Runtime", "description": "Roll forward to framework version (LatestPatch, Minor, LatestMinor, Major, LatestMajor, Disable)." }, { "name": "--runtimeconfig", "group": "Runtime", "description": "Path to .runtimeconfig.json file.", "arguments": [ { "name": "path", "required": true, "arity": { "minimum": 1, "maximum": 1 }, "description": "The path to the runtimeconfig.json file." } ] } ], "commands": [ { "name": "add", "description": ".NET Add Command", "hidden": true, "arguments": [ { "name": "PROJECT | FILE", "arity": { "minimum": 0, "maximum": 1 }, "description": "The project file or C# file-based app to operate on. If a file is not specified, the command will search the current directory for a project file.", "metadata": [ { "name": "x-value-type", "value": "System.String" } ] } ], "commands": [ { "name": "package", "description": "Add a NuGet package reference to the project.", "arguments": [ { "name": "packageId", "required": true, "arity": { "minimum": 1, "maximum": 1 }, "description": "Package reference in the form of a package identifier like 'Newtonsoft.Json' or package identifier and version separated by '@' like 'Newtonsoft.Json@13.0.3'.", "metadata": [ { "name": "x-value-type", "value": "Microsoft.DotNet.Cli.PackageIdentityWithRange" } ] } ], "options": [ { "name": "--file", "description": "The file-based app to operate on.", "arguments": [ { "name": "file", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "recursive": true, "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--framework", "aliases": [ "-f" ], "description": "Add the reference only when targeting a specific framework.", "arguments": [ { "name": "FRAMEWORK", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--interactive", "description": "Allows the command to stop and wait for user input or action (for example to complete authentication).", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--no-restore", "aliases": [ "-n" ], "description": "Add the reference without performing restore preview and compatibility check.", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--package-directory", "description": "The directory to restore packages to.", "arguments": [ { "name": "PACKAGE_DIR", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--prerelease", "description": "Allows prerelease packages to be installed.", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--project", "description": "The project file to operate on. If a file is not specified, the command will search the current directory for one.", "arguments": [ { "name": "project", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "recursive": true, "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--source", "aliases": [ "-s" ], "description": "The NuGet package source to use during the restore.", "arguments": [ { "name": "SOURCE", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--version", "aliases": [ "-v" ], "description": "The version of the package to add.", "arguments": [ { "name": "VERSION", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "metadata": [ { "name": "x-value-type", "value": "System.String" } ] } ] }, { "name": "reference", "description": "Add a project-to-project reference to the project.", "arguments": [ { "name": "PROJECT_PATH", "required": true, "arity": { "minimum": 1 }, "description": "The paths to the projects to add as references.", "metadata": [ { "name": "x-value-type", "value": "System.Collections.Generic.IEnumerable" } ] } ], "options": [ { "name": "--framework", "aliases": [ "-f" ], "description": "Add the reference only when targeting a specific framework.", "arguments": [ { "name": "FRAMEWORK", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--interactive", "description": "Allows the command to stop and wait for user input or action (for example to complete authentication).", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--project", "description": "The project file to operate on. If a file is not specified, the command will search the current directory for one.", "arguments": [ { "name": "project", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "recursive": true, "metadata": [ { "name": "x-value-type", "value": "System.String" } ] } ] } ] }, { "name": "build", "description": "Build a .NET project.", "arguments": [ { "name": "PROJECT | SOLUTION | FILE", "arity": { "minimum": 0 }, "description": "The project or solution or C# (file-based program) file to operate on. If a file is not specified, the command will search the current directory for a project or solution.", "metadata": [ { "name": "x-value-type", "value": "System.String[]" } ] } ], "options": [ { "name": "--arch", "aliases": [ "-a" ], "description": "The target architecture.", "arguments": [ { "name": "ARCH", "required": true, "arity": { "minimum": 1, "maximum": 1 }, "description": "The target architecture." } ], "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--artifacts-path", "description": "The artifacts path. All output from the project, including build, publish, and pack output, will go in subfolders under the specified path.", "arguments": [ { "name": "ARTIFACTS_DIR", "required": true, "arity": { "minimum": 1, "maximum": 1 }, "description": "The artifacts directory." } ], "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--configfile", "arguments": [ { "name": "FILE", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--configuration", "aliases": [ "-c" ], "description": "The configuration to use for building the project. The default for most projects is 'Debug'.", "arguments": [ { "name": "CONFIGURATION", "required": true, "arity": { "minimum": 1, "maximum": 1 }, "description": "The build configuration, for example Debug or Release." } ], "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--disable-build-servers", "description": "Force the command to ignore any persistent build servers.", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--disable-parallel", "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--force", "description": "Force all dependencies to be resolved even if the last restore was successful.\nThis is equivalent to deleting project.assets.json.", "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--framework", "aliases": [ "-f" ], "description": "The target framework to build for. The target framework must also be specified in the project file.", "arguments": [ { "name": "FRAMEWORK", "required": true, "arity": { "minimum": 1, "maximum": 1 }, "description": "The target framework moniker, for example net9.0." } ], "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--getItem", "aliases": [ "-getItem", "/getItem" ], "arguments": [ { "name": "GETITEM", "required": true, "arity": { "minimum": 1 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String[]" } ] }, { "name": "--getProperty", "aliases": [ "-getProperty", "/getProperty" ], "arguments": [ { "name": "GETPROPERTY", "required": true, "arity": { "minimum": 1 }, "description": "One or more MSBuild property names." } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String[]" } ] }, { "name": "--getResultOutputFile", "aliases": [ "-getResultOutputFile", "/getResultOutputFile" ], "arguments": [ { "name": "GETRESULTOUTPUTFILE", "required": true, "arity": { "minimum": 1 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String[]" } ] }, { "name": "--getTargetResult", "aliases": [ "-getTargetResult", "/getTargetResult" ], "arguments": [ { "name": "GETTARGETRESULT", "required": true, "arity": { "minimum": 1 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String[]" } ] }, { "name": "--ignore-failed-sources", "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--interactive", "description": "Allows the command to stop and wait for user input or action (for example to complete authentication).", "arguments": [ { "name": "INTERACTIVE", "required": false, "arity": { "minimum": 0, "maximum": 1 }, "acceptedValues": [ "true", "false" ] } ], "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--no-cache", "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--no-dependencies", "description": "Do not build project-to-project references and only build the specified project.", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--no-http-cache", "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--no-incremental", "description": "Do not use incremental building.", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--no-logo", "aliases": [ "--nologo", "-nologo", "/nologo" ], "description": "Do not display the startup banner or the copyright message.", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": true } ] }, { "name": "--no-restore", "description": "Do not restore the project before building.", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--no-self-contained", "description": "Publish your application as a framework dependent application. A compatible .NET runtime must be installed on the target machine to run your application.", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--os", "description": "The target operating system.", "arguments": [ { "name": "OS", "required": true, "arity": { "minimum": 1, "maximum": 1 }, "description": "The target operating system, for example linux, win or osx." } ], "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--output", "aliases": [ "-o" ], "description": "The output directory to place built artifacts in.", "arguments": [ { "name": "OUTPUT_DIR", "required": true, "arity": { "minimum": 1, "maximum": 1 }, "description": "The output directory." } ], "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--packages", "arguments": [ { "name": "PACKAGES_DIR", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--property", "aliases": [ "--p", "-p", "-property", "/p", "/property" ], "arguments": [ { "name": "PROPERTY", "required": false, "arity": { "minimum": 0 }, "description": "One or more MSBuild properties, each in the form name=value." } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.Collections.ObjectModel.ReadOnlyDictionary" } ] }, { "name": "--restoreProperty", "aliases": [ "--rp", "-restoreProperty", "-rp", "/restoreProperty", "/rp" ], "arguments": [ { "name": "RESTOREPROPERTY", "required": false, "arity": { "minimum": 0 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.Collections.ObjectModel.ReadOnlyDictionary" } ] }, { "name": "--runtime", "aliases": [ "-r" ], "description": "The target runtime to build for.", "arguments": [ { "name": "RUNTIME_IDENTIFIER", "required": true, "arity": { "minimum": 1, "maximum": 1 }, "description": "The runtime identifier, for example linux-x64." } ], "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--self-contained", "aliases": [ "--sc" ], "description": "Publish the .NET runtime with your application so the runtime doesn't need to be installed on the target machine.\nThe default is 'false.' However, when targeting .NET 7 or lower, the default is 'true' if a runtime identifier is specified.", "arguments": [ { "name": "SELF_CONTAINED", "required": false, "arity": { "minimum": 0, "maximum": 1 }, "acceptedValues": [ "true", "false" ], "description": "Whether or not the build is self contained." } ], "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--source", "arguments": [ { "name": "SOURCE", "required": true, "arity": { "minimum": 1 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.Collections.Generic.IEnumerable" } ] }, { "name": "--target", "aliases": [ "--t", "-t", "-target", "/t", "/target" ], "description": "Build these targets in this project. Use a semicolon or a comma to separate multiple targets, or specify each target separately.", "arguments": [ { "name": "TARGET", "required": false, "arity": { "minimum": 0 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String[]" }, { "name": "x-default", "value": null } ] }, { "name": "--use-current-runtime", "aliases": [ "--ucr" ], "description": "Use current runtime as the target runtime.", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--verbosity", "aliases": [ "--v", "-v", "-verbosity", "/v", "/verbosity" ], "description": "Set the MSBuild verbosity level. Allowed values are q[uiet], m[inimal], n[ormal], d[etailed], and diag[nostic].", "arguments": [ { "name": "LEVEL", "required": true, "arity": { "minimum": 1, "maximum": 1 }, "description": "The verbosity level." } ], "metadata": [ { "name": "x-value-type", "value": "System.Nullable" } ] }, { "name": "--version-suffix", "description": "Set the value of the $(VersionSuffix) property to use when building the project.", "arguments": [ { "name": "VERSION_SUFFIX", "required": true, "arity": { "minimum": 1, "maximum": 1 }, "description": "The version suffix." } ], "metadata": [ { "name": "x-value-type", "value": "System.String" } ] } ], "metadata": [ { "name": "x-documentation", "value": "https://learn.microsoft.com/dotnet/core/tools/dotnet-build" }, { "name": "x-schema-description", "value": ".NET Builder" } ], "examples": [ "dotnet build", "dotnet build ./src/MyApp/MyApp.csproj --configuration Release", "dotnet build --no-restore --verbosity minimal" ], "exitCodes": [ { "code": 0, "description": "The build succeeded." }, { "code": 1, "description": "The build failed." } ] }, { "name": "build-server", "description": "Interact with servers started by a build.", "commands": [ { "name": "shutdown", "description": "Shuts down build servers that are started from dotnet. By default, all servers are shut down.", "options": [ { "name": "--msbuild", "description": "Shut down the MSBuild build server.", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--razor", "description": "Shut down the Razor build server.", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--vbcscompiler", "description": "Shut down the VB/C# compiler build server.", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] } ] } ], "metadata": [ { "name": "x-schema-description", "value": "Interact with servers started from a build." } ] }, { "name": "clean", "description": "Clean build outputs of a .NET project.", "arguments": [ { "name": "PROJECT | SOLUTION | FILE", "arity": { "minimum": 0 }, "description": "The project or solution or C# (file-based program) file to operate on. If a file is not specified, the command will search the current directory for a project or solution.", "metadata": [ { "name": "x-value-type", "value": "System.String[]" } ] } ], "options": [ { "name": "--artifacts-path", "description": "The artifacts path. All output from the project, including build, publish, and pack output, will go in subfolders under the specified path.", "arguments": [ { "name": "ARTIFACTS_DIR", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--configuration", "aliases": [ "-c" ], "description": "The configuration to clean for. The default for most projects is 'Debug'.", "arguments": [ { "name": "CONFIGURATION", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--disable-build-servers", "description": "Force the command to ignore any persistent build servers.", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--framework", "aliases": [ "-f" ], "description": "The target framework to clean for. The target framework must also be specified in the project file.", "arguments": [ { "name": "FRAMEWORK", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--getItem", "aliases": [ "-getItem", "/getItem" ], "arguments": [ { "name": "GETITEM", "required": true, "arity": { "minimum": 1 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String[]" } ] }, { "name": "--getProperty", "aliases": [ "-getProperty", "/getProperty" ], "arguments": [ { "name": "GETPROPERTY", "required": true, "arity": { "minimum": 1 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String[]" } ] }, { "name": "--getResultOutputFile", "aliases": [ "-getResultOutputFile", "/getResultOutputFile" ], "arguments": [ { "name": "GETRESULTOUTPUTFILE", "required": true, "arity": { "minimum": 1 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String[]" } ] }, { "name": "--getTargetResult", "aliases": [ "-getTargetResult", "/getTargetResult" ], "arguments": [ { "name": "GETTARGETRESULT", "required": true, "arity": { "minimum": 1 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String[]" } ] }, { "name": "--interactive", "description": "Allows the command to stop and wait for user input or action (for example to complete authentication).", "arguments": [ { "name": "INTERACTIVE", "required": false, "arity": { "minimum": 0, "maximum": 1 }, "acceptedValues": [ "true", "false" ] } ], "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--no-logo", "aliases": [ "--nologo", "-nologo", "/nologo" ], "description": "Do not display the startup banner or the copyright message.", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": true } ] }, { "name": "--output", "aliases": [ "-o" ], "description": "The directory containing the build artifacts to clean.", "arguments": [ { "name": "OUTPUT_DIR", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--runtime", "aliases": [ "-r" ], "description": "The target runtime to clean for.", "arguments": [ { "name": "RUNTIME_IDENTIFIER", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--target", "aliases": [ "--t", "-t", "-target", "/t", "/target" ], "description": "Build these targets in this project. Use a semicolon or a comma to separate multiple targets, or specify each target separately.", "arguments": [ { "name": "TARGET", "required": false, "arity": { "minimum": 0 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String[]" }, { "name": "x-default", "value": [ "Clean" ] } ] }, { "name": "--verbosity", "aliases": [ "-v" ], "description": "Set the MSBuild verbosity level. Allowed values are q[uiet], m[inimal], n[ormal], d[etailed], and diag[nostic].", "arguments": [ { "name": "LEVEL", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "metadata": [ { "name": "x-value-type", "value": "Microsoft.DotNet.Cli.Utils.VerbosityOptions" }, { "name": "x-default", "value": "normal" } ] } ], "commands": [ { "name": "file-based-apps", "description": "Removes artifacts created for file-based apps", "hidden": true, "options": [ { "name": "--automatic", "arguments": [ { "name": "AUTOMATIC", "required": false, "arity": { "minimum": 0, "maximum": 1 }, "acceptedValues": [ "true", "false" ] } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--days", "description": "How many days an artifact folder needs to be unused in order to be removed", "arguments": [ { "name": "DAYS", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "metadata": [ { "name": "x-value-type", "value": "System.Int32" }, { "name": "x-default", "value": 30 } ] }, { "name": "--dry-run", "description": "Determines changes without actually modifying the file system", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] } ] } ], "metadata": [ { "name": "x-schema-description", "value": ".NET Clean Command" } ] }, { "name": "complete", "hidden": true, "arguments": [ { "name": "path", "required": true, "arity": { "minimum": 1, "maximum": 1 }, "metadata": [ { "name": "x-value-type", "value": "System.String" } ] } ], "options": [ { "name": "--position", "arguments": [ { "name": "command", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "metadata": [ { "name": "x-value-type", "value": "System.Nullable" } ] } ] }, { "name": "completions", "description": "Commands for generating and registering completions for supported shells", "commands": [ { "name": "script", "description": "Generate the completion script for a supported shell", "arguments": [ { "name": "shell", "arity": { "minimum": 0, "maximum": 1 }, "description": "The shell for which to generate or register completions", "metadata": [ { "name": "x-value-type", "value": "System.String" }, { "name": "x-default", "value": "zsh" } ] } ] } ] }, { "name": "dnx", "description": "Executes a tool from source without permanently installing it.", "hidden": true, "arguments": [ { "name": "packageId", "required": true, "arity": { "minimum": 1, "maximum": 1 }, "description": "Package reference in the form of a package identifier like 'dotnetsay' or package identifier and version separated by '@' like 'dotnetsay@2.1.7'.", "metadata": [ { "name": "x-value-type", "value": "Microsoft.DotNet.Cli.PackageIdentityWithRange" } ] }, { "name": "commandArguments", "arity": { "minimum": 0 }, "description": "Arguments forwarded to the tool", "metadata": [ { "name": "x-value-type", "value": "System.Collections.Generic.IEnumerable" } ] } ], "options": [ { "name": "--add-source", "description": "Add an additional NuGet package source to use during installation.", "arguments": [ { "name": "ADDSOURCE", "required": true, "arity": { "minimum": 1 } } ], "metadata": [ { "name": "x-value-type", "value": "System.String[]" } ] }, { "name": "--allow-roll-forward", "description": "Allow a .NET tool to roll forward to newer versions of the .NET runtime if the runtime it targets isn't installed.", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--configfile", "description": "The NuGet configuration file to use.", "arguments": [ { "name": "FILE", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--disable-parallel", "description": "Prevent restoring multiple projects in parallel.", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--ignore-failed-sources", "description": "Treat package source failures as warnings.", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--interactive", "description": "Allows the command to stop and wait for user input or action (for example to complete authentication).", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--no-cache", "description": "Do not cache packages and http requests.", "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--no-http-cache", "description": "Do not cache packages and http requests.", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--prerelease", "description": "Include pre-release packages.", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--source", "description": "Replace all NuGet package sources to use during installation with these.", "arguments": [ { "name": "SOURCE", "required": true, "arity": { "minimum": 1 } } ], "metadata": [ { "name": "x-value-type", "value": "System.String[]" } ] }, { "name": "--verbosity", "aliases": [ "-v" ], "description": "Set the MSBuild verbosity level. Allowed values are q[uiet], m[inimal], n[ormal], d[etailed], and diag[nostic].", "arguments": [ { "name": "LEVEL", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "metadata": [ { "name": "x-value-type", "value": "Microsoft.DotNet.Cli.Utils.VerbosityOptions" }, { "name": "x-default", "value": "normal" } ] }, { "name": "--version", "description": "The version of the tool package to install.", "arguments": [ { "name": "VERSION", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--yes", "aliases": [ "-y" ], "description": "Accept all confirmation prompts using \"yes.\"", "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] } ] }, { "name": "format", "arguments": [ { "name": "PROJECT | SOLUTION", "arity": { "minimum": 0, "maximum": 1 }, "description": "The project or solution file to operate on. If a file is not specified, the command will search the current directory for one." } ], "description": "Apply style preferences to a project or solution.", "options": [ { "name": "--diagnostics", "arguments": [ { "name": "diagnostics", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "description": "A space separated list of diagnostic ids to use as a filter when fixing code style or 3rd party issues." }, { "name": "--exclude-diagnostics", "arguments": [ { "name": "exclude-diagnostics", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "description": "A space separated list of diagnostic ids to ignore when fixing code style or 3rd party issues." }, { "name": "--severity", "arguments": [ { "name": "SEVERITY", "required": true, "arity": { "minimum": 1, "maximum": 1 }, "acceptedValues": [ "error", "hidden", "info", "warn" ] } ], "description": "The severity of diagnostics to fix. Allowed values are info, warn, and error." }, { "name": "--no-restore", "description": "Doesn't execute an implicit restore before formatting." }, { "name": "--verify-no-changes", "description": "Verify no formatting changes would be performed. Terminates with a non-zero exit code if any files would have been formatted." }, { "name": "--include", "arguments": [ { "name": "include", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "description": "A list of relative file or folder paths to include in formatting. All files are formatted if empty." }, { "name": "--exclude", "arguments": [ { "name": "exclude", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "description": "A list of relative file or folder paths to exclude from formatting." }, { "name": "--include-generated", "description": "Format files generated by the SDK." }, { "name": "--verbosity", "aliases": [ "-v" ], "arguments": [ { "name": "VERBOSITY", "required": true, "arity": { "minimum": 1, "maximum": 1 }, "acceptedValues": [ "d", "detailed", "diag", "diagnostic", "m", "minimal", "n", "normal", "q", "quiet" ] } ], "description": "Set the verbosity level. Allowed values are q[uiet], m[inimal], n[ormal], d[etailed], and diag[nostic]" }, { "name": "--binarylog", "arguments": [ { "name": "binary-log-path", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "description": "Log all project or solution load information to a binary log file." }, { "name": "--report", "arguments": [ { "name": "report-path", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "description": "Accepts a file path which if provided will produce a json report in the given directory." }, { "name": "--help", "aliases": [ "-?", "-h" ], "description": "Show help and usage information" }, { "name": "--version", "description": "Show version information" } ], "commands": [ { "name": "whitespace", "description": "Run whitespace formatting.", "arguments": [ { "name": "PROJECT | SOLUTION", "arity": { "minimum": 0, "maximum": 1 }, "description": "The project or solution file to operate on. If a file is not specified, the command will search the current directory for one." } ], "options": [ { "name": "--folder", "description": "Whether to treat the `` argument as a simple folder of files." }, { "name": "--no-restore", "description": "Doesn't execute an implicit restore before formatting." }, { "name": "--verify-no-changes", "description": "Verify no formatting changes would be performed. Terminates with a non-zero exit code if any files would have been formatted." }, { "name": "--include", "arguments": [ { "name": "include", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "description": "A list of relative file or folder paths to include in formatting. All files are formatted if empty." }, { "name": "--exclude", "arguments": [ { "name": "exclude", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "description": "A list of relative file or folder paths to exclude from formatting." }, { "name": "--include-generated", "description": "Format files generated by the SDK." }, { "name": "--verbosity", "aliases": [ "-v" ], "arguments": [ { "name": "VERBOSITY", "required": true, "arity": { "minimum": 1, "maximum": 1 }, "acceptedValues": [ "d", "detailed", "diag", "diagnostic", "m", "minimal", "n", "normal", "q", "quiet" ] } ], "description": "Set the verbosity level. Allowed values are q[uiet], m[inimal], n[ormal], d[etailed], and diag[nostic]" }, { "name": "--binarylog", "arguments": [ { "name": "binary-log-path", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "description": "Log all project or solution load information to a binary log file." }, { "name": "--report", "arguments": [ { "name": "report-path", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "description": "Accepts a file path which if provided will produce a json report in the given directory." }, { "name": "--help", "aliases": [ "-?", "-h" ], "description": "Show help and usage information" } ], "metadata": [ { "name": "x-usage", "value": [ "dotnet-format [] whitespace [] [options]" ] } ] }, { "name": "style", "description": "Run code style analyzers and apply fixes.", "arguments": [ { "name": "PROJECT | SOLUTION", "arity": { "minimum": 0, "maximum": 1 }, "description": "The project or solution file to operate on. If a file is not specified, the command will search the current directory for one." } ], "options": [ { "name": "--diagnostics", "arguments": [ { "name": "diagnostics", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "description": "A space separated list of diagnostic ids to use as a filter when fixing code style or 3rd party issues." }, { "name": "--exclude-diagnostics", "arguments": [ { "name": "exclude-diagnostics", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "description": "A space separated list of diagnostic ids to ignore when fixing code style or 3rd party issues." }, { "name": "--severity", "arguments": [ { "name": "SEVERITY", "required": true, "arity": { "minimum": 1, "maximum": 1 }, "acceptedValues": [ "error", "hidden", "info", "warn" ] } ], "description": "The severity of diagnostics to fix. Allowed values are info, warn, and error." }, { "name": "--no-restore", "description": "Doesn't execute an implicit restore before formatting." }, { "name": "--verify-no-changes", "description": "Verify no formatting changes would be performed. Terminates with a non-zero exit code if any files would have been formatted." }, { "name": "--include", "arguments": [ { "name": "include", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "description": "A list of relative file or folder paths to include in formatting. All files are formatted if empty." }, { "name": "--exclude", "arguments": [ { "name": "exclude", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "description": "A list of relative file or folder paths to exclude from formatting." }, { "name": "--include-generated", "description": "Format files generated by the SDK." }, { "name": "--verbosity", "aliases": [ "-v" ], "arguments": [ { "name": "VERBOSITY", "required": true, "arity": { "minimum": 1, "maximum": 1 }, "acceptedValues": [ "d", "detailed", "diag", "diagnostic", "m", "minimal", "n", "normal", "q", "quiet" ] } ], "description": "Set the verbosity level. Allowed values are q[uiet], m[inimal], n[ormal], d[etailed], and diag[nostic]" }, { "name": "--binarylog", "arguments": [ { "name": "binary-log-path", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "description": "Log all project or solution load information to a binary log file." }, { "name": "--report", "arguments": [ { "name": "report-path", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "description": "Accepts a file path which if provided will produce a json report in the given directory." }, { "name": "--help", "aliases": [ "-?", "-h" ], "description": "Show help and usage information" } ], "metadata": [ { "name": "x-usage", "value": [ "dotnet-format [] style [] [options]" ] } ] }, { "name": "analyzers", "description": "Run 3rd party analyzers and apply fixes.", "arguments": [ { "name": "PROJECT | SOLUTION", "arity": { "minimum": 0, "maximum": 1 }, "description": "The project or solution file to operate on. If a file is not specified, the command will search the current directory for one." } ], "options": [ { "name": "--diagnostics", "arguments": [ { "name": "diagnostics", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "description": "A space separated list of diagnostic ids to use as a filter when fixing code style or 3rd party issues." }, { "name": "--exclude-diagnostics", "arguments": [ { "name": "exclude-diagnostics", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "description": "A space separated list of diagnostic ids to ignore when fixing code style or 3rd party issues." }, { "name": "--severity", "arguments": [ { "name": "SEVERITY", "required": true, "arity": { "minimum": 1, "maximum": 1 }, "acceptedValues": [ "error", "hidden", "info", "warn" ] } ], "description": "The severity of diagnostics to fix. Allowed values are info, warn, and error." }, { "name": "--no-restore", "description": "Doesn't execute an implicit restore before formatting." }, { "name": "--verify-no-changes", "description": "Verify no formatting changes would be performed. Terminates with a non-zero exit code if any files would have been formatted." }, { "name": "--include", "arguments": [ { "name": "include", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "description": "A list of relative file or folder paths to include in formatting. All files are formatted if empty." }, { "name": "--exclude", "arguments": [ { "name": "exclude", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "description": "A list of relative file or folder paths to exclude from formatting." }, { "name": "--include-generated", "description": "Format files generated by the SDK." }, { "name": "--verbosity", "aliases": [ "-v" ], "arguments": [ { "name": "VERBOSITY", "required": true, "arity": { "minimum": 1, "maximum": 1 }, "acceptedValues": [ "d", "detailed", "diag", "diagnostic", "m", "minimal", "n", "normal", "q", "quiet" ] } ], "description": "Set the verbosity level. Allowed values are q[uiet], m[inimal], n[ormal], d[etailed], and diag[nostic]" }, { "name": "--binarylog", "arguments": [ { "name": "binary-log-path", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "description": "Log all project or solution load information to a binary log file." }, { "name": "--report", "arguments": [ { "name": "report-path", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "description": "Accepts a file path which if provided will produce a json report in the given directory." }, { "name": "--help", "aliases": [ "-?", "-h" ], "description": "Show help and usage information" } ], "metadata": [ { "name": "x-usage", "value": [ "dotnet-format [] analyzers [] [options]" ] } ] } ], "metadata": [ { "name": "x-usage", "value": [ "dotnet-format [] [command] [options]" ] } ] }, { "name": "fsi", "arguments": [ { "name": "script.fsx", "arity": { "minimum": 0, "maximum": 1 }, "description": "An F# script to execute." }, { "name": "arguments", "arity": { "minimum": 0 }, "description": "Arguments passed to the script." } ], "description": "Start F# Interactive / execute F# scripts.", "options": [ { "name": "--use", "arguments": [ { "name": "file", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "Input files", "description": "Use the given file on startup as initial input", "metadata": [ { "name": "x-option-separator", "value": ":" } ] }, { "name": "--load", "arguments": [ { "name": "file", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "Input files", "description": "#load the given file on startup", "metadata": [ { "name": "x-option-separator", "value": ":" } ] }, { "name": "--reference", "aliases": [ "-r" ], "arguments": [ { "name": "file", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "Input files", "description": "Reference an assembly", "metadata": [ { "name": "x-option-separator", "value": ":" } ] }, { "name": "--compilertool", "aliases": [ "-t" ], "arguments": [ { "name": "file", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "Input files", "description": "Reference an assembly or directory containing a design time tool", "metadata": [ { "name": "x-option-separator", "value": ":" } ] }, { "name": "--usesdkrefs", "group": "Input files", "description": "Use reference assemblies for .NET framework references when available (Enabled by default).", "metadata": [ { "name": "x-toggle", "value": "Append + to enable or - to disable, e.g. --usesdkrefs+" } ] }, { "name": "--debug", "aliases": [ "-g" ], "group": "Code generation", "description": "Emit debug information (on by default)", "metadata": [ { "name": "x-toggle", "value": "Append + to enable or - to disable, e.g. --debug+" } ] }, { "name": "--optimize", "aliases": [ "-O" ], "group": "Code generation", "description": "Enable optimizations (on by default)", "metadata": [ { "name": "x-toggle", "value": "Append + to enable or - to disable, e.g. --optimize+" } ] }, { "name": "--tailcalls", "group": "Code generation", "description": "Enable or disable tailcalls (on by default)", "metadata": [ { "name": "x-toggle", "value": "Append + to enable or - to disable, e.g. --tailcalls+" } ] }, { "name": "--deterministic", "group": "Code generation", "description": "Produce a deterministic assembly (including module version GUID and timestamp) (off by default)", "metadata": [ { "name": "x-toggle", "value": "Append + to enable or - to disable, e.g. --deterministic+" } ] }, { "name": "--realsig", "group": "Code generation", "description": "Generate assembly with IL visibility that matches the source code visibility (off by default)", "metadata": [ { "name": "x-toggle", "value": "Append + to enable or - to disable, e.g. --realsig+" } ] }, { "name": "--pathmap", "arguments": [ { "name": "path=sourcePath;...", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "Code generation", "description": "Maps physical paths to source path names output by the compiler", "metadata": [ { "name": "x-option-separator", "value": ":" } ] }, { "name": "--crossoptimize", "group": "Code generation", "description": "Enable or disable cross-module optimizations (on by default)", "metadata": [ { "name": "x-toggle", "value": "Append + to enable or - to disable, e.g. --crossoptimize+" } ] }, { "name": "--reflectionfree", "group": "Code generation", "description": "Disable implicit generation of constructs using reflection" }, { "name": "--warnaserror", "group": "Errors and warnings", "description": "Report all warnings as errors (off by default)", "metadata": [ { "name": "x-toggle", "value": "Append + to enable or - to disable, e.g. --warnaserror+" } ] }, { "name": "--warnaserror", "arguments": [ { "name": "warn;...", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "Errors and warnings", "description": "Report specific warnings as errors", "metadata": [ { "name": "x-option-separator", "value": ":" }, { "name": "x-toggle", "value": "Append + to enable or - to disable, e.g. --warnaserror+" } ] }, { "name": "--warn", "arguments": [ { "name": "n", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "Errors and warnings", "description": "Set a warning level (0-5)", "metadata": [ { "name": "x-option-separator", "value": ":" } ] }, { "name": "--nowarn", "arguments": [ { "name": "warn;...", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "Errors and warnings", "description": "Disable specific warning messages", "metadata": [ { "name": "x-option-separator", "value": ":" } ] }, { "name": "--warnon", "arguments": [ { "name": "warn;...", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "Errors and warnings", "description": "Enable specific warnings that may be off by default", "metadata": [ { "name": "x-option-separator", "value": ":" } ] }, { "name": "--checknulls", "group": "Errors and warnings", "description": "Enable nullness declarations and checks (off by default)", "metadata": [ { "name": "x-toggle", "value": "Append + to enable or - to disable, e.g. --checknulls+" } ] }, { "name": "--consolecolors", "group": "Errors and warnings", "description": "Output warning and error messages in color (on by default)", "metadata": [ { "name": "x-toggle", "value": "Append + to enable or - to disable, e.g. --consolecolors+" } ] }, { "name": "--langversion", "arguments": [ { "name": "?", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "Language", "description": "Display the allowed values for language version.", "metadata": [ { "name": "x-option-separator", "value": ":" } ] }, { "name": "--langversion", "arguments": [ { "name": "{version|latest|preview}", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "Language", "description": "Specify language version such as 'latest' or 'preview'.", "metadata": [ { "name": "x-option-separator", "value": ":" } ] }, { "name": "--disableLanguageFeature", "arguments": [ { "name": "string", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "Language", "description": "Disable a specific language feature by name.", "metadata": [ { "name": "x-option-separator", "value": ":" } ] }, { "name": "--checked", "group": "Language", "description": "Generate overflow checks (off by default)", "metadata": [ { "name": "x-toggle", "value": "Append + to enable or - to disable, e.g. --checked+" } ] }, { "name": "--define", "aliases": [ "-d" ], "arguments": [ { "name": "string", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "Language", "description": "Define conditional compilation symbols", "metadata": [ { "name": "x-option-separator", "value": ":" } ] }, { "name": "--strict-indentation", "group": "Language", "description": "Override indentation rules implied by the language version (off by default)", "metadata": [ { "name": "x-toggle", "value": "Append + to enable or - to disable, e.g. --strict-indentation+" } ] }, { "name": "--nologo", "group": "Miscellaneous", "description": "Suppress compiler copyright message" }, { "name": "--version", "group": "Miscellaneous", "description": "Display compiler version banner and exit" }, { "name": "--help", "aliases": [ "-?" ], "group": "Miscellaneous", "description": "Display this usage message" }, { "name": "--codepage", "arguments": [ { "name": "n", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "Advanced", "description": "Specify the codepage used to read source files", "metadata": [ { "name": "x-option-separator", "value": ":" } ] }, { "name": "--utf8output", "group": "Advanced", "description": "Output messages in UTF-8 encoding" }, { "name": "--preferreduilang", "arguments": [ { "name": "string", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "Advanced", "description": "Specify the preferred output language culture name (e.g. es-ES, ja-JP)", "metadata": [ { "name": "x-option-separator", "value": ":" } ] }, { "name": "--fullpaths", "group": "Advanced", "description": "Output messages with fully qualified paths" }, { "name": "--lib", "aliases": [ "-I" ], "arguments": [ { "name": "dir;...", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "Advanced", "description": "Specify a directory for the include path which is used to resolve source files and assemblies", "metadata": [ { "name": "x-option-separator", "value": ":" } ] }, { "name": "--simpleresolution", "group": "Advanced", "description": "Resolve assembly references using directory-based rules rather than MSBuild resolution" }, { "name": "--targetprofile", "arguments": [ { "name": "string", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "Advanced", "description": "Specify target framework profile of this assembly. Valid values are mscorlib, netcore or netstandard. Default - mscorlib", "metadata": [ { "name": "x-option-separator", "value": ":" } ] }, { "name": "--clearResultsCache", "group": "Advanced", "description": "Clear the package manager results cache" }, { "name": "--typecheck-only", "group": "Advanced", "description": "Perform type checking only, do not execute code" }, { "name": "--exec", "group": "Advanced", "description": "Exit fsi after loading the files or running the .fsx script given on the command line" }, { "name": "--gui", "group": "Advanced", "description": "Execute interactions on a Windows Forms event loop (on by default)", "metadata": [ { "name": "x-toggle", "value": "Append + to enable or - to disable, e.g. --gui+" } ] }, { "name": "--quiet", "group": "Advanced", "description": "Suppress fsi writing to stdout" }, { "name": "--readline", "group": "Advanced", "description": "Support TAB completion in console (on by default)", "metadata": [ { "name": "x-toggle", "value": "Append + to enable or - to disable, e.g. --readline+" } ] }, { "name": "--quotations-debug", "group": "Advanced", "description": "Emit debug information in quotations (off by default)", "metadata": [ { "name": "x-toggle", "value": "Append + to enable or - to disable, e.g. --quotations-debug+" } ] }, { "name": "--shadowcopyreferences", "group": "Advanced", "description": "Prevents references from being locked by the F# Interactive process (off by default)", "metadata": [ { "name": "x-toggle", "value": "Append + to enable or - to disable, e.g. --shadowcopyreferences+" } ] }, { "name": "--multiemit", "group": "Advanced", "description": "Emit multiple assemblies (on by default)", "metadata": [ { "name": "x-toggle", "value": "Append + to enable or - to disable, e.g. --multiemit+" } ] } ], "metadata": [ { "name": "x-usage", "value": [ "dotnet fsi [script.fsx []]" ] }, { "name": "x-bundled-tool", "value": true } ] }, { "name": "help", "description": "Opens the reference page in a browser for the specified command.", "arguments": [ { "name": "COMMAND_NAME", "arity": { "minimum": 0 }, "description": "The SDK command to launch online help for.", "metadata": [ { "name": "x-value-type", "value": "System.String[]" } ] } ], "metadata": [ { "name": "x-schema-description", "value": ".NET CLI help utility" } ] }, { "name": "internal-reportinstallsuccess", "hidden": true, "arguments": [ { "name": "internal-reportinstallsuccess-arg", "required": true, "arity": { "minimum": 1, "maximum": 1 }, "metadata": [ { "name": "x-value-type", "value": "System.String" } ] } ] }, { "name": "list", "description": "List references or packages of a .NET project.", "hidden": true, "arguments": [ { "name": "PROJECT | SOLUTION | FILE", "arity": { "minimum": 0, "maximum": 1 }, "description": "The project or solution or C# (file-based program) file to operate on. If a file is not specified, the command will search the current directory for a project or solution.", "metadata": [ { "name": "x-value-type", "value": "System.String" } ] } ], "commands": [ { "name": "package", "description": "List all package references of the project or solution.", "options": [ { "name": "--config", "aliases": [ "--configfile" ], "description": "The path to the NuGet config file to use. Requires the '--outdated', '--deprecated' or '--vulnerable' option.", "arguments": [ { "name": "CONFIG_FILE", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--deprecated", "description": "Lists packages that have been deprecated. Cannot be combined with '--vulnerable' or '--outdated' options.", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--file", "description": "The file-based app to operate on.", "arguments": [ { "name": "file", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "recursive": true, "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--format", "description": "Specifies the output format type for the list packages command.", "arguments": [ { "name": "FORMAT", "required": true, "arity": { "minimum": 1, "maximum": 1 }, "acceptedValues": [ "console", "json" ] } ], "metadata": [ { "name": "x-value-type", "value": "Microsoft.DotNet.Cli.Commands.Package.List.ReportOutputFormat" } ] }, { "name": "--framework", "aliases": [ "-f" ], "description": "Chooses a framework to show its packages. Use the option multiple times for multiple frameworks.", "arguments": [ { "name": "FRAMEWORK | FRAMEWORK\\RID", "required": true, "arity": { "minimum": 1 } } ], "metadata": [ { "name": "x-value-type", "value": "System.Collections.Generic.IEnumerable" } ] }, { "name": "--highest-minor", "description": "Consider only the packages with a matching major version number when searching for newer packages. Requires the '--outdated' option.", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--highest-patch", "description": "Consider only the packages with a matching major and minor version numbers when searching for newer packages. Requires the '--outdated' option.", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--include-prerelease", "description": "Consider packages with prerelease versions when searching for newer packages. Requires the '--outdated' option.", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--include-transitive", "description": "Lists transitive and top-level packages.", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--interactive", "description": "Allows the command to stop and wait for user input or action (for example to complete authentication).", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--no-restore", "description": "Do not restore before running the command.", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--outdated", "description": "Lists packages that have newer versions. Cannot be combined with '--deprecated' or '--vulnerable' options.", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--output-version", "description": "Specifies the version of machine-readable output. Requires the '--format json' option.", "arguments": [ { "name": "output-version", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "metadata": [ { "name": "x-value-type", "value": "System.Int32" } ] }, { "name": "--project", "description": "The project file to operate on. If a file is not specified, the command will search the current directory for one.", "arguments": [ { "name": "project", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "recursive": true, "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--source", "aliases": [ "-s" ], "description": "The NuGet sources to use when searching for newer packages. Requires the '--outdated', '--deprecated' or '--vulnerable' option.", "arguments": [ { "name": "SOURCE", "required": true, "arity": { "minimum": 1 } } ], "metadata": [ { "name": "x-value-type", "value": "System.Collections.Generic.IEnumerable" } ] }, { "name": "--verbosity", "aliases": [ "-v" ], "description": "Set the MSBuild verbosity level. Allowed values are q[uiet], m[inimal], n[ormal], d[etailed], and diag[nostic].", "arguments": [ { "name": "LEVEL", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "metadata": [ { "name": "x-value-type", "value": "Microsoft.DotNet.Cli.Utils.VerbosityOptions" } ] }, { "name": "--vulnerable", "description": "Lists packages that have known vulnerabilities. Cannot be combined with '--deprecated' or '--outdated' options.", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] } ] }, { "name": "reference", "description": "List all project-to-project references of the project.", "arguments": [ { "name": "argument", "arity": { "minimum": 0, "maximum": 1 }, "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String" } ] } ] } ] }, { "name": "msbuild", "description": "Run Microsoft Build Engine (MSBuild) commands.", "arguments": [ { "name": "arguments", "arity": { "minimum": 0 }, "metadata": [ { "name": "x-value-type", "value": "System.String[]" } ] } ], "options": [ { "name": "--disable-build-servers", "description": "Force the command to ignore any persistent build servers.", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--target", "aliases": [ "--t", "-t", "-target", "/t", "/target" ], "description": "Build these targets in this project. Use a semicolon or a comma to separate multiple targets, or specify each target separately.", "arguments": [ { "name": "TARGET", "required": false, "arity": { "minimum": 0 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String[]" }, { "name": "x-default", "value": null } ] } ], "metadata": [ { "name": "x-schema-description", "value": ".NET Builder" } ] }, { "name": "new", "description": "Create a new .NET project or file.", "arguments": [ { "name": "template-short-name", "arity": { "minimum": 0, "maximum": 1 }, "description": "A short name of the template to create.", "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "template-args", "arity": { "minimum": 0, "maximum": 999 }, "description": "Template specific options to use.", "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String[]" } ] } ], "options": [ { "name": "--add-source", "aliases": [ "--nuget-source" ], "description": "Specifies a NuGet source to use.", "arguments": [ { "name": "nuget-source", "required": true, "arity": { "minimum": 1, "maximum": 99 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String[]" } ] }, { "name": "--author", "description": "Filters the templates based on the template author.", "arguments": [ { "name": "AUTHOR", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--baseline", "description": "Filters the templates based on baseline defined in the template.", "arguments": [ { "name": "BASELINE", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--columns", "description": "Specifies the columns to display in the output. ", "arguments": [ { "name": "COLUMNS", "required": true, "arity": { "minimum": 1, "maximum": 4 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String[]" } ] }, { "name": "--columns-all", "description": "Displays all columns in the output.", "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--debug:attach", "description": "Allows to pause execution in order to attach to the process for debug purposes.", "arguments": [ { "name": "DEBUG:ATTACH", "required": false, "arity": { "minimum": 0, "maximum": 1 }, "acceptedValues": [ "true", "false" ] } ], "recursive": true, "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--debug:custom-hive", "description": "Sets custom settings location.", "arguments": [ { "name": "DEBUG:CUSTOM_HIVE", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "recursive": true, "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--debug:disable-project-context", "description": "Disables evaluating project context using MSBuild.", "arguments": [ { "name": "DEBUG:DISABLE_PROJECT_CONTEXT", "required": false, "arity": { "minimum": 0, "maximum": 1 }, "acceptedValues": [ "true", "false" ] } ], "recursive": true, "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--debug:disable-sdk-templates", "description": "If present, prevents templates bundled in the SDK from being presented.", "arguments": [ { "name": "DEBUG:DISABLE_SDK_TEMPLATES", "required": false, "arity": { "minimum": 0, "maximum": 1 }, "acceptedValues": [ "true", "false" ] } ], "recursive": true, "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--debug:ephemeral-hive", "aliases": [ "--debug:virtual-hive" ], "description": "If specified, the settings will be not preserved on file system.", "arguments": [ { "name": "DEBUG:EPHEMERAL_HIVE", "required": false, "arity": { "minimum": 0, "maximum": 1 }, "acceptedValues": [ "true", "false" ] } ], "recursive": true, "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--debug:rebuild-cache", "aliases": [ "--debug:rebuildcache" ], "description": "If specified, removes the template cache prior to command execution.", "arguments": [ { "name": "DEBUG:REBUILD_CACHE", "required": false, "arity": { "minimum": 0, "maximum": 1 }, "acceptedValues": [ "true", "false" ] } ], "recursive": true, "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--debug:reinit", "description": "If specified, resets the settings prior to command execution.", "arguments": [ { "name": "DEBUG:REINIT", "required": false, "arity": { "minimum": 0, "maximum": 1 }, "acceptedValues": [ "true", "false" ] } ], "recursive": true, "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--debug:show-config", "aliases": [ "--debug:showconfig" ], "description": "If specified, shows the template engine config prior to command execution.", "arguments": [ { "name": "DEBUG:SHOW_CONFIG", "required": false, "arity": { "minimum": 0, "maximum": 1 }, "acceptedValues": [ "true", "false" ] } ], "recursive": true, "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--diagnostics", "aliases": [ "-d" ], "description": "Enables diagnostic output.", "recursive": true, "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--dry-run", "description": "Displays a summary of what would happen if the given command line were run if it would result in a template creation.", "arguments": [ { "name": "DRY_RUN", "required": false, "arity": { "minimum": 0, "maximum": 1 }, "acceptedValues": [ "true", "false" ] } ], "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--force", "description": "Forces content to be generated even if it would change existing files.", "arguments": [ { "name": "FORCE", "required": false, "arity": { "minimum": 0, "maximum": 1 }, "acceptedValues": [ "true", "false" ] } ], "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--interactive", "description": "Allows the command to stop and wait for user input or action (for example to complete authentication).", "arguments": [ { "name": "INTERACTIVE", "required": false, "arity": { "minimum": 0, "maximum": 1 }, "acceptedValues": [ "true", "false" ] } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--language", "aliases": [ "-lang" ], "description": "Filters templates based on language.", "arguments": [ { "name": "LANGUAGE", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--name", "aliases": [ "-n" ], "description": "The name for the output being created. If no name is specified, the name of the output directory is used.", "arguments": [ { "name": "name", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--no-update-check", "description": "Disables checking for the template package updates when instantiating a template.", "arguments": [ { "name": "NO_UPDATE_CHECK", "required": false, "arity": { "minimum": 0, "maximum": 1 }, "acceptedValues": [ "true", "false" ] } ], "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--output", "aliases": [ "-o" ], "description": "Location to place the generated output.", "arguments": [ { "name": "output", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "metadata": [ { "name": "x-value-type", "value": "System.IO.FileInfo" } ] }, { "name": "--package", "description": "Filters the templates based on NuGet package ID.", "arguments": [ { "name": "PACKAGE", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--project", "description": "The project that should be used for context evaluation.", "arguments": [ { "name": "project", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "metadata": [ { "name": "x-value-type", "value": "System.IO.FileInfo" } ] }, { "name": "--tag", "description": "Filters the templates based on the tag.", "arguments": [ { "name": "TAG", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--type", "description": "Filters templates based on available types. Predefined values are \"project\" and \"item\".", "arguments": [ { "name": "TYPE", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--verbosity", "aliases": [ "-v" ], "description": "Sets the verbosity level. Allowed values are q[uiet], m[inimal], n[ormal], and diag[nostic].", "arguments": [ { "name": "LEVEL", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "recursive": true, "metadata": [ { "name": "x-value-type", "value": "Microsoft.DotNet.Cli.Utils.VerbosityOptions" }, { "name": "x-default", "value": "normal" } ] } ], "commands": [ { "name": "--alias", "aliases": [ "-a" ], "description": "Creates an alias for instantiate command with a certain set of arguments.", "hidden": true }, { "name": "--install", "aliases": [ "-i" ], "description": "Installs a template package.", "hidden": true, "arguments": [ { "name": "package", "required": true, "arity": { "minimum": 1, "maximum": 99 }, "description": "NuGet package ID or path to folder or NuGet package to install. \nTo install the NuGet package of certain version, use ::.\n", "metadata": [ { "name": "x-value-type", "value": "System.String[]" } ] } ], "options": [ { "name": "--add-source", "aliases": [ "--nuget-source" ], "description": "Specifies a NuGet source to use.", "arguments": [ { "name": "nuget-source", "required": true, "arity": { "minimum": 1, "maximum": 99 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String[]" } ] }, { "name": "--force", "description": "Allows installing template packages from the specified sources even if they would override a template package from another source.", "arguments": [ { "name": "FORCE", "required": false, "arity": { "minimum": 0, "maximum": 1 }, "acceptedValues": [ "true", "false" ] } ], "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--interactive", "description": "Allows the command to stop and wait for user input or action (for example to complete authentication).", "arguments": [ { "name": "INTERACTIVE", "required": false, "arity": { "minimum": 0, "maximum": 1 }, "acceptedValues": [ "true", "false" ] } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] } ] }, { "name": "--list", "aliases": [ "-l" ], "description": "Lists templates containing the specified template name. If no name is specified, lists all templates.", "hidden": true, "arguments": [ { "name": "template-name", "arity": { "minimum": 0, "maximum": 1 }, "description": "If specified, only the templates matching the name will be shown.", "metadata": [ { "name": "x-value-type", "value": "System.String" } ] } ], "options": [ { "name": "--author", "description": "Filters the templates based on the template author.", "arguments": [ { "name": "AUTHOR", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--baseline", "description": "Filters the templates based on baseline defined in the template.", "arguments": [ { "name": "BASELINE", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--columns", "description": "Specifies the columns to display in the output. ", "arguments": [ { "name": "COLUMNS", "required": true, "arity": { "minimum": 1, "maximum": 4 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String[]" } ] }, { "name": "--columns-all", "description": "Displays all columns in the output.", "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--ignore-constraints", "description": "Disables checking if the template meets the constraints to be run.", "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--language", "aliases": [ "-lang" ], "description": "Filters templates based on language.", "arguments": [ { "name": "LANGUAGE", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--output", "aliases": [ "-o" ], "description": "Location to place the generated output.", "arguments": [ { "name": "OUTPUT", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "metadata": [ { "name": "x-value-type", "value": "System.IO.FileInfo" } ] }, { "name": "--package", "description": "Filters the templates based on NuGet package ID.", "arguments": [ { "name": "PACKAGE", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--project", "description": "The project that should be used for context evaluation.", "arguments": [ { "name": "PROJECT", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "metadata": [ { "name": "x-value-type", "value": "System.IO.FileInfo" } ] }, { "name": "--tag", "description": "Filters the templates based on the tag.", "arguments": [ { "name": "TAG", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--type", "description": "Filters templates based on available types. Predefined values are \"project\" and \"item\".", "arguments": [ { "name": "TYPE", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String" } ] } ] }, { "name": "--search", "description": "Searches for the templates on NuGet.org.", "hidden": true, "arguments": [ { "name": "template-name", "arity": { "minimum": 0, "maximum": 1 }, "description": "If specified, only the templates matching the name will be shown.", "metadata": [ { "name": "x-value-type", "value": "System.String" } ] } ], "options": [ { "name": "--author", "description": "Filters the templates based on the template author.", "arguments": [ { "name": "AUTHOR", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--baseline", "description": "Filters the templates based on baseline defined in the template.", "arguments": [ { "name": "BASELINE", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--columns", "description": "Specifies the columns to display in the output. ", "arguments": [ { "name": "COLUMNS", "required": true, "arity": { "minimum": 1, "maximum": 4 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String[]" } ] }, { "name": "--columns-all", "description": "Displays all columns in the output.", "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] }, { "name": "--language", "aliases": [ "-lang" ], "description": "Filters templates based on language.", "arguments": [ { "name": "LANGUAGE", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--package", "description": "Filters the templates based on NuGet package ID.", "arguments": [ { "name": "PACKAGE", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--tag", "description": "Filters the templates based on the tag.", "arguments": [ { "name": "TAG", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String" } ] }, { "name": "--type", "description": "Filters templates based on available types. Predefined values are \"project\" and \"item\".", "arguments": [ { "name": "TYPE", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String" } ] } ] }, { "name": "--show-alias", "description": "Displays defined aliases.", "hidden": true }, { "name": "--uninstall", "aliases": [ "-u" ], "description": "Uninstalls a template package.", "hidden": true, "arguments": [ { "name": "package", "arity": { "minimum": 0, "maximum": 99 }, "description": "NuGet package ID (without version) or path to folder to uninstall. \nIf command is specified without the argument, it lists all the template packages installed.", "metadata": [ { "name": "x-value-type", "value": "System.String[]" } ] } ] }, { "name": "--update-apply", "description": "Checks the currently installed template packages for update, and install the updates.", "hidden": true, "options": [ { "name": "--add-source", "aliases": [ "--nuget-source" ], "description": "Specifies a NuGet source to use.", "arguments": [ { "name": "nuget-source", "required": true, "arity": { "minimum": 1, "maximum": 99 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String[]" } ] }, { "name": "--interactive", "description": "Allows the command to stop and wait for user input or action (for example to complete authentication).", "arguments": [ { "name": "INTERACTIVE", "required": false, "arity": { "minimum": 0, "maximum": 1 }, "acceptedValues": [ "true", "false" ] } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] } ] }, { "name": "--update-check", "description": "Checks the currently installed template packages for updates.", "hidden": true, "options": [ { "name": "--add-source", "aliases": [ "--nuget-source" ], "description": "Specifies a NuGet source to use.", "arguments": [ { "name": "nuget-source", "required": true, "arity": { "minimum": 1, "maximum": 99 } } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.String[]" } ] }, { "name": "--interactive", "description": "Allows the command to stop and wait for user input or action (for example to complete authentication).", "arguments": [ { "name": "INTERACTIVE", "required": false, "arity": { "minimum": 0, "maximum": 1 }, "acceptedValues": [ "true", "false" ] } ], "hidden": true, "metadata": [ { "name": "x-value-type", "value": "System.Boolean" }, { "name": "x-default", "value": false } ] } ] }, { "name": "alias", "description": "Creates or displays defined aliases.", "hidden": true, "commands": [ { "name": "add", "description": "Creates an alias for instantiate command with a certain set of arguments.", "hidden": true }, { "name": "show", "description": "Displays defined aliases.", "hidden": true } ] }, { "name": "create", "description": "Instantiates a template with given short name. An alias of 'dotnet new