homedir

Documentation

Index

• func Get() string
• func GetShortcutString() string
• func GetStatic() (string, error)
• func Key() string

Functions

func Get

func Get() string

Get returns the home directory of the current user with the help of environment variables depending on the target operating system. Returned path should be used with "path/filepath" to form new paths.

func GetShortcutString

func GetShortcutString() string

GetShortcutString returns the string that is shortcut to user's home directory in the native shell of the platform running on.

func GetStatic

func GetStatic() (string, error)

GetStatic returns the home directory for the current user without calling os/user.Current(). This is useful for static-linked binary on glibc-based system, because a call to os/user.Current() in a static binary leads to segfault due to a glibc issue that won't be fixed in a short term. (#29344, golang/go#13470, https://sourceware.org/bugzilla/show_bug.cgi?id=19341)

func Key

func Key() string

Key returns the env var name for the user's home dir based on the platform being run on