Skip to content

metalbear-co/mirrord-intellij

Repository files navigation

mirrord for JetBrains IntelliJ

Community Slack License GitHub release (latest SemVer) Twitter Follow JetBrains Marketplace

This repository is for the IntelliJ plugin. mirrord's main repository can be found here.

A gif showing mirrord being used to mirror traffic from a kubernetes cluster in the IntelliJ UI

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.

How To Use

  • 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

Configuring mirrord for IntelliJ

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.

Installation

  • 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...

Screenshots

A gif showing mirrord being enabled via a click in the IntelliJ UI

Enable mirrord

A screenshot of mirrord's target selection dialog in the IntelliJ UI

Target selection dialog

A screenshot of mirrord's dropdown menu in the IntelliJ UI, with 'Settings' highlighted

Settings option in the dropdown menu

Helpful Links

Contributions, feature requests, issues and support

License

MIT


Plugin based on the IntelliJ Platform Plugin Template.

About

Connect your local process and your cloud environment, and run local code in cloud conditions.

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 27

Languages