dotnet-vs 1.2.0

dotnet-vs

一个全局工具，用于运行、管理和查询 Visual Studio 安装

安装或更新（两者使用相同命令）

dotnet tool update -g dotnet-vs

获取 CI 版本

dotnet tool update -g dotnet-vs --no-cache --add-source https://pkg.kzu.io/index.json

命令行解析使用 Mono.Options 完成，因此支持以下所有参数变体： -flag，--flag，/flag，-flag=value，--flag=value，/flag=value，-flag:value，--flag:value，/flag:value，-flag value，--flag value，/flag value。

支持命令

别名

显示已保存别名的列表

Usage: vs alias [options]

所有内置命令都支持 -save:[alias] 选项，这将使该命令以该别命名保存。从那时起，只需运行该别名即可运行命令（包括所有已保存参数），而不需要运行命令本身。

示例

# Save the first VS enterprise with the Xamarin/Mobile workload as the "mobile" alias
> vs -sku:ent -first +mobile -save:mobile

# Runs the saved alias with all the original arguments
> vs mobile

客户端

在客户端模式下启动 Visual Studio

Usage: vs client [options]

选项	描述
rel | release	运行发布版本
pre | preview	运行预览版本
int | internal	运行内部版本（也称为“dogfood”）
sku	版本，以下之一：e | ent | enterprise，p | pro | professional，c | com | community，b | build | buildtools 或 t | test | testagent
filter	过滤 VS 实例的表达式。例如 x => x.InstanceId = '123'
first	运行第一个匹配的实例
exp | experimental	运行实验性实例而不是常规版本
w | workspaceId	要连接的工作区 ID

config

打开配置文件夹。

Usage: vs config [options]

选项	描述
rel | release	打开发布版本
pre | preview	打开预览版本
int | internal	打开内部版本（即“内部测试”版本）
sku	版本，以下之一：e | ent | enterprise，p | pro | professional，c | com | community，b | build | buildtools 或 t | test | testagent
filter	过滤 VS 实例的表达式。例如 x => x.InstanceId = '123'
first	打开第一个匹配的实例。
exp | experimental	打开实验性实例而不是常规版本。

安装

安装特定版本的Visual Studio。

Usage: vs install [options]

选项	描述
rel | release	安装发布版本
pre | preview	安装预览版本
int | internal	安装内部版本（即“内部测试”版本）
sku	版本，以下之一：e | ent | enterprise，p | pro | professional，c | com | community，b | build | buildtools 或 t | test | testagent
filter	过滤 VS 实例的表达式。例如 x => x.InstanceId = '123'
添加	一个工作负载ID

您可以使用支持的工作负载开关，使用+前缀添加特定的工作负载ID。

请参阅Visual Studio安装程序命令行选项文档，了解可以提供的完整参数列表。

常见选项包括--passive、quiet和--wait等。

示例

# Installs VS enterprise with the Maui/Mobile workload
# Note the -sku: switch/prefix is optional
> vs install Enterprise +mobile

# Install VS community with the .NET Core, ASP.NET and Azure workloads, 
# shows installation progress and waits for it to finish before returning
> vs install +core +web +azure

终止

终止正在运行devenv进程。

Usage: vs kill [options]

选项	描述
rel | release	终止发布版本
pre | preview	终止预览版本
int | internal	终止内部版本（即“内部测试”版本）
sku	版本，以下之一：e | ent | enterprise，p | pro | professional，c | com | community，b | build | buildtools 或 t | test | testagent
filter	过滤 VS 实例的表达式。例如 x => x.InstanceId = '123'
exp | experimental	终止实验性实例而不是常规版本。
first	终止第一个匹配的实例。
所有	终止所有实例。

示例

# Kill all running instances of Visual Studio
> vs kill all

日志

打开包含Activity.log文件的文件夹。

Usage: vs log [options]

