repl

Documentation

Overview

Package repl provides the structs and functions necessary to run REPL for Terraform. The REPL allows experimentation of Terraform interpolations without having to run a Terraform configuration.

Index

• Variables
• func FormatValue(v cty.Value, indent int) string
• type Session
  • func (s *Session) Handle(line string) (string, bool, tfdiags.Diagnostics)

Variables

var ErrSessionExit = errors.New("session exit")

ErrSessionExit is a special error result that should be checked for from Handle to signal a graceful exit.

Functions

func FormatValue

func FormatValue(v cty.Value, indent int) string

FormatValue formats a value in a way that resembles Terraform language syntax and uses the type conversion functions where necessary to indicate exactly what type it is given, so that equality test failures can be quickly understood.

Types

type Session

type Session struct {
	// Scope is the evaluation scope where expressions will be evaluated.
	Scope *lang.Scope
}

Session represents the state for a single REPL session.

func (*Session) Handle

func (s *Session) Handle(line string) (string, bool, tfdiags.Diagnostics)

Handle handles a single line of input from the REPL.

This is a stateful operation if a command is given (such as setting a variable). This function should not be called in parallel.

The return value is the output and the error to show.