Skip to content

Installing the Lightrun plugin in the VS Code IDE

The Lightrun extension for Visual Studio Code (VSCode) - henceforth referred to as the "Lightrun plugin" - can be installed from either the VSCode Extension Marketplace or from a VSIX file downloaded from the Lightrun Management Portal.

Support

Lightrun currently supports IntelliJ IDEA, PyCharm, WebStorm, Visual Studio Code (VSCode), and VSCode for the web (vscode.dev). Support for additional IDEs is coming soon - sign up for our beta program to learn more!

Version Support

The Lightrun plugin for VSCode (version 1.55 onwards) is compatible with all platforms and environments (MS Windows, Linux, and MacOS).

Installing the Lightrun plugin from VSCode Extensions Marketplace

  1. 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)
  2. In the plugin's search field, enter Lightrun.

  3. Select the Lightrun plugin and click Install.
  4. If prompted, restart VS Code.
  5. To verify successful installation of the plugin, in the sidebar, click the Lightrun plugin icon Lightun VSCode plugin icon.
    The Lightrun plugin pane opens.

Installing the plugin from the VSIX file

The single VSIX file automatically installs the latest version of the Lightrun plugin for VSCode.

To install the plugin from a VSIX file:

  1. Download the Lightrun VSIX file from the Install the Plugin section of the Lightrun Management Portal.
  2. In the EXTENSIONS sidebar, from the Views and More Actions menu (...), select Install from VSIX....
    A file explorer window opens.
  3. Navigate to the downloaded VSIX file for the Lightrun plugin and click Install.
  4. If prompted, restart VSCode.
  5. To verify successful installation of the plugin, in the sidebar, click the Lightrun plugin icon Lightrun VSCode plugin icon.
    The Lightrun plugin pane opens.

After the Lightrun plugin is installed, the next step is to authenticate it.


Last update: June 19, 2022