env

Documentation

Overview

Package env answers where Encore tools and resources are located.

Index

• func EncoreGoRoot() string
• func EncoreRuntimesPath() string
• func IsSSH() bool
• func List() []string
• func OptEncoreGoRoot() option.Option[string]

Functions

func EncoreGoRoot

func EncoreGoRoot() string

EncoreGoRoot reports the path to the Encore Go root. It can be overridden by setting ENCORE_GOROOT.

func EncoreRuntimesPath

func EncoreRuntimesPath() string

EncoreRuntimesPath reports the path to the Encore runtime. It can be overridden by setting ENCORE_RUNTIMES_PATH.

func IsSSH

func IsSSH() bool

IsSSH reports whether the current session is an SSH session.

func List

func List() []string

List reports Encore environment variables, in the same format as os.Environ().

func OptEncoreGoRoot

func OptEncoreGoRoot() option.Option[string]

OptEncoreGoRoot reports the path to the Encore Go root. It can be overridden by setting ENCORE_GOROOT. If the goroot can't be found, it reports None.