Skip to content

Latest commit

 

History

History
31 lines (22 loc) · 1.12 KB

README.md

File metadata and controls

31 lines (22 loc) · 1.12 KB

Rego Cheat Sheet

This project contains the code to generate the Rego Cheat Sheet, in both Markdown and PDF formats.

The cheat sheet is designed to be a quick reference for those, learning and using Rego.

Rego is the declarative language used by Open Policy Agent, the general-purpose policy engine originally built by Styra.

Development

Content is defined in YAML, Rego, and JSON in cheats, and rendered to Markdown and PDF in build using a simple Go program.

The cheats dir content is fairly self-explanatory. Each top level dir is a section, each sub-dir is for a single 'cheat'.

To render the outputs, after having made changes to the cheats, run make build. This requires tectonic to be installed (brew install tectonic).

Community

For questions, discussions and announcements related to Styra products, services and open source projects, please join the Styra community on Slack!