https://github.com/open-policy-agent/regal
Regal is a linter and language server for Rego, bringing your policy development experience to the next level!
https://github.com/open-policy-agent/regal
code-quality language-server linter lsp magnificent opa open-policy-agent policy-as-code rego static-analysis
Last synced: 17 days ago
JSON representation
Regal is a linter and language server for Rego, bringing your policy development experience to the next level!
- Host: GitHub
- URL: https://github.com/open-policy-agent/regal
- Owner: open-policy-agent
- License: apache-2.0
- Created: 2023-01-23T15:23:06.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-09-10T13:29:22.000Z (30 days ago)
- Last Synced: 2025-09-10T17:43:51.545Z (30 days ago)
- Topics: code-quality, language-server, linter, lsp, magnificent, opa, open-policy-agent, policy-as-code, rego, static-analysis
- Language: Go
- Homepage:
- Size: 8.38 MB
- Stars: 339
- Watchers: 12
- Forks: 47
- Open Issues: 119
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md
- Security: docs/SECURITY.md
Awesome Lists containing this project
- awesome-opa - Regal - Regal is a linter for Rego, with the goal of making your Rego magnificent! ([blog](https://www.styra.com/blog/guarding-the-guardrails-introducing-regal-the-rego-linter/)) (Tools and Utilities / Testing Blogs and Articles)
README
# Regal
[](https://github.com/open-policy-agent/regal/actions)
[](https://codecov.io/github/StyraInc/regal)
[](https://github.com/open-policy-agent/regal/releases)
Regal is a linter, debugger and language server for [Rego](https://www.openpolicyagent.org/docs/policy-language/),
making your Rego magnificent, and you the ruler of rules!
With its extensive set of linter rules, documentation and editor integrations, Regal is the perfect companion for policy
development, whether you're an experienced Rego developer or just starting out.
> [!IMPORTANT]
> Regal is now an official OPA project!
> ([More Info](https://blog.openpolicyagent.org/note-from-teemu-tim-and-torin-to-the-open-policy-agent-community-2dbbfe494371))
> For those previously installing Regal from StyraInc/regal, please update your
> scripts and documentation to refer to this Repo. We will be migrating the
> Regal's documentation to openpolicyagent.org from the next release. Please
> [file an issue](https://github.com/open-policy-agent/regal/issues/new)
> for any problems you run into.
> regal
>
> adj : of notable excellence or magnificence : splendid
\- [Merriam Webster](https://www.merriam-webster.com/dictionary/regal)
## Goals
- Deliver an outstanding policy development experience by providing the best possible tools for that purpose
- Identify common mistakes, bugs and inefficiencies in Rego policies, and suggest better approaches
- Provide advice on [best practices](https://github.com/StyraInc/rego-style-guide), coding style, and tooling
- Allow users, teams and organizations to enforce custom rules on their policy code
## What People Say About Regal
> I really like that at each release of Regal I learn something new!
> Of all the linters I'm exposed to, Regal is probably the most instructive one.
— Leonardo Taccari, [NetBSD](https://www.netbsd.org/)
> Reviewing the Regal rules documentation. Pure gold.
— Dima Korolev, [Miro](https://miro.com/)
> Such an awesome project!
— Shawn McGuire, [Atlassian](https://www.atlassian.com/)
> I am really impressed with Regal. It has helped me write more expressive and deterministic Rego.
— Jimmy Ray, [Boeing](https://www.boeing.com/)
See the [adopters](https://openpolicyagent.org/projects/regal/adopters) file for more Regal users.
## Getting Started
### Download Regal
**MacOS and Linux**
```shell
brew install regal
```
Other Installation Options
Please see [Packages](https://openpolicyagent.org/projects/regal/adopters#packaging)
for a list of package repositories which distribute Regal.
Manual installation commands:
**MacOS (Apple Silicon)**
```shell
curl -L -o regal "https://github.com/open-policy-agent/regal/releases/latest/download/regal_Darwin_arm64"
```
**MacOS (x86_64)**
```shell
curl -L -o regal "https://github.com/open-policy-agent/regal/releases/latest/download/regal_Darwin_x86_64"
```
**Linux (x86_64)**
```shell
curl -L -o regal "https://github.com/open-policy-agent/regal/releases/latest/download/regal_Linux_x86_64"
chmod +x regal
```
**Windows**
```shell
curl.exe -L -o regal.exe "https://github.com/open-policy-agent/regal/releases/latest/download/regal_Windows_x86_64.exe"
```
**Docker**
```shell
docker pull ghcr.io/styrainc/regal:latest
```
See all versions, and checksum files, at the Regal [releases](https://github.com/open-policy-agent/regal/releases/)
page, and published Docker images at the [packages](https://github.com/open-policy-agent/regal/pkgs/container/regal)
page.
### Try it out!
First, author some Rego!
**policy/authz.rego**
```rego
package authz
default allow = false
allow if {
isEmployee
"developer" in input.user.roles
}
isEmployee if regex.match("@acmecorp\\.com$", input.user.email)
```
Next, run `regal lint` pointed at one or more files or directories to have them linted.
```shell
regal lint policy/
```
```text
Rule: non-raw-regex-pattern
Description: Use raw strings for regex patterns
Category: idiomatic
Location: policy/authz.rego:12:27
Text: isEmployee if regex.match("@acmecorp\\.com$", input.user.email)
Documentation: https://openpolicyagent.org/projects/regal/rules/idiomatic/non-raw-regex-pattern
Rule: use-assignment-operator
Description: Prefer := over = for assignment
Category: style
Location: policy/authz.rego:5:1
Text: default allow = false
Documentation: https://openpolicyagent.org/projects/regal/rules/style/use-assignment-operator
Rule: prefer-snake-case
Description: Prefer snake_case for names
Category: style
Location: policy/authz.rego:12:1
Text: isEmployee if regex.match("@acmecorp\\.com$", input.user.email)
Documentation: https://openpolicyagent.org/projects/regal/rules/style/prefer-snake-case
1 file linted. 3 violations found.
```
> **Note**
> If you're running Regal on an existing policy library, you may want to disable the `style` category initially, as it
> will likely generate a lot of violations. You can do this by passing the `--disable-category style` flag to
> `regal lint`.
### Using Regal in Your Editor
Linting from the command line is a great way to get started with Regal, and even for some experienced developers
the preferred way to work with the linter. However, not only is Regal a linter, but a full-fledged development
companion for Rego development!
Integrating Regal in your favorite editor means you'll get immediate feedback from the linter as you work on your
policies. More than that, it'll unlock a whole new set of features that leverage Regal's
[language server](https://openpolicyagent.org/projects/regal/language-server),
like context-aware completion suggestions, informative tooltips on hover,
or go-to-definition.
Elevate your policy development experience with Regal in VS Code, Neovim, Zed, Helix
and more on our [Editor Support page](https://openpolicyagent.org/projects/regal/editor-support)!
To learn more about the features provided by the Regal language server, see the
[Language Server](https://openpolicyagent.org/projects/regal/language-server) page.
### Using Regal in Your Build Pipeline
To ensure Regal's rules are enforced consistently in your project or organization,
we've made it easy to run Regal as part of your builds.
See the docs on [Using Regal in your build pipeline](https://openpolicyagent.org/projects/regal/cicd) to learn more
about how to set up Regal to lint your policies on every commit or pull request.
## Next Steps
Now you're up and running with Regal, take a look around some of our documentation
to get a feel for the different features and capabilities of Regal.
- [Rules](https://openpolicyagent.org/projects/regal/rules)
- [Bugs](https://openpolicyagent.org/projects/regal/rules/bugs): Common mistakes, potential bugs and inefficiencies in Rego policies.
- [Idiomatic](https://openpolicyagent.org/projects/regal/rules/idiomatic): Suggestions for more idiomatic constructs.
- [Imports](https://openpolicyagent.org/projects/regal/rules/imports): Best practices for imports.
- [Performance](https://openpolicyagent.org/projects/regal/rules/performance): Rules for improving performance of policies.
- [Style](https://openpolicyagent.org/projects/regal/rules/style): Rego Style Guide rules.
- [Testing](https://openpolicyagent.org/projects/regal/rules/testing): Rules for testing and development.
- [Custom](https://openpolicyagent.org/projects/regal/rules/custom): Custom rules where enforcement can be adjusted to match your preferences.
- [Configuration](https://openpolicyagent.org/projects/regal/configuration): Dig into some of the different configuration options available.
- [Editor Support](https://openpolicyagent.org/projects/regal/editor-support): Get Regal integrated into your editor of choice.
- [Language Server](https://openpolicyagent.org/projects/regal/language-server): Learn more
about Regal's advanced editor capabilities.
- [DAP](https://openpolicyagent.org/projects/regal/debug-adapter): Live debug your Rego policies with Regal's DAP support.
- [Fixing Issues](https://openpolicyagent.org/projects/regal/fixing): See Regal can help you fix issues in your Rego policies automatically.
- [CI/CD](https://openpolicyagent.org/projects/regal/ci-cd): Run Regal as part of your automated checks.
- [Custom Rules](https://openpolicyagent.org/projects/regal/custom-rules): Learn how to write your own rules for Regal.
- [Adopters](https://openpolicyagent.org/projects/regal/adopters): See who else is using Regal.
## Learn More
### Documentation
Please see [Regal's Documentation Site](https://openpolicyagent.org/projects/regal) for the
canonical documentation of Regal.
[Contributing](https://github.com/open-policy-agent/regal/blob/main/docs/CONTRIBUTING.md)
contains information about how to hack on Regal itself.
### Talks
- [OPA Maintainer Track, featuring Regal](https://www.youtube.com/watch?v=XtA-NKoJDaI), KubeCon London, 2025
- [Regal the Rego Linter](https://www.youtube.com/watch?v=Xx8npd2TQJ0&t=2567s), CNCF London meetup, June 2023
[](https://www.youtube.com/watch?v=Xx8npd2TQJ0&t=2567s)
### Blogs and Articles
- [Guarding the Guardrails - Introducing Regal the Rego Linter](https://www.styra.com/blog/guarding-the-guardrails-introducing-regal-the-rego-linter/)
by Anders Eknert ([@anderseknert](https://github.com/anderseknert))
- [Scaling Open Source Community by Getting Closer to Users](https://thenewstack.io/scaling-open-source-community-by-getting-closer-to-users/)
by Charlie Egan ([@charlieegan3](https://github.com/charlieegan3))
- [Renovating Rego](https://www.styra.com/blog/renovating-rego/) by Anders Eknert ([@anderseknert](https://github.com/anderseknert))
- [Linting Rego with... Rego!](https://www.styra.com/blog/linting-rego-with-rego/) by Anders Eknert ([@anderseknert](https://github.com/anderseknert))
- [Regal: Rego(OPA)用リンタの導入手順](https://zenn.dev/erueru_tech/articles/6cfb886d92858a) by Jun Fujita ([@erueru-tech](https://github.com/erueru-tech))
- [Regal を使って Rego を Lint する](https://tech.dentsusoken.com/entry/2024/12/05/Regal_%E3%82%92%E4%BD%BF%E3%81%A3%E3%81%A6_Rego_%E3%82%92_Lint_%E3%81%99%E3%82%8B)
by Shibata Takao ([@shibata.takao](https://shodo.ink/@shibata.takao/))
## Status
Regal is currently in beta. End-users should not expect any drastic changes, but any API may change without notice.
If you want to embed Regal in another project or product, please reach out!
## Roadmap
The current Roadmap items are all related to the preparation for
[Regal 1.0](https://github.com/open-policy-agent/regal/issues/979):
- [ ] [Go API: Refactor the Location object in Violation (#1554)](https://github.com/open-policy-agent/regal/issues/1554)
- [ ] [Rego API: Provide a stable and well-documented Rego API (#1555)](https://github.com/open-policy-agent/regal/issues/1555)
- [ ] [Go API: Audit and reduce the public Go API surface (#1556)](https://github.com/open-policy-agent/regal/issues/1556)
- [ ] [Custom Rules: Tighten up Authoring experience (#1559)](https://github.com/open-policy-agent/regal/issues/1559)
- [x] [docs: Improve automated documentation generation (#1557)](https://github.com/open-policy-agent/regal/issues/1557)
- [x] [docs: Break down README into smaller units (#1558)](https://github.com/open-policy-agent/regal/issues/1558)
- [ ] [lsp: Support a JetBrains LSP client (#1560)](https://github.com/open-policy-agent/regal/issues/1560)
If there's something you'd like to have added to the roadmap, either open an issue, or reach out in the community Slack!