powershell / vscode-powershell

Provides PowerShell language and debugging support for Visual Studio Code

PowerShell for Visual Studio Code

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 repository, vscode-powershell, is the Language Server Protocol client for VS Code and PowerShellEditorServices is the server (also used by other editors, such as Emacs and Vim).

Available Features

• Syntax highlighting
• Advanced built-in code snippets
• IntelliSense for cmdlets and more
• Problems reported by PowerShell Script Analyzer
• Go to Definition of cmdlets, variables, classes and more
• Find References of cmdlets, variables, classes and more
• Document and Workspace Symbol Navigation
• Symbol-based Outline View
• Run selected PowerShell code in current terminal using F8
• Launch online help for the symbol under the cursor using Ctrl+F1
• PowerShell Debugger integration
• An Extension Terminal that can interact with the debugger (try Set-PSBreakpoint!)
• PowerShell ISE theme findable in the theme picker
• Also try ISE Mode with the Toggle ISE Mode command

Bundled with the extension is the PowerShell ISE theme. 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.

Platform Support

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 and only on a best-effort basis. PowerShell Core 6, 7.0, and 7.1 have reached end-of-support. We test the following configurations:

• Windows Server 2022 with Windows PowerShell 5.1 and PowerShell Core 7.2, 7.3 and 7.4
• macOS 12 with PowerShell Core 7.2, 7.3 and 7.4
• Ubuntu 22.04 with PowerShell Core 7.2, 7.3 and 7.4

On Windows, we also test with and without Constrained Language Mode enabled.

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.

Installing the Extension

The PowerShell extension can be installed from the Visual Studio Code Marketplace by clicking the Install Button. You can also install the PowerShell extension from within VS Code by opening the Extensions view with keyboard shortcut Ctrl+Shift+X, typing PowerShell, and selecting the extension.

We would encourage you to try the pre-release version whenever possible. When a Pre-Release is available, it can be installed from the marketplace using the Switch to Pre-Release Version button. You can switch back to the stable version of the extension by using the Switch to Release Version button that will appear. You can also downgrade to other versions of the extension using the arrow next to the Uninstall button and choosing Install Another Version.

Getting Help

Please our support document.

Contributing to the Code

Check out the development documentation for more details on how to contribute to this extension!

Security Note

For any security issues, please see here.

Maintainers

Current

• Andy Jordan - @andyleejordan
• Patrick Meinecke - @SeeminglyScience
• Sydney Smith - @SydneyhSmith

Emeriti

• Keith Hill - @rkeithhill
• Rob Holt - @rjmholt
• Tyler Leonhardt - @TylerLeonhardt
• David Wilson - @daviwil

License

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.

Code of Conduct

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.