This extension provides rich PowerShell language support for Visual Studio Code (VS Code). Now you can write and debug PowerShell scripts using the excellent IDE-like interface that VS Code provides.
This extension is powered by the PowerShell language server,
PowerShell Editor Services.
This leverages the
Language Server Protocol
where PowerShellEditorServices
is the server and vscode-powershell
is the client.
Also included in this extension is the PowerShell ISE theme for Visual Studio Code. It is not activated by default, but after installing this extension either click "Set Color Theme" or use the theme picker and select "PowerShell ISE" for a fun and familiar experience.
The extension should work anywhere VS Code itself and PowerShell Core 7.2 or higher is supported. For Windows PowerShell, only version 5.1 is supported. Please note that PowerShell Core 6, 7.0, and 7.1 have reached end-of-support. Our test matrix includes the following:
- Windows Server 2022 with Windows PowerShell 5.1 and PowerShell Core 7.2.11
- Windows Server 2019 with Windows PowerShell 5.1 and PowerShell Core 7.2.11
- macOS 11 with PowerShell Core 7.2.11
- Ubuntu 20.04 with PowerShell Core 7.2.11
Read the installation instructions to get more details on how to use the extension on these platforms.
For Windows PowerShell 5.1, .NET Framework 4.8 or higher is required.
Read the troubleshooting guide for answers to common questions.
- Syntax highlighting
- Code snippets
- IntelliSense for cmdlets and more
- Rule-based analysis provided by PowerShell Script Analyzer
- Go to Definition of cmdlets and variables
- Find References of cmdlets and variables
- Document and workspace symbol discovery
- Run selected selection of PowerShell code using F8
- Launch online help for the symbol under the cursor using Ctrl+F1
- Local script debugging
- Extension Terminal support
- PowerShell ISE color theme
You can install the official release of the PowerShell extension by following the steps in the Visual Studio Code documentation. In the Extensions pane, search for "PowerShell" extension and install it there. You will get notified automatically about any future extension updates!
You can also install a VSIX package from our releases page by following the Install from a VSIX instructions. The easiest way is through the command line:
code --install-extension powershell-<version>.vsix
NOTE: If you are using VS Code Insiders, the command will be
code-insiders
.
If you're on Windows 7 or greater with the PowerShellGet module installed, you can easily install both Visual Studio Code and the PowerShell extension by running the following command:
Install-Script Install-VSCode -Scope CurrentUser; Install-VSCode.ps1
You will need to accept the prompts that appear if this is your first time running
the Install-Script
command.
Alternatively you can download and execute the script directly from the web
without the use of Install-Script
. However we highly recommend that you
read the script
first before running it in this way!
iex (iwr https://raw.githubusercontent.com/PowerShell/vscode-powershell/main/scripts/Install-VSCode.ps1)
If you experience any problems with the PowerShell Extension, see the troubleshooting docs for information on diagnosing and reporting issues.
For any security issues, please see here.
There are some example scripts in the extension's examples
folder that you can
use to discover PowerShell editing and debugging functionality. Please
check out the included README.md file to learn more about
how to use them.
This folder can be found at the following path:
$HOME/.vscode[-insiders]/extensions/ms-vscode.powershell[-preview]-<version>/examples
To open/view the extension's examples in Visual Studio Code, run the following from your PowerShell session:
code (Get-ChildItem $HOME/.vscode/extensions/ms-vscode.powershell-*/examples)[-1]
Check out the development documentation for more details on how to contribute to this extension!
- Patrick Meinecke - @SeeminglyScience
- Andy Jordan - @andschwa
- Sydney Smith - @SydneyhSmith
- Keith Hill - @rkeithhill
- Rob Holt - @rjmholt
- Tyler Leonhardt - @TylerLeonhardt
- David Wilson - @daviwil
This extension is licensed under the MIT License. Please see the third-party notices file for details on the third-party binaries that we include with releases of this project.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.