命令列介面 (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 <file1> <file2> |
開啟檔案差異編輯器。需要兩個檔案路徑作為引數。 |
-m 或 --merge <path1> <path2> <base> <result> |
透過提供一個檔案的兩個修改版本的路徑、兩個修改版本的共同原始版本路徑以及用於儲存合併結果的輸出檔案路徑,來執行三向合併。 |
-w 或 --wait |
等待檔案被關閉後再返回。 |
--locale <locale> |
為 VS Code 會話設定顯示語言 (locale)。(例如,en-US 或 zh-CN ) |
開啟檔案和資料夾
有時你會想要開啟或建立一個檔案。如果指定的檔案不存在,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 <extension-id> | <extension-vsix-path> |
安裝或更新一個擴充套件。提供完整的副檔名稱 publisher.extension 或 VSIX 檔案的路徑作為引數。要安裝特定版本,請附加 @{version} 。例如:vscode.csharp@1.2.3 。使用 --force 引數來避擴音示。使用 --profile 引數為某個特定的配置檔案安裝。 |
--uninstall-extension <extension-id> |
解除安裝一個擴充套件。提供完整的副檔名稱 publisher.extension 作為引數。使用 --profile 引數為某個特定的配置檔案解除安裝。 |
--disable-extensions |
停用所有已安裝的擴充套件。擴充套件仍將在擴充套件檢視的已停用部分中可見,但它們永遠不會被啟用。 |
--list-extensions |
列出已安裝的擴充套件。可以使用 --profile 引數來列出某個特定配置檔案的擴充套件。 |
--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> |
為多根工作區將資料夾新增到最後一個活動的視窗。 |
--remove <dir> |
為多根工作區從最後一個活動的視窗中移除資料夾。 |
建立遠端隧道
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 有一個便攜模式,它允許你將設定和資料儲存在與你的安裝位置相同的地方,例如,在一個 U 盤上。
如何檢測一個 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
的值。