homedir

README

go-homedir

This is a Go library for detecting the user's home directory without the use of cgo, so the library can be used in cross-compilation environments.

Usage is incredibly simple, just call homedir.Dir() to get the home directory for a user, and homedir.Expand() to expand the ~ in a path to the home directory.

Why not just use os/user? The built-in os/user package requires cgo on Darwin systems. This means that any Go code that uses that package cannot cross compile. But 99% of the time the use for os/user is just to retrieve the home directory, which we can do for the current user without cgo. This library does that, enabling cross-compilation.

This is a fork of mitchellh/go-homedir. The main addition is to add a flag to prefer the %UserProfile% on Windows, which is the preferred path for tools such as the AWS CLI.

Documentation

Index

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

Variables

var DisableCache bool

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

var WinPreferUserProfile bool

WinPreferUserProfile will prefer %USERPROFILE% on windows systems

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.