命令列介面 (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
。若要檢閱平台特定的設定指示,請參閱安裝設定。
預覽人員:如果您使用的是 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 <地區設定> |
設定 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 <擴充功能> |
安裝擴充功能。提供完整的擴充功能名稱 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 <目錄> |
設定擴充功能的根路徑。 在可攜模式中由 data 資料夾覆寫。 |
--user-data-dir <目錄> |
指定使用者資料的存放目錄,以根使用者身分執行時很有用。 在可攜模式中由 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 擴充功能可讓您透過安全通道連線至遠端電腦,例如桌上型電腦或 VM。通道會安全地將資料從一個網路傳輸到另一個網路。然後,您可以從任何地方安全地連線到該電腦,而無需 SSH。
我們已在 code
CLI 中建置功能,可在遠端電腦上啟動通道。您可以執行
code tunnel
在您的遠端電腦上建立通道。您可以透過網頁版或桌機版 VS Code 用戶端連線至此電腦。
您可以執行 code tunnel -help
來檢閱其他通道命令
因為您可能需要在無法安裝 VS Code Desktop 的遠端電腦上執行 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://{full path to file}
。
注意:如果您使用的是 VS Code Insiders 組建,URL 前置詞為
vscode-insiders://
。
後續步驟
繼續閱讀以了解
常見問題
'code' 無法辨識為內部或外部命令
您的作業系統在其路徑中找不到 VS Code 二進位檔 code
。VS Code Windows 和 Linux 安裝程式應已在您的路徑中安裝 VS Code。嘗試解除安裝並重新安裝 VS Code。如果仍然找不到 code
,請參閱 Windows 和 Linux 的平台特定設定主題,網址分別為Windows 和 Linux。
在 macOS 上,您需要手動執行 [Shell Command: Install 'code' command in PATH] 命令 (可透過 [命令面板] 取得 ⇧⌘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
值。