https://github.com/openfga/intellij-plugin

https://github.com/openfga/intellij-plugin

fga hacktoberfest openfga

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/openfga/intellij-plugin
• Owner: openfga
• License: apache-2.0
• Created: 2024-04-30T00:10:52.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2025-05-19T09:41:16.000Z (about 1 year ago)
• Last Synced: 2025-06-02T04:18:04.383Z (about 1 year ago)
• Topics: fga, hacktoberfest, openfga
• Language: Java
• Homepage: https://openfga.dev
• Size: 3.08 MB
• Stars: 6
• Watchers: 14
• Forks: 6
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# OpenFGA plugin for JetBrain IDEs

This is the official IntelliJ plugin for [OpenFGA](https://openfga.dev/).

[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/openfga/intellij-plugin/badge)](https://securityscorecards.dev/viewer/?uri=github.com/openfga/intellij-plugin)

[![Join our community](https://img.shields.io/badge/slack-cncf_%23openfga-40abb8.svg?logo=slack)](https://openfga.dev/community)

[![X](https://img.shields.io/twitter/follow/openfga?color=%23179CF0&logo=X&style=flat-square "@openfga on X")](https://x.com/openfga)

## About

[OpenFGA](https://openfga.dev) is an open source Fine-Grained Authorization solution inspired by [Google's Zanzibar paper](https://research.google/pubs/pub48190/). It was created by the FGA team at [Auth0](https://auth0.com) based on [Auth0 Fine-Grained Authorization (FGA)](https://fga.dev), available under [a permissive license (Apache-2)](https://github.com/openfga/rfcs/blob/main/LICENSE) and welcomes community contributions.

OpenFGA is designed to make it easy for application builders to model their permission layer, and to add and integrate fine-grained authorization into their applications. OpenFGA’s design is optimized for reliability and low latency at a high scale.

## Resources

- [OpenFGA Documentation](https://openfga.dev/docs)

- [OpenFGA API Documentation](https://openfga.dev/api/service)

- [OpenFGA on X](https://x.com/openfga)

- [OpenFGA Community](https://openfga.dev/community)

- [Zanzibar Academy](https://zanzibar.academy)

- [Google's Zanzibar Paper (2019)](https://research.google/pubs/pub48190/)

## Installation

### From JetBrains Marketplace

Install directly from the [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/24394-openfga), or from within your IDE:

1. Go to **Settings** > **Plugins** > **Marketplace**

2. Search for **OpenFGA**

3. Click **Install**

### Manual Installation

Alternatively, you can install the plugin from disk:

1. Download the latest release zip from [GitHub Releases](https://github.com/openfga/intellij-plugin/releases), or build it yourself with `./gradlew buildPlugin` (output will be in `build/distributions/`)

2. Go to **Settings** > **Plugins** > **⚙️** > **Install Plugin from Disk...**

3. Select the plugin zip file

![manual_install.png](docs/manual_install.png)

## Usage

* OpenFGA syntax highlighting for dark and light themes

![openfga_dark_theme.png](docs/openfga_dark_theme.png)

* DSL syntax support (associated with `.fga` and `.openfga` file extensions)

![syntax.png](docs/syntax.png)

* DSL syntax injection for YAML store files (associated with `.fga.yaml` and `.openfga.yaml` file extensions)

![store_syntax.png](docs/store_syntax.png)

* Authorization model dsl file template

![template.png](docs/template.png)

* Authorization model dsl live templates

![live_templates.png](docs/live_templates.png)

* Generate json file from DSL (requires [OpenFGA CLI](https://github.com/openfga/cli) to be installed)

![cli_setup.png](docs/cli_setup.png)

![transform_json.png](docs/transform_json.png)

* Configure servers in OpenFGA tool window

![server_setup.png](docs/server_setup.png)

## Roadmap

A rough [roadmap](https://github.com/orgs/openfga/projects/1) for development priorities.

## Contributing

See the [DEVELOPMENT](./docs/DEVELOPMENT.md) and [CONTRIBUTING](https://github.com/openfga/.github/blob/main/CONTRIBUTING.md).

## Author

[OpenFGA](https://github.com/openfga)

## Acknowledgments

A special thanks to [Yann D'Isanto](https://github.com/le-yams) for the contribution of [their codebase](https://github.com/le-yams/openfga4intellij), which this project is built upon.

## License

This project is licensed under the Apache-2.0 license. See the [LICENSE](https://github.com/openfga/vscode-ext/blob/main/LICENSE) file for more info.