open-vault/vendor/github.com/mitchellh/go-homedir
Jeff Mitchell 6ebf1cf713 Bump deps 2017-01-04 16:47:38 -05:00
..
LICENSE Migrate to built-in Go vendoring. 2016-02-18 15:06:02 -05:00
README.md Migrate to built-in Go vendoring. 2016-02-18 15:06:02 -05:00
homedir.go Bump deps 2017-01-04 16:47:38 -05:00

README.md

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.