env

Documentation

Overview

Package env answers where Encore tools and resources are located.

Index

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

Functions

func EncoreBin

func EncoreBin() option.Option[string]

EncoreBin reports the path to the directory containing the Encore installation's binaries.

func EncoreDaemonLogPath

func EncoreDaemonLogPath() string

EncoreDaemonLogPath reports the path to the Encore daemon log file. It can be overridden by setting ENCORE_DAEMON_LOG_PATH.

func EncoreDevDashListenAddr

func EncoreDevDashListenAddr() option.Option[string]

EncoreDevDashListenAddr reports the listen address for where the daemon exposes the dev dash. It can be overridden by setting ENCORE_DEVDASH_LISTEN_ADDR.

func EncoreGoRoot

func EncoreGoRoot() string

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

func EncoreRuntimeLib

func EncoreRuntimeLib() string

EncoreRuntimeLib reports the path to the Encore runtime library for node.js. It can be overridden by setting ENCORE_RUNTIME_LIB.

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.