package termenv

Import Path
	github.com/gookit/goutil/x/termenv (on go.dev)

Dependency Relation
	imports 11 packages, and imported by one package

Involved Source Files

	    detect_color.go
	    detect_nonwin.go
	  d termenv.go
		Package termenv provides detect color support of the current terminal.
		And with some utils for terminal env.

	    util.go
Package-Level Type Names (only one)

	/* sort by: alphabet | popularity */
	 type ColorLevel uint8 (basic type)
		ColorLevel is the color level supported by a terminal.

		Methods (only one)
			( ColorLevel) String() string
				String returns the string name of the color level.

		Implements (at least 2)
			 ColorLevel : expvar.Var
			 ColorLevel : fmt.Stringer
		As Outputs Of (at least 3)
			func DetectColorLevel() ColorLevel
			func TermColorLevel() ColorLevel
			func github.com/gookit/goutil/x/ccolor.Level() ColorLevel
		As Inputs Of (at least one exported)
			func SetColorLevel(level ColorLevel)
		As Types Of (total 4)
			const TermColor16
			const TermColor256
			const TermColorNone
			const TermColorTrue


Package-Level Functions (total 18)

	 func CurrentShell(onlyName bool, fallbackShell ...string) string
		CurrentShell get current used shell env file.
		
		eg "/bin/zsh" "/bin/bash".
		if onlyName=true, will return "zsh", "bash"

	 func DetectColorLevel() ColorLevel
		DetectColorLevel for current env
		
		NOTICE: The method will detect terminal info each time.
		
			if only want to get current color level, please direct call IsSupportColor() or TermColorLevel()

	 func DisableColor()
		DisableColor in the current terminal

	 func ForceEnableColor()
		ForceEnableColor flags value. TIP: use for unit testing.
		
		Usage:
		
			ccolor.ForceEnableColor()
			defer ccolor.RevertColorSupport()

	 func GetTermSize(refresh ...bool) (w int, h int)
		GetTermSize for current console terminal. will first try to get from environment variables COLUMNS and LINES.

	 func HasShellEnv(shell string) bool
		HasShellEnv has shell env check.
		
		Usage:
		
			HasShellEnv("sh")
			HasShellEnv("bash")

	 func IsShellSpecialVar(c uint8) bool
		IsShellSpecialVar reports whether the character identifies a special
		shell variable such as $*.

	 func IsSupport256Color() bool
		IsSupport256Color returns true if the terminal supports 256 colors.

	 func IsSupportColor() bool
		IsSupportColor returns true if the terminal supports color.

	 func IsSupportTrueColor() bool
		IsSupportTrueColor returns true if the terminal supports true color.

	 func IsTerminal() bool
		IsTerminal 检查是否为终端设备中

	 func LastErr() error
		LastErr returns the last error.

	 func NoColor() bool
		NoColor returns true if the NO_COLOR environment variable is set.

	 func ReadPassword(question ...string) string
		ReadPassword from console terminal

	 func RevertColorSupport()
		RevertColorSupport flags to init value.

	 func SetColorLevel(level ColorLevel)
		SetColorLevel value force.

	 func SetDebugMode(enable bool)
		SetDebugMode sets debug mode.

	 func TermColorLevel() ColorLevel
		TermColorLevel returns the color support level for the current terminal.


Package-Level Constants (total 4)

	const TermColor16 ColorLevel = 1 // 16(4bit) ANSI color supported
	const TermColor256 ColorLevel = 2 // 256(8bit) color supported
	const TermColorNone ColorLevel = 0 // not support color
	const TermColorTrue ColorLevel = 3 // support TRUE(RGB) color

The pages are generated with Golds v0.8.4. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.