命令行界面 (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
。要查看特定于平台的设置说明,请参阅 安装。
内部人员:如果您使用的是 VS Code 内部人员 预览版,则可以使用
code-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 <file1> <file2> |
打开文件差异编辑器。需要两个文件路径作为参数。 |
-m 或 --merge <path1> <path2> <base> <result> |
通过提供文件的两个修改版本、两个修改版本的共同来源以及保存合并结果的输出文件的路径来执行三方合并。 |
-w 或 --wait |
等待文件关闭后再返回。 |
--locale <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 开发”配置文件打开 web-sample
文件夹。
code ~/projects/web-sample --profile "Web Development"
如果指定的配置文件不存在,将创建一个具有给定名称的新空配置文件。
使用扩展
您可以从命令行安装和管理 VS Code 扩展。
参数 | 描述 |
---|---|
--install-extension <ext> |
安装扩展。提供完整的扩展名称 publisher.extension 作为参数。使用 --force 参数来避免提示。 |
--uninstall-extension <ext> |
卸载扩展。提供完整的扩展名称 publisher.extension 作为参数。 |
--disable-extensions |
禁用所有已安装的扩展。扩展仍然会在“禁用”部分的扩展视图中显示,但它们永远不会被激活。 |
--list-extensions |
列出已安装的扩展。 |
--show-versions |
在使用 --list-extensions 时,显示已安装扩展的版本。 |
--enable-proposed-api <ext> |
为扩展启用建议的 API 功能。提供完整的扩展名称 publisher.extension 作为参数。 |
--update-extensions |
更新已安装的扩展并退出。 |
高级 CLI 选项
有一些 CLI 选项可以帮助您再现错误和高级设置。
参数 | 描述 |
---|---|
--extensions-dir <dir> |
设置扩展的根路径。 在 便携模式 中被 data 文件夹覆盖。 |
--user-data-dir <dir> |
指定保存用户数据的目录,在以 root 身份运行时很有用。 在 便携模式 中被 data 文件夹覆盖。 |
-s, --status |
打印进程使用情况和诊断信息。 |
-p, --performance |
在启用 开发者:启动性能 命令的情况下启动。 |
--disable-gpu |
禁用 GPU 硬件加速。 |
--verbose |
打印详细输出(意味着 --wait )。 |
--prof-startup |
在启动期间运行 CPU 分析器。 |
--upload-logs |
将当前会话的日志上传到安全端点。 |
多根 | |
--add <dir> |
将文件夹添加到最后一个活动窗口,用于多根工作区。 |
创建远程隧道
VS Code 与其他 远程环境 集成,使其更加强大和灵活。我们的目标是提供一个统一的体验,使您能够从一个统一的 CLI 管理本地和远程机器。
Visual Studio Code 的 远程 - 隧道 扩展允许您通过安全的隧道连接到远程机器,例如台式电脑或虚拟机。隧道安全地将数据从一个网络传输到另一个网络。然后,您可以安全地从任何地方连接到该机器,而无需 SSH。
我们在 `code` 命令行工具中构建了功能,可以启动远程机器上的隧道。您可以运行
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 驱动器上。
如何检测何时由 VS Code 启动 Shell?
当 VS Code 启动时,它可能会启动一个 Shell 以便获取“Shell 环境”以帮助设置工具。这将启动一个 **交互式登录** Shell 并获取其环境。根据您的 Shell 设置,这可能会导致问题。例如,Shell 作为交互式会话启动可能出乎意料,VS Code 需要交互式会话才能尝试将 `$PATH` 与用户创建的终端中的确切值对齐。
每当 VS Code 启动此初始 Shell 时,VS Code 都会将变量 `VSCODE_RESOLVING_ENVIRONMENT` 设置为 `1`。如果您的 Shell 或用户脚本需要知道它们是否是在此 Shell 的上下文中运行,您可以检查 `VSCODE_RESOLVING_ENVIRONMENT` 值。