go-appdir

Go package to get application directories such as config and cache.

Dirs.SystemConfig(), Dirs.SystemData(), Dirs.SystemLogs(), and Dirs.SystemRun() return the system-level locations defined by each platform, while the User* methods accept an optional UID string so you can query paths for another user (current user when omitted).

Platform	Windows	[Linux/BSDs]	macOS
User-specific config	%APPDATA% (C:\Users\%USERNAME%\AppData\Roaming)	$HOME/.config	$HOME/Library/Application Support
User-specific cache	%LOCALAPPDATA% (C:\Users\%USERNAME%\AppData\Local)	$HOME/.cache	$HOME/Library/Caches
User-specific data	%LOCALAPPDATA% (C:\Users\%USERNAME%\AppData\Local)	$HOME/.local/share	$HOME/Library/Application Support
User-specific logs	%LOCALAPPDATA% (C:\Users\%USERNAME%\AppData\Local)	$HOME/.cache/<name>/logs	$HOME/Library/Logs
User-specific run	%LOCALAPPDATA%\<name>\Run	/run/user/<uid>/<name>	$HOME/.<name>/run
System-wide config	%PROGRAMDATA% (C:\ProgramData)	/etc	/Library/Application Support
System-wide data	%PROGRAMDATA% (C:\ProgramData)	/var/lib	/Library/Application Support
System-wide logs	%PROGRAMDATA% (C:\ProgramData)	/var/log	/Library/Logs
System-wide run	%PROGRAMDATA% (C:\ProgramData)	/var/run	/var/run

Inspired by configdir.

Usage

package main

import (
	"os"
	"path/filepath"

	"go.linka.cloud/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