VS Code命令行界面（CLI）使用指南

VS Code命令行界面（CLI）使用指南

Visual Studio Code（VS Code）的命令行界面（CLI）功能强大，允许用户通过命令行控制编辑器的启动方式。用户可以通过CLI打开文件、安装扩展、更改显示语言和输出诊断信息等。本文将详细介绍VS Code的CLI使用方法。

命令行界面 (CLI)

Visual Studio Code 内置了强大的命令行界面，让您可以控制编辑器的启动方式。您可以使用命令行选项（开关）打开文件、安装扩展、更改显示语言和输出诊断信息。
如果您想了解如何在 VS Code 中运行命令行工具，请参阅集成终端。

命令行帮助

要了解 VS Code 命令行界面的概述，请打开终端或命令提示符并键入
code --help
。您将看到版本、使用示例和命令行选项列表。

从命令行启动

您可以从命令行启动 VS Code，以快速打开文件、文件夹或项目。通常，您在文件夹的上下文中打开 VS Code。为此，从打开的终端或命令提示符中，导航到您的项目文件夹并键入
code .
注意：macOS 用户必须首先运行命令（Shell Command: Install 'code' command in PATH）才能将 VS Code 可执行文件添加到
PATH
环境变量。请阅读macOS 设置指南以获取帮助。
Windows 和 Linux 安装程序应将 VS Code 二进制文件位置添加到您的系统路径。如果不是这种情况，您可以手动将该位置添加到
Path
环境变量（Linux 上为
$PATH
）。例如，在 Windows 上，默认的 VS Code 二进制文件位置是
AppData\Local\Programs\Microsoft VS Code\bin
。要查看特定于平台的设置说明，请参阅设置。
Insiders 版本：如果您正在使用 VS CodeInsiders预览版，您可以使用
code-insiders
启动 Insiders 版本。

核心 CLI 选项

以下是您在通过
code
从命令行启动 VS Code 时可以使用的可选参数
参数 描述
-h或--help 打印用法
-v或--version 打印 VS Code 版本（例如，1.22.2）、GitHub 提交 ID 和架构（例如，x64）。
-n或--new-window 打开 VS Code 的新会话，而不是恢复之前的会话（默认）。
-r或--reuse-window 强制在上次活动的窗口中打开文件或文件夹。
-g或--goto 与file:line{:character}一起使用时，在指定的行和可选字符位置打开文件。提供此参数是因为某些操作系统允许文件名中包含:。
-d或--diff 打开文件差异编辑器。需要两个文件路径作为参数。
-m或--merge 通过提供文件的两个修改版本的路径、两个修改版本的共同来源以及用于保存合并结果的输出文件，执行三向合并。
-w或--wait 等待文件关闭后再返回。
--locale 设置 VS Code 会话的显示语言（区域设置）。（例如，en-US或zh-TW）

打开文件和文件夹

有时您可能想要打开或创建文件。如果指定的文件不存在，VS Code 将为您创建它们以及任何新的中间文件夹

  
code index.html style.css documentation\readme.md
  

对于文件和文件夹，您都可以使用绝对路径或相对路径。相对路径相对于您运行
code
命令的命令提示符的当前目录。
如果您在命令行中指定多个文件，VS Code 将仅打开一个实例。
如果您在命令行中指定多个文件夹，VS Code 将创建一个包含每个文件夹的多根工作区。
参数 描述
file 要打开的文件名。如果文件不存在，它将被创建并标记为已编辑。您可以通过空格分隔每个文件名来指定多个文件。
file:line[:character] 与-g参数一起使用。要在指定的行和可选字符位置打开的文件名。
folder 要打开的文件夹名称。您可以指定多个文件夹，并且会创建一个新的多根工作区。

选择配置文件

您可以通过
--profile
命令行界面选项使用特定的配置文件启动 VS Code。您在
--profile
参数后传递配置文件的名称，并使用该配置文件打开文件夹或工作区。以下命令行使用“Web Development”配置文件打开
web-sample
文件夹
code ~/projects/web-sample --profile "Web Development"
如果指定的配置文件不存在，则会创建一个具有给定名称的新空配置文件。

使用扩展

您可以从命令行安装和管理 VS Code扩展。
参数 描述
--install-extension 安装扩展。提供完整的扩展名称publisher.extension作为参数。使用--force参数以避免提示。
--uninstall-extension 卸载扩展。提供完整的扩展名称publisher.extension作为参数。
--disable-extensions 禁用所有已安装的扩展。扩展程序仍将在扩展视图的“已禁用”部分中可见，但永远不会被激活。
--list-extensions 列出已安装的扩展。
--show-versions 使用--list-extensions时，显示已安装扩展的版本
--enable-proposed-api 为扩展启用建议的 API 功能。提供完整的扩展名称publisher.extension作为参数。
--update-extensions 更新已安装的扩展并退出。

高级 CLI 选项

有几个 CLI 选项可以帮助重现错误和进行高级设置。
参数 描述
--extensions-dir

  
code tunnel
  

  
vscode://file/{full path to project}/
vscode://file/c:/myProject/
  

  
vscode://file/{full path to file}
vscode://file/c:/myProject/package.json
  

  
vscode://file/{full path to file}:line:column
vscode://file/c:/myProject/package.json:5:10
  

  
vscode://settings/setting.name
vscode://settings/editor.wordWrap