This repository is for the IntelliJ plugin. mirrord main repository can be found here.
mirrord lets developers run local processes in the context of their cloud environment. It’s meant to provide the benefits of running your service on a cloud environment (e.g. staging) without actually going through the hassle of deploying it there, and without disrupting the environment by deploying untested code. It comes as a Visual Studio Code extension, an IntelliJ plugin and a CLI tool. You can read more about it here.
- Click the mirrord icon in the Navigation Toolbar
- Start debugging your project
- Choose a pod to impersonate or choose to run in the "targetless" mode
- The debugged process will be plugged into the selected pod or into the cluster environment by mirrord
mirrord allows for rich configuration of the environment it provides. The schema for it is documented here.
This plugin supports configuration specified in json files.
mirrord reads its configuration from the following locations:
- Active config can be set for the whole workspace using the
Select Active Configbutton from the dropdown menu. If active config is set, mirrord always uses it. - If active config is not set, mirrord searches process environment (specified in run configuration) for
MIRRORD_CONFIG_FILEvariable. - If no config is specified, mirrord looks for a default project config file in the
.mirrorddirectory with a name ending withmirrord.json. If there is no default config file, mirrord uses default configuration values for everything. - If there are many candidates for the default config file, mirrord sorts them alphabetically and uses the first one.
You can use the Settings button in the dropdown menu to quickly edit detected configs.
-
Using IDE built-in plugin system:
Settings/Preferences > Plugins > Marketplace > Search for "mirrord-intellij-plugin" > Install Plugin
-
Manually:
Download the latest release and install it manually using Settings/Preferences > Plugins > ⚙️ > Install plugin from disk...
Our FAQ is available here. If you have a question that's not on there, feel free to ask in our Discussions or on Discord.
Contributions are very welcome. Start by checking out our open issues, and by going through our contributing guide. We're available on Discord for any questions.
Join our Discord Server for questions, support and fun.
We take our community seriously and we are dedicated to providing a safe and welcoming environment for everyone. Please take a few minutes to review our Code of Conduct.
Plugin based on the IntelliJ Platform Plugin Template.