命令行界面 (CLI)
Visual Studio Code 内置了强大的命令行界面,可让您控制如何启动编辑器。您可以通过命令行选项(开关)打开文件、安装扩展、更改显示语言以及输出诊断信息。
如果您正在寻找如何在 VS Code 内部运行命令行工具,请参阅集成终端。
命令行帮助
要获取 VS Code 命令行界面的概述,请打开终端或命令提示符并输入 code --help
。您将看到版本、使用示例和命令行选项列表。
从命令行启动
您可以从命令行启动 VS Code,以快速打开文件、文件夹或项目。通常,您会在文件夹的上下文中打开 VS Code。为此,请从打开的终端或命令提示符导航到您的项目文件夹并输入 code .
注意:macOS 用户必须首先运行一个命令(Shell 命令:在 PATH 中安装 'code' 命令)以将 VS Code 可执行文件添加到 PATH
环境变量。请阅读macOS 设置指南以获取帮助。
Windows 和 Linux 安装应将 VS Code 二进制文件位置添加到您的系统路径。如果未添加,您可以手动将该位置添加到 Path
环境变量(Linux 上为 $PATH
)。例如,在 Windows 上,默认的 VS Code 二进制文件位置是 AppData\Local\Programs\Microsoft VS Code\bin
。要查看特定于平台的安装说明,请参阅设置。
Insiders 版:如果您正在使用 VS Code Insiders 预览版,您可以使用
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 <文件1> <文件2> |
打开文件差异编辑器。需要两个文件路径作为参数。 |
-m 或 --merge <路径1> <路径2> <基础> <结果> |
通过提供文件的两个修改版本、两个修改版本的共同源以及用于保存合并结果的输出文件的路径来执行三向合并。 |
-w 或 --wait |
等待文件关闭后再返回。 |
--locale <区域设置> |
为 VS Code 会话设置显示语言(区域设置)。(例如,en-US 或 zh-TW ) |
打开文件和文件夹
有时您会想要打开或创建文件。如果指定的文件不存在,VS Code 将为您创建它们以及任何新的中间文件夹
code index.html style.css documentation\readme.md
对于文件和文件夹,您可以使用绝对路径或相对路径。相对路径是相对于您运行 code
命令的命令提示符的当前目录。
如果您在命令行中指定多个文件,VS Code 将只打开一个实例。
如果您在命令行中指定多个文件夹,VS Code 将创建一个包含每个文件夹的多根工作区。
参数 | 描述 |
---|---|
文件 |
要打开的文件名。如果文件不存在,则会创建该文件并标记为已编辑。您可以通过用空格分隔每个文件名来指定多个文件。 |
文件:行[:字符] |
与 -g 参数一起使用。要在指定行和可选字符位置打开的文件名。 |
文件夹 |
要打开的文件夹名。您可以指定多个文件夹,并将创建一个新的多根工作区。 |
选择配置文件
您可以通过 --profile
命令行界面选项使用特定的配置文件启动 VS Code。在 --profile
参数之后传递配置文件的名称,然后使用该配置文件打开文件夹或工作区。下面的命令行使用“Web Development”配置文件打开 web-sample
文件夹
code ~/projects/web-sample --profile "Web Development"
如果指定的配置文件不存在,则会创建一个具有给定名称的新空配置文件。
使用扩展
您可以从命令行安装和管理 VS Code 扩展。
参数 | 描述 |
---|---|
--install-extension <扩展 ID> | <扩展 VSIX 路径> |
安装或更新扩展。提供完整的扩展名 publisher.extension 或 VSIX 文件的路径作为参数。要安装特定版本,请附加 @{version} 。例如:vscode.csharp@1.2.3 。使用 --force 参数以避免提示。使用 --profile 参数为特定配置文件安装。 |
--uninstall-extension <扩展 ID> |
卸载扩展。提供完整的扩展名 publisher.extension 作为参数。使用 --profile 参数为特定配置文件卸载。 |
--disable-extensions |
禁用所有已安装的扩展。扩展仍将在“扩展”视图的“已禁用”部分中可见,但它们永远不会被激活。 |
--list-extensions |
列出已安装的扩展。--profile 参数可用于列出特定配置文件中的扩展。 |
--show-versions |
使用 --list-extensions 时,显示已安装扩展的版本。 |
--enable-proposed-api <扩展> |
为扩展启用建议的 API 功能。提供完整的扩展名 publisher.extension 作为参数。 |
--update-extensions |
更新已安装的扩展并退出。 |
高级 CLI 选项
有几个 CLI 选项有助于重现错误和进行高级设置。
参数 | 描述 |
---|---|
--extensions-dir <目录> |
设置扩展的根路径。 在便携模式下,此设置会被 data 文件夹覆盖。 |
--user-data-dir <目录> |
指定用户数据存放的目录,在以 root 身份运行时很有用。 在便携模式下,此设置会被 data 文件夹覆盖。 |
-s, --status |
打印进程使用情况和诊断信息。 |
-p, --performance |
启动时启用开发人员:启动性能命令。 |
--disable-gpu |
禁用 GPU 硬件加速。 |
--verbose |
打印详细输出(隐含 --wait )。 |
--prof-startup |
在启动期间运行 CPU 性能分析器。 |
--upload-logs |
将当前会话的日志上传到安全端点。 |
多根 | |
--add <目录> |
将文件夹添加到上次活动窗口中,用于多根工作区。 |
--remove <目录> |
从上次活动窗口中移除文件夹,用于多根工作区。 |
创建远程隧道
VS Code 与其他远程环境集成,变得更加强大和灵活。我们的目标是提供一种统一的体验,让您可以通过一个统一的 CLI 管理本地和远程计算机。
Visual Studio Code Remote - Tunnels 扩展允许您通过安全隧道连接到远程计算机,如台式机或虚拟机。隧道安全地将数据从一个网络传输到另一个网络。然后,您无需 SSH 即可从任何地方安全地连接到该计算机。
我们已将功能内置到 code
CLI 中,该功能将在远程计算机上启动隧道。您可以运行
code tunnel
在您的远程计算机上创建隧道。您可以通过 Web 或桌面 VS Code 客户端连接到此计算机。
您可以通过运行 code tunnel -help
查看其他隧道命令。
由于您可能需要在无法安装 VS Code 桌面版的远程计算机上运行 CLI,因此 CLI 也可在 VS Code 下载页面上独立安装。
有关远程隧道的更多信息,请参阅远程隧道文档。
使用 URL 打开 VS Code
您还可以使用平台的 URL 处理机制打开项目和文件。使用以下 URL 格式来:
打开项目
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
您可以在能够解析和重定向 URL 的应用程序(例如浏览器或文件资源管理器)中使用该 URL。例如,在 Windows 上,您可以将 vscode://
URL 直接传递给 Windows 文件资源管理器或命令行,如 start vscode://{文件的完整路径}
。
注意:如果您使用的是 VS Code Insiders 构建,URL 前缀是
vscode-insiders://
。
后续步骤
继续阅读以了解:
常见问题
'code' 不是内部或外部命令
您的操作系统无法在其路径中找到 VS Code 二进制文件 code
。VS Code 的 Windows 和 Linux 安装应该已将 VS Code 安装到您的路径中。尝试卸载并重新安装 VS Code。如果仍找不到 code
,请查阅Windows 和 Linux 的特定平台设置主题。
在 macOS 上,您需要手动运行Shell 命令:在 PATH 中安装 'code' 命令命令(通过命令面板 ⇧⌘P (Windows, Linux Ctrl+Shift+P) 可用)。有关详细信息,请查阅macOS 特定设置主题。
如何从 VS Code 内部访问命令行(终端)?
VS Code 有一个集成终端,您可以在其中从 VS Code 内部运行命令行工具。
我可以指定 VS Code 的设置位置以实现便携版吗?
不能直接通过命令行指定,但 VS Code 具有便携模式,该模式允许您将设置和数据与安装文件保存在同一位置,例如在 USB 驱动器上。
如何检测 Shell 是否由 VS Code 启动?
当 VS Code 启动时,它可能会启动一个 shell 以获取“shell 环境”来帮助设置工具。这将启动一个交互式登录 shell 并获取其环境。根据您的 shell 设置,这可能会导致问题。例如,shell 以交互式会话启动可能出乎意料,而 VS Code 需要它才能尝试将 $PATH
与用户创建终端中的确切值对齐。
每当 VS Code 启动这个初始 shell 时,VS Code 会将变量 VSCODE_RESOLVING_ENVIRONMENT
设置为 1
。如果您的 shell 或用户脚本需要知道它们是否在此 shell 的上下文中运行,您可以检查 VSCODE_RESOLVING_ENVIRONMENT
的值。