选项	描述
rel | release	打开发布版本
pre | preview	打开预览版本
int | internal	打开内部版本（即“内部测试”版本）
sku	版本，以下之一：e | ent | enterprise，p | pro | professional，c | com | community，b | build | buildtools 或 t | test | testagent
filter	过滤 VS 实例的表达式。例如 x => x.InstanceId = '123'
first	打开第一个匹配的实例。
exp | experimental	打开实验性实例而不是常规版本。

修改

修改Visual Studio的安装。

Usage: vs modify [options]

选项	描述
rel | release	修改发布版本
pre | preview	修改预览版本
int | internal	修改内部版本（即“内部测试”版本）
sku	版本，以下之一：e | ent | enterprise，p | pro | professional，c | com | community，b | build | buildtools 或 t | test | testagent
filter	过滤 VS 实例的表达式。例如 x => x.InstanceId = '123'
first	修改第一个匹配的实例。
添加	一个工作负载ID
删除	一个工作负载ID

通过支持的工作负载ID开关/别名，可以使用简写表示法add|remove [workload ID]，使用+（对应于add）和-（对应于remove）前缀。

示例

# Add .NET Core Workload to installed Visual Studio Preview
> vs modify preview +core

运行

这是默认命令，因此通常不需要作为参数提供。

Usage: vs run [options]

选项	描述
rel | release	运行发布版本
pre | preview	运行预览版本
int | internal	运行内部版本（即“内部测试”版本）
sku	版本，以下之一：e | ent | enterprise，p | pro | professional，c | com | community，b | build | buildtools 或 t | test | testagent
filter	过滤 VS 实例的表达式。例如 x => x.InstanceId = '123'
exp | experimental	运行实验性实例而不是常规版本。
id	通过ID运行特定实例
f\|first	如果有多个匹配实例，按降序版本运行第一个。
v\|version	运行特定的（语义）版本，例如16.4或16.5.3。
w\|wait	等待启动的Visual Studio退出。
nr\|nodereuse	禁用MSBuild节点重用。当测试分析程序、任务和目标时很有用。默认情况下，在运行实验性实例时为true。
默认	在没有提供参数时设置默认运行版本，或删除当前默认版本（使用--default-）。
需要	一个工作负载ID

所有工作负载开关都可用，也可以通过使用+前缀/别名语法来过滤要运行的实例，包括使用+前缀（见下文）。

此命令将记住最后定位和运行的VS。因此，下次只需使用vs即可运行同一实例（因为run是默认命令，可以省略）。

示例

# Runs the first VS enterprise with the Maui workload
> vs -sku:ent -first +maui

# Runs VS 16.8
> vs -v:16.8

# Runs VS 16.9 preview
> vs -v:16.9 -pre

# Runs the last VS that was run
> vs

更新

更新Visual Studio的安装。

Usage: vs update [options]

选项	描述
rel | release	更新发布版本
pre | preview	更新预览版本
int | internal	更新内部版本（即“内部测试”版本）
sku	版本，以下之一：e | ent | enterprise，p | pro | professional，c | com | community，b | build | buildtools 或 t | test | testagent
filter	过滤 VS 实例的表达式。例如 x => x.InstanceId = '123'
first	更新第一个匹配的实例。
所有	更新所有实例。

位置

查找满足请求要求的Visual Studio已安装版本，可选项是从中检索安装属性。

Usage: vs where [options]

选项	描述
rel | release	显示发布版本
pre | preview	显示预览版本
int | internal	显示内部版本（即“内部测试”版本）
sku	版本，以下之一：e | ent | enterprise，p | pro | professional，c | com | community，b | build | buildtools 或 t | test | testagent
filter	过滤 VS 实例的表达式。例如 x => x.InstanceId = '123'
first	显示第一个匹配的实例。
prop\|property	要返回的属性名称
列表	以列表形式显示结果
需要	一个工作负载ID

