interactive

Documentation

Index

• Variables
• type Action
• type Explorer
  • func NewExplorer(root *hierarchy.Node, builder *hierarchy.Builder, client *dotenv.Client) *Explorer
  • func (e *Explorer) GetCurrentPath() string
  • func (e *Explorer) Reset()
  • func (e *Explorer) Run() (selectedPath string, action Action, err error)

Variables

var ErrBack = errors.New("back")

ErrBack is returned when user wants to go back

var ErrExit = errors.New("exit")

ErrExit is returned when user wants to exit

Types

type Action

type Action string

Action represents what to do with the selected resource

const (
	ActionSelect        Action = "select"
	ActionCopy          Action = "copy"
	ActionPull          Action = "pull"
	ActionPullLevelOnly Action = "pull-level-only"
	ActionPush          Action = "push"
	ActionView          Action = "view"
	ActionBack          Action = "back"
	ActionExit          Action = "exit"
)

type Explorer

type Explorer struct {
	// contains filtered or unexported fields
}

Explorer provides interactive navigation through the resource hierarchy

func NewExplorer

func NewExplorer(root *hierarchy.Node, builder *hierarchy.Builder, client *dotenv.Client) *Explorer

NewExplorer creates a new explorer instance

func (*Explorer) GetCurrentPath

func (e *Explorer) GetCurrentPath() string

GetCurrentPath returns the current node's path

func (*Explorer) Reset

func (e *Explorer) Reset()

Reset resets the explorer to the root

func (*Explorer) Run

func (e *Explorer) Run() (selectedPath string, action Action, err error)

Run starts the interactive explorer and returns the selected path and action