repl

Documentation

Overview

Deprecated: This package is intended for older projects transitioning from OPA v0.x and will remain for the lifetime of OPA v1.x, but its use is not recommended. For newer features and behaviours, such as defaulting to the Rego v1 syntax, use the corresponding components in the github.com/open-policy-agent/opa/v1 package instead. See https://www.openpolicyagent.org/docs/latest/v0-compatibility/ for more information.

Package repl implements a Read-Eval-Print-Loop (REPL) for interacting with the policy engine.

The REPL is typically used from the command line, however, it can also be used as a library. nolint: goconst // String reuse here doesn't make sense to deduplicate.

Index

• Constants
• type Error
• type REPL
  • func New(store storage.Store, historyPath string, output io.Writer, outputFormat string, ...) *REPL

Constants

const (
	// BadArgsErr indicates bad arguments were provided to a built-in REPL
	// command.
	BadArgsErr string = v1.BadArgsErr
)

Types

type Error

type Error = v1.Error

Error is the error type returned by the REPL.

type REPL

type REPL = v1.REPL

REPL represents an instance of the interactive shell.

func New

func New(store storage.Store, historyPath string, output io.Writer, outputFormat string, errLimit int, banner string) *REPL

New returns a new instance of the REPL.