Debug Remote Environments Using Jetbrains IDEs
JetBrains IDEs are some of the most popular IDEs amongst software developers.
Using Raftt allows devs to continue working and debugging on their favorite IDE with their customized setup and configuration while enjoying all the benefits of a remotely running environment.
Raftt currently supports debugging Python, Go and Node.js code. Join our Slack community or contact us to enquire about upcoming support for additional languages.
Installing the plugin
Install the plugin directly from JetBrains Marketplace. It is compatible with all IntelliJ-based IDEs!
Either search the marketplace for the Raftt plugin, or use this link:
Configuration
Raftt run/debug is configured by adding the RAFTT_WORKLOAD environment variable to an existing, non-Raftt, run/debug configuration. The value of this environment variable specifies the workload you want to run/debug.
This exact method of configuring it slightly differs between different languages.
- Python
- Go
- Node.js
The environment variable is added under the Environment variables field of your Python run/debug configuration.
For example, if you wish to debug a workload called web when using PyCharm, this should be in your run/debug configuration -
If you don't have an existing run/debug configuration, guidance on how to create one can be found here.
The environment variable is added under the Environment field of your Go run/debug configuration.
For example, if you wish to debug a workload called web when using GoLand, this should be in your run/debug configuration -
If you don't have an existing run/debug configuration, guidance on how to create one can be found here.
The environment variable is added under the Environment field of your npm run/debug configuration (npm configurations also support other package managers, e.g. Yarn). Raftt does not support run/debug configuration of type Node.js.
For example, if you wish to debug a workload called web when using WebStorm, this should be in your run/debug configuration -
If you don't have an existing run/debug configuration, guidance on how to create one can be found here.
Debugging
Once the plugin is installed and configured, new blue Run/Debug buttons are enabled and can be used to run or debug the configuration via Raftt. You can than run or debug the service just like you would if it ran locally, e.g., add breakpoints, view symbols, and more.
