envutil

Documentation

Index

• Variables
• func Environ() map[string]string
• func Getenv(name string, def ...string) string
• func HasShellEnv(shell string) bool
• func IsConsole(out io.Writer) bool
• func IsLinux() bool
• func IsMSys() bool
• func IsMac() bool
• func IsSupport256Color() bool
• func IsSupportColor() bool
• func IsSupportTrueColor() bool
• func IsTerminal(fd uintptr) bool
• func IsWSL() bool
• func IsWin() bool
• func IsWindows() bool
• func ParseEnvValue(val string) (newVal string)
• func StdIsTerminal() bool
• func VarParse(str string) string

Variables

var ValueGetter = os.Getenv

ValueGetter Env value provider func. TIPS: you can custom provide data.

var VarReplace = os.ExpandEnv

VarReplace replaces ${var} or $var in the string according to the values

Functions

func Environ

func Environ() map[string]string

Environ like os.Environ, but will returns key-value map[string]string data.

func Getenv

func Getenv(name string, def ...string) string

Getenv get ENV value by key name

func HasShellEnv

func HasShellEnv(shell string) bool

HasShellEnv has shell env check. Usage:

HasShellEnv("sh")
HasShellEnv("bash")

func IsConsole

func IsConsole(out io.Writer) bool

IsConsole check out is console env. alias of the sysutil.IsConsole()

func IsLinux

func IsLinux() bool

IsLinux system

func IsMSys

func IsMSys() bool

IsMSys msys(MINGW64) env. alias of the sysutil.IsMSys()

func IsMac

func IsMac() bool

IsMac system

func IsSupport256Color

func IsSupport256Color() bool

IsSupport256Color render

func IsSupportColor

func IsSupportColor() bool

IsSupportColor check current console is support color.

Supported:

linux, mac, or windows's ConEmu, Cmder, putty, git-bash.exe

Not support:

windows cmd.exe, powerShell.exe

func IsSupportTrueColor

func IsSupportTrueColor() bool

IsSupportTrueColor render. IsSupportRGBColor

func IsTerminal

func IsTerminal(fd uintptr) bool

IsTerminal isatty check

Usage:

envutil.IsTerminal(os.Stdout.Fd())

func IsWSL

func IsWSL() bool

IsWSL system env https://github.com/Microsoft/WSL/issues/423#issuecomment-221627364

func IsWin

func IsWin() bool

IsWin system. linux windows darwin

func IsWindows

func IsWindows() bool

IsWindows system. alias of IsWin

func ParseEnvValue

func ParseEnvValue(val string) (newVal string)

ParseEnvValue parse ENV var value from input string, support default value.

func StdIsTerminal

func StdIsTerminal() bool

StdIsTerminal os.Stdout is terminal

func VarParse

func VarParse(str string) string

VarParse alias of the ParseEnvValue