Install the Lightrun plugin in the VS Code IDE¶
The Lightrun extension for Visual Studio Code (VS Code), hereandafter 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.
Support
Lightrun currently supports IntelliJ IDEA, PyCharm, WebStorm, Visual Studio Code (VS Code), VS Code for the web (vscode.dev), Visual Studio, and code-server.
Support for additional IDEs is coming soon. Sign up for a Demo to learn more!
Version Support
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.
How can I detect my deployment environment?
- If your lightrun account is at a URL that starts with https://app.lightrun.com, then you're on Lightrun’s SaaS offering, and should follow the instructions under Installing the Lightrun plugin from the VS Code Plugin Marketplace.
- If your server doesn't offer a custom repository, follow the steps to install the plugin manually.
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.
Install the Lightrun plugin from a VSIX file¶
Lightrun also provides a .vsix file that automatically installs the latest version of the Lightrun VS Code plugin in your IDE.
To install the plugin from a VSIX:
- 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.
After the Lightrun plugin is installed, proceed to authenticate it.