ScriptRunner Enterprise for Visual Studio Code

The ScriptRunner Enterprise for VS Code extension allows you to bring ScriptRunner scripting functions to Visual Studio Code, making it easier for you to edit your PowerShell scripts. You can connect your ScriptRunner script repository directly to Visual Studio Code and edit your PowerShell scripts without having to switch between different applications.

Check out our Coding Guide for detailed information about the ScriptRunner extension for Visual Studio Code.

Features

This extension provides the following features for PowerShell script development:

Use Windows-integrated, Entra ID, or OpenID Connect authentication for login
View PowerShell script metadata
Create new PowerShell scripts directly in your ScriptRunner script repository
Create PowerShell scripts based on a template
Create new tags during creation/upload process
Upload local PowerShell scripts
Duplicate PowerShell scripts
Search for PowerShell script names
Check out PowerShell scripts
Edit PowerShell scripts
Use code auto-completion for dedicated ScriptRunner code snippets and parameter attributes
Check in PowerShell scripts
Filter for PowerShell scripts that you are allowed to edit
Discard changes and revert checkout
Show PowerShell script changes on check-in
Test your PowerShell scripts directly in Visual Studio Code with our SRXEnv module
Delete PowerShell scripts

Requirements

Make sure that the following requirements are met:

This version of ScriptRunner Enterprise for VS Code requires the ScriptRunner Web API service version 7 or later.
You have licensed a ScriptRunner server.
You have configured the ScriptRunner server.
You have installed the PowerShell extension for Visual Studio Code.
You have been assigned the ScriptRunner Administrator or Main administrator role.
PowerShell scripts are available in the ScriptRunner script repository that you are allowed to view or edit.

Extension settings

Open VS Code Settings and search for ScriptRunner Enterprise for VS Code. Set ScriptRunner Backend URI to your ScriptRunner Service URL. You can copy it from the about dialog in the ScriptRunner Portal.

Enable the Install SRXEnv PowerShell Module setting if you want to test ScriptRunner features directly in Visual Studio Code. For more information, refer to our Coding Guide.

Specify Loopback Server Port for login redirects when using OpenID Connect and your redirect URI requires a fixed port. In that case, add http://localhost:<port> explicitly to the allowed redirect URIs.

Change the PowerShell Executable Path if the PowerShell executable file is in a different location on your client.

Enable Skip Certificate Check only for development or troubleshooting in trusted environments. Do not use this setting in production, because it disables certificate validation.

Known Issues

If the extension starts slowly or fails during startup, add the following setting and reload VS Code:
```
"extensions.experimental.affinity": {
    "ScriptRunner.scriptrunner7": 1
}
```
extensions.experimental.affinity is an experimental VS Code setting that lets you tell VS Code to run specific extensions in a different extension host process instead of the default shared one. The goal is mainly performance isolation: a busy or latency-sensitive extension can be placed on its own host so it interferes less with other extensions.

Caveats: One issue with using the affinity setting is that each time you update your settings file, the extension will reload, which can take a few seconds.

Support

This extension is maintained by ScriptRunner Software GmbH. If you have questions or want to provide feedback, contact support@scriptrunner.com.

ScriptRunner Enterprise for VS Code

ScriptRunner Software GmbH