Install the Lightrun plugin in the VS Code IDE🔗
The Lightrun extension for Visual Studio Code (VS Code), hereinafter referred to as the "Lightrun plugin", can be installed from either the VS Code Extension Marketplace or by downloading a VSIX file from the Lightrun Management Portal.
Supported IDEs and versions🔗
Lightrun currently supports IntelliJ IDEA, PyCharm, WebStorm, Visual Studio Code (VS Code), VS Code for the web (vscode.dev), Visual Studio, and code-server.
The Lightrun plugin for VS Code, supported for versions from 1.82 to 1.92 is compatible with all platforms, including MS Windows, Linux, and macOS.
Contact us to schedule a Demo and learn more.
Choose your plugin installation method🔗
| Deployment environment | Installation method |
|---|---|
| SaaS users | Visual Studio Code Extension Marketplace, Marketplace in the IDE or via the Open VSX Registry. |
| On-premise and Single-tenant users | Manual installation – Download a VSIX file from the Lightrun Management Portal. |
Identify your deployment environment🔗
| Deployment environment | How to identify | Recommended installation method |
|---|---|---|
| SaaS users | URL starts with https://app.lightrun.com | Install the Lightrun plugin from the VS Code Plugin Marketplace |
| On-premise / Single-tenant (no plugin repository) | URL is different and no custom plugin repository is available | Manual installation. |
Installation instructions🔗
[SaaS] Install the Lightrun plugin from the VS Code Extension Marketplace🔗
-
From the VS Code menu bar, select View > Extensions.
The EXTENSIONS sidebar opens.Tip
Alternatively, to open the EXTENSIONS sidebar, use the keyboard shortcut:
- Ctrl+Shift+X (MS Windows and Linux)
- Cmd+Shift+X (macOS)
-
In the plugin's search field, enter Lightrun.
- Select the Lightrun plugin and click Install.
- If prompted, restart VS Code.
- To verify successful installation of the plugin, in the sidebar, click the Lightrun plugin icon
.
The Lightrun plugin pane opens.
[SaaS] Install the Lightrun plugin from the Open VSX Registry🔗
This install option is available for Cursor and Windsurf users.
- Download the Lightrun VSIX file directly from the Open VSX Registry.
- In the EXTENSIONS sidebar, from the Views and More Actions menu (...), select Install from VSIX....
A file explorer window opens. - Navigate to the downloaded VSIX file for the Lightrun plugin and click Install.
- If prompted, restart VS Code.
- To verify successful installation of the plugin, in the sidebar, click the Lightrun plugin icon
.
The Lightrun plugin pane opens.
[On-premise and Single-tenant] Install plugin manually🔗
Lightrun provides a .vsix file that automatically installs the latest version of the Lightrun VS Code plugin in your IDE.
Install the Lightrun plugin from a VSIX file
- Download the Lightrun VSIX file from the Install the Plugin section of the Lightrun Management Portal.
- In the EXTENSIONS sidebar, from the Views and More Actions menu (...), select Install from VSIX....
A file explorer window opens. - Navigate to the downloaded VSIX file for the Lightrun plugin and click Install.
- If prompted, restart VS Code.
- To verify successful installation of the plugin, in the sidebar, click the Lightrun plugin icon
.
The Lightrun plugin pane opens.
Next steps🔗
After the Lightrun plugin is installed, proceed to authenticate it.