53 lines
1.4 KiB
Markdown
53 lines
1.4 KiB
Markdown
|
# go-appdir
|
||
|
|
|
||
|
|
[](https://godoc.org/github.com/ProtonMail/go-appdir)
|
||
|
|
|
||
|
|
Minimalistic Go package to get application directories such as config and cache.
|
||
|
|
|
||
|
|
Platform | Windows | [Linux/BSDs](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html) | macOS
|
||
|
|
-------- | ------- | ------------------------------------------------------------------------------------------ | -----
|
||
|
|
User-specific config | `%APPDATA%` (`C:\Users\%USERNAME%\AppData\Roaming`) | `$XDG_CONFIG_HOME` (`$HOME/.config`) | `$HOME/Library/Application Support`
|
||
|
|
User-specific cache | `%LOCALAPPDATA%` (`C:\Users\%USERNAME%\AppData\Local`) | `$XDG_CACHE_HOME` (`$HOME/.cache`) | `$HOME/Library/Caches`
|
||
|
|
User-specific logs | `%LOCALAPPDATA%` (`C:\Users\%USERNAME%\AppData\Local`) | `$XDG_STATE_HOME` (`$HOME/.local/state`) | `$HOME/Library/Logs`
|
||
|
|
|
||
|
|
Inspired by [`configdir`](https://github.com/shibukawa/configdir).
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```go
|
||
|
|
package main
|
||
|
|
|
||
|
|
import (
|
||
|
|
"os"
|
||
|
|
"path/filepath"
|
||
|
|
|
||
|
|
"github.com/ProtonMail/go-appdir"
|
||
|
|
)
|
||
|
|
|
||
|
|
func main() {
|
||
|
|
// Get directories for our app
|
||
|
|
dirs := appdir.New("my-awesome-app")
|
||
|
|
|
||
|
|
// Get user-specific config dir
|
||
|
|
p := dirs.UserConfig()
|
||
|
|
|
||
|
|
// Create our app config dir
|
||
|
|
if err := os.MkdirAll(p, 0755); err != nil {
|
||
|
|
panic(err)
|
||
|
|
}
|
||
|
|
|
||
|
|
// Now we can use it
|
||
|
|
f, err := os.Create(filepath.Join(p, "config-file"))
|
||
|
|
if err != nil {
|
||
|
|
panic(err)
|
||
|
|
}
|
||
|
|
defer f.Close()
|
||
|
|
|
||
|
|
f.Write([]byte("<3"))
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
MIT
|