This repository is for the IntelliJ plugin. mirrord's main repository can be found here.
mirrord lets developers run local processes in the context of their cloud environment. It provides the benefits of running your service on a cloud environment (e.g. staging) without 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 what mirrord does in our official docs, or sign up to our newsletter to hear about new features. Both the core mirrord repository and this plugin's code can be found on GitHub.
- 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.
The extension supports autocomplete for json
files, but you can also use toml
or yaml
format.
Quick start: the easiest way to start configuring mirrord is to choose "Settings" from the dropdown menu,
which will open a new mirrord.json
.
-
From the IDE:
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...
Enable mirrord
Target selection dialog
Settings option in the dropdown menu
- Official documentation for this extension
- Official language-specific guides for debugging
- Frequently Asked Questions
- Feel free to join to our Slack if you need help using mirrord, or if you encounter an issue while using the extension.
- Check our open issues for the IntelliJ extension and mirrord's core code, and 👍 react to any that you would like to see addressed.
- Before submitting a pull request for new features, please take a look at mirrord's contributing guide.
Plugin based on the IntelliJ Platform Plugin Template.