支持与vswhere.exe相同的选项

  -all           Finds all instances even if they are incomplete and may not launch.
  -prerelease    Also searches prereleases. By default, only releases are searched.
  -products arg  One or more product IDs to find. Defaults to Community, Professional, and Enterprise.
                 Specify "*" by itself to search all product instances installed.
                 See https://aka.ms/vs/workloads for a list of product IDs.
  -requires arg  One or more workload or component IDs required when finding instances.
                 All specified IDs must be installed unless -requiresAny is specified.
                 See https://aka.ms/vs/workloads for a list of workload and component IDs.
  -requiresAny   Find instances with any one or more workload or components IDs passed to -requires.
  -version arg   A version range for instances to find. Example: [15.0,16.0) will find versions 15.*.
  -latest        Return only the newest version and last installed.
  -sort          Sorts the instances from newest version and last installed to oldest.
                 When used with "find", first instances are sorted then files are sorted lexigraphically.
  -legacy        Also searches Visual Studio 2015 and older products. Information is limited.
                 This option cannot be used with either -products or -requires.
  -format arg    Return information about instances found in a format described below.
  -property arg  The name of a property to return. Defaults to "value" format.
                 Use delimiters ".", "/", or "_" to separate object and property names.
                 Example: "properties.nickname" will return the "nickname" property under "properties".
  -include arg   One or more extra properties to include, as described below.
  -find arg      Returns matching file paths under the installation path. Defaults to "value" format.
                 The following patterns are supported:
                 ?  Matches any one character except "\".
                 *  Matches zero or more characters except "\".
                 ** Searches the current directory and subdirectories for the remaining search pattern.
  -nologo        Do not show logo information. Some formats noted below will not show a logo anyway.
  -utf8          Use UTF-8 encoding (recommended for JSON).
  -?, -h, -help  Display this help message.


Extra properties:
  packages       Return an array of packages installed in this instance.
                 Supported only by the "json" and "xml" formats.

Formats:
  json           An array of JSON objects for each instance (no logo).
  text           Colon-delimited properties in separate blocks for each instance (default).
  value          A single property specified by the -property parameter (no logo).
  xml            An XML data set containing instances (no logo).

通过支持的工作负载ID，可以提供简写表示法-requires [workload ID]，使用+前缀（见下文）。

另请参阅GitHub上的vswhere。

工作负载ID开关

对于接收工作负载ID转换的命令（例如，vs where -requires [WORKLOAD_ID] 或 vs install --add [WORKLOAD_ID]），以下别名可用：

别名	工作负载ID
mobile	Microsoft.VisualStudio.Workload.NetCrossPlat
xamarin	Microsoft.VisualStudio.Workload.NetCrossPlat
maui	Microsoft.VisualStudio.Workload.NetCrossPlat
core	Microsoft.NetCore.Component.DevelopmentTools
azure	Microsoft.VisualStudio.Workload.Azure
data	Microsoft.VisualStudio.Workload.Data
desktop	Microsoft.VisualStudio.Workload.ManagedDesktop
unity	Microsoft.VisualStudio.Workload.ManagedGame
native	Microsoft.VisualStudio.Workload.NativeDesktop
web	Microsoft.VisualStudio.Workload.NetWeb
node	Microsoft.VisualStudio.Workload.Node
office	Microsoft.VisualStudio.Workload.Office
py	Microsoft.VisualStudio.Workload.Python
python	Microsoft.VisualStudio.Workload.Python
uwp	Microsoft.VisualStudio.Workload.Universal
vsx	Microsoft.VisualStudio.Workload.VisualStudioExtension

别名会自动转换到适当的转换，例如，转换到 -requires [ID] 或 --add [ID]。另外，根据正在运行的命令，别名可能会使用一个 + 前缀（如 +mobile），这可能使命令行更直观，例如 vs install +mobile -sku:enterprise 或 vs +mobile（运行安装了移动工作负载的 VS）。例如，modify 命令使用 + 和 - 前缀来分别添加或删除工作负载。

赞助商

 

了解有关GitHub Sponsors的更多信息