Visual Studio Code (VS Code) is a cross-platform script editor by Microsoft. Together withthePowerShell extension, it provides a rich and interactive script editing experience,making it easier to write reliable PowerShell scripts. Visual Studio Code with the PowerShellextension is the recommended editor for writing PowerShell scripts.

It supports the following PowerShell versions:

• PowerShell 7.2 and higher (Windows, macOS, and Linux)
• Windows PowerShell 5.1 (Windows-only) with .NET Framework 4.8

Getting started

Before you begin, make sure PowerShell exists on your system. For modern workloads on Windows,macOS, and Linux, see the following links:

• Installing PowerShell on Linux
• Installing PowerShell on macOS
• Installing PowerShell on Windows

For traditional Windows PowerShell workloads, seeInstalling Windows PowerShell.

Install VS Code and the PowerShell Extension

1. Install Visual Studio Code. For more information, see the overviewSetting up Visual Studio Code.

   There are installation instructions for each platform:

   • Running Visual Studio Code on Windows
   • Running Visual Studio Code on macOS
   • Running Visual Studio Code on Linux

2. Install the PowerShell Extension.

   1. Launch the VS Code app by typingcode in a console orcode-insiders if you installedVisual Studio Code Insiders.
   2. LaunchQuick Open on Windows or Linux by pressingCtrl+P. On macOS,pressCmd+P.
   3. In Quick Open, typeext install powershell and pressEnter.
   4. TheExtensions view opens on the Side Bar. Select the PowerShell extension from Microsoft.
   5. Click theInstall button on the PowerShell extension from Microsoft.
   6. After the install, if you see theInstall button turn intoReload, Click onReload.
   7. After VS Code has reloaded, you're ready for editing.

For example, to create a new file, clickFile > New. To save it, clickFile > Save and thenprovide a filename, such asHelloWorld.ps1. To close the file, click theX next to the filename.To exit VS Code,File > Exit.

Installing the PowerShell Extension on Restricted Systems

Some systems are set up to require validation of all code signatures. You may receive the followingerror:

Language server startup failed.

This problem can occur when PowerShell's execution policy is set by Windows Group Policy. Tomanually approve PowerShell Editor Services and the PowerShell extension for VS Code, open aPowerShell prompt and run the following command:

Import-Module $HOME\.vscode\extensions\ms-vscode.powershell*\modules\PowerShellEditorServices\PowerShellEditorServices.psd1

You're prompted withDo you want to run software from this untrusted publisher? TypeA to runthe file. Then, open VS Code and verify that the PowerShell extension is functioning properly. Ifyou still have problems getting started, let us know in aGitHub issue.

Choosing a version of PowerShell to use with the extension

With PowerShell installing side-by-side with Windows PowerShell, it's now possible to use a specificversion of PowerShell with the PowerShell extension. This feature looks at a few well-known paths ondifferent operating systems to discover installations of PowerShell.

Use the following steps to choose the version:

1. Open theCommand Palette on Windows or Linux withCtrl+Shift+P. On macOS, useCmd+Shift+P.
2. Search forSession.
3. Click onPowerShell: Show Session Menu.
4. Choose the version of PowerShell you want to use from the list.

If you installed PowerShell to a non-typical location, it might not show up initially in the SessionMenu. You can extend the session menu byadding your own custom paths as described below.

The PowerShell session menu can also be accessed from the{} icon in the bottom right corner ofstatus bar. Hovering on or selecting this icon displays a shortcut to the session menu and a smallpin icon. If you select the pin icon, the version number is added to the status bar. The versionnumber is a shortcut to the session menu requiring fewer clicks.

Configuration settings for Visual Studio Code

First, if you're not familiar with how to change settings in VS Code, we recommend readingVisual Studio Code's settings documentation.

After reading the documentation, you can add configuration settings insettings.json.

{    "editor.renderWhitespace": "all",    "editor.renderControlCharacters": true,    "files.trimTrailingWhitespace": true,    "files.encoding": "utf8bom",    "files.autoGuessEncoding": true}

If you don't want these settings to affect all files types, VS Code also allows per-languageconfigurations. Create a language-specific setting by putting settings in a[<language-name>]field. For example:

{    "[powershell]": {        "files.encoding": "utf8bom",        "files.autoGuessEncoding": true    }}

Adding your own PowerShell paths to the session menu

You can add other PowerShell executable paths to the session menu through theVisual Studio Code setting:powershell.powerShellAdditionalExePaths.

You can do this using the GUI:

1. From theCommand Palette search for and selectOpen User Settings. Or use thekeyboard shortcut on Windows or LinuxCtrl+,. On macOS, useCmd+,.
2. In theSettings editor, search forPowerShell Additional Exe Paths.
3. ClickAdd Item.
4. For theKey (underItem), provide your choice of name for this additional PowerShellinstallation.
5. For theValue (underValue), provide the absolute path to the executable itself.

