summaryrefslogtreecommitdiffstats
path: root/vendor/github.com/mitchellh/go-homedir/README.md
blob: d70706d5b35b6f2b877a29a6244a52c9f1f45b33 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
# 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.