homedir

Documentation

Index

• Variables
• func Dir() (string, error)
• func Expand(path string) (string, error)
• func Reset()

Variables

var DisableCache bool

DisableCache will disable caching of the home directory. Caching is enabled by default.

Functions

func Dir

func Dir() (string, error)

Dir returns the home directory for the executing user.

This uses an OS-specific method for discovering the home directory. An error is returned if a home directory cannot be detected.

func Expand

func Expand(path string) (string, error)

Expand expands the path to include the home directory if the path is prefixed with `~`. If it isn't prefixed with `~`, the path is returned as-is.

func Reset

func Reset()

Reset clears the store, forcing the next call to Dir to re-detect the home directory. This generally never has to be called, but can be useful in tests if you're modifying the home directory via the HOME env var or something.