You can add as many additional paths as you like. The added items show up in the session menu withthe given key as the name.

Alternatively you can add key-value pairs to the objectpowershell.powerShellAdditionalExePaths in yoursettings.json:

{    "powershell.powerShellAdditionalExePaths": {        "Downloaded PowerShell": "C:/Users/username/Downloads/PowerShell/pwsh.exe",        "Built PowerShell": "C:/Users/username/src/PowerShell/src/powershell-win-core/bin/Debug/net6.0/win7-x64/publish/pwsh.exe"    },}

To set the default PowerShell version, set the valuepowershell.powerShellDefaultVersion to thetext displayed in the session menu (the text used for the key):

{    "powershell.powerShellAdditionalExePaths": {        "Downloaded PowerShell": "C:/Users/username/Downloads/PowerShell/pwsh.exe",    },    "powershell.powerShellDefaultVersion": "Downloaded PowerShell",}

After you've configured this setting, restart VS Code or to reload the current VS Code window fromtheCommand Palette, typeDeveloper: Reload Window.

If you open the session menu, you now see your additional PowerShell installations.

Debugging with Visual Studio Code

No-workspace debugging

In VS Code version 1.9 (or higher), you can debug PowerShell scripts without opening the folder thatcontains the PowerShell script.

1. Open the PowerShell script file withFile > Open File...
2. Set a breakpoint - select a line then pressF9
3. PressF5 to start debugging

You should see the Debug actions pane appear that allows you to break into the debugger, step,resume, and stop debugging.

Workspace debugging

Workspace debugging refers to debugging in the context of a folder that you've opened from theFile menu usingOpen Folder.... The folder you open is typically your PowerShell projectfolder or the root of your Git repository. Workspace debugging allows you to define multiple debugconfigurations other than just debugging the currently open file.

Follow these steps to create a debug configuration file:

1. Open theDebug view on Windows or Linux by pressingCtrl+Shift+D. On macOS, pressCmd+Shift+D.

2. Click thecreate a launch.json file link.

3. From theSelect Environment prompt, choosePowerShell.

4. Choose the type of debugging you'd like to use:

   • Launch Current File - Launch and debug the file in the currently active editor window
   • Launch Script - Launch and debug the specified file or command
   • Interactive Session - Debug commands executed from the Integrated Console
   • Attach - Attach the debugger to a running PowerShell Host Process

VS Code creates a directory and a file.vscode\launch.json in the root of your workspace folder tostore the debug configuration. If your files are in a Git repository, you typically want to committhelaunch.json file. The contents of thelaunch.json file are:

{  "version": "0.2.0",  "configurations": [      {          "type": "PowerShell",          "request": "launch",          "name": "PowerShell Launch (current file)",          "script": "${file}",          "args": [],          "cwd": "${file}"      },      {          "type": "PowerShell",          "request": "attach",          "name": "PowerShell Attach to Host Process",          "processId": "${command.PickPSHostProcess}",          "runspaceId": 1      },      {          "type": "PowerShell",          "request": "launch",          "name": "PowerShell Interactive Session",          "cwd": "${workspaceRoot}"      }  ]}

This file represents the common debug scenarios. When you open this file in the editor, you see anAdd Configuration... button. You can click this button to add more PowerShell debugconfigurations. One useful configuration to add isPowerShell: Launch Script. With thisconfiguration, you can specify a file containing optional arguments that are used whenever you pressF5 no matter which file is active in the editor.

After the debug configuration is established, you can select the configuration you want to useduring a debug session. Select a configuration from the debug configuration drop-down in theDebug view's toolbar.

Troubleshooting the PowerShell extension

If you experience any issues using VS Code for PowerShell script development, see thetroubleshooting guide on GitHub.

Useful resources

There are a few videos and blog posts that may be helpful to get you started using the PowerShellextension for VS Code:

Videos

• Using Visual Studio Code as Your Default PowerShell Editor
• Visual Studio Code: deep dive into debugging your PowerShell scripts

Blog posts

• PowerShell Extension
• Write and debug PowerShell scripts in Visual Studio Code
• Debugging Visual Studio Code Guidance
• Debugging PowerShell in Visual Studio Code
• Get started with PowerShell development in Visual Studio Code
• Visual Studio Code editing features for PowerShell development - Part 1
• Visual Studio Code editing features for PowerShell development - Part 2
• Debugging PowerShell script in Visual Studio Code - Part 1
• Debugging PowerShell script in Visual Studio Code - Part 2

PowerShell extension project source code

The PowerShell extension's source code can be found onGitHub.

If you're interested in contributing, Pull Requests are greatly appreciated. Follow along with thedeveloper documentation on GitHub to get started.