Skip to content

open-policy-agent/opa-idea-plugin

OPA IntelliJ Plugin

A plugin for IntelliJ that provides support for Open Policy Agent.

Main features are:

  • Highlighting
  • opa eval run configuration
  • opa test run configuration
  • Regal linter and language server support (diagnostics, code completions, code folding, signature help, document symbols, debugging)

Compatibility

The plugin is compatible with all IntelliJ-based IDEs starting from the version 2020.3, with the following differences in the sets of the available features:

[IntelliJ IDEA] Community and Ultimate (commercial) Other IDE
Rego project creation + -
Other features + +

Plugin has been tested against OPA 1.12.3, but should work with more recent versions.

Installation

OPA binary must be in the path. Installation instructions for OPA can be found here.

For enhanced IDE features (diagnostics, code completions, etc.), Regal must also be installed. Regal releases are available here.

From JetBrains Repository

Go to Settings / Preferences / Plugins menu. Then, search opa in the Marketplace tab and install the plugin.

Step 3

From Source

You can build the project from source and then install it. Build instructions are available here.

Documentation

User documentation is available here.

Contributing

Interested in contributing? Please, start by reading this document.

Acknowledgment

This project is widely inspired by rust IntelliJ plugin. So, thank you JetBrains team.

About

Open Policy Agent plugin for IntelliJ

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors