Install the Lightrun plugin in the JetBrains IDE¶

To debug using Lightrun from your IDE, you first need to install the Lightrun plugin in the IDE.

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.

For JetBrains IDEs, version 2022.3.0 and later is supported. Contact us to schedule a Demo and learn more.

Choose your plugin installation method¶

Lightrun supports the following installer types based on your deployment environment. When you access the Management Portal, the appropriate installer type for your specific deployment is displayed.

Identify your deployment environment¶

Installation instructions¶

[SaaS only] Install plugin from the JetBrains Plugin Marketplace¶

1. Open your JetBrains IDE and go to Preferences (macOS) or Settings (Windows/Linux).

2. Navigate to the Plugins section and select the Marketplace tab.

   

3. Search for Lightrun and click Install.

   

4. When prompted, restart the IDE. After the restart, Lightrun will appear in the right-hand sidebar and you can log into it by clicking the Login button.

5. Once logged in, proceed to run the Lightrun Agent with your application:

   - Java agent

   - Python agent

   - Node.js agent

   - .NET agent

[On-premise and Single-tenant] Install plugin manually¶

1. Open a browser and log in to your Lightrun account.

2. Navigate to Install the Plugin in your IDE > JetBrains IDE (IntelliJ IDEA, PyCharm, Rider, or WebStorm) > Manual Installation.

   

3. Click Download the plugin to download the Lightrun plugin .zip file. Do not unzip the file before installing it.

4. Open your JetBrains IDE and go to Preferences (Mac OS) or Settings (Windows/Linux).

   

5. Go to the Plugins section and click the cog icon .

6. Select Install Plugin from Disk, then choose the downloaded .zip file.

   

7. Click Restart IDE when prompted to apply changes.

8. After the IDE restarts, authenticate the plugin by clicking the Login or Register in the plugin tool window.

[On-premise and Single-tenant] Install plugin from a custom plugin repository¶

1. Log in to your Lightrun account in a browser.
2. Navigate to Install the Plugin in your IDE > JetBrains IDE(IntelliJ IDEA, PyCharm, Rider, or WebStorm) > Custom repository installation.

3. Copy the custom plugin repository URL provided.

   

4. In your JetBrains IDE, navigate to Preferences (on Mac OS) or Settings (on Windows/Linux).

   

5. Go to the Plugins section and click the cog icon .

6. Select Manage Plugin Repositories... to open the Custom Plugin Repositories dialog.

   

7. Click + and paste the copied repository URL.

8. Click OK in the Custom Plugin Repositories dialog to save the plugin repository.
9. Click OK to save the changes.
10. Return to the Marketplace tab in the Plugins section.

11. Search for Lightrun and click Install on the entry that includes your organization's name.

    

12. Click Restart IDE when prompted.

13. After restart, authenticate the plugin by clicking the Login or Register in the plugin tool window.

Next steps¶

After installing, authenticate the Lightrun plugin to start using it.