1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
# go-app-paths
[](https://github.com/muesli/go-app-paths/releases)
[](https://pkg.go.dev/github.com/muesli/go-app-paths?tab=doc)
[](https://github.com/muesli/go-app-paths/actions)
[](https://coveralls.io/github/muesli/go-app-paths?branch=master)
[](http://goreportcard.com/report/muesli/go-app-paths)
Lets you retrieve platform-specific paths (like directories for app-data, cache,
config, and logs). It is fully compliant with the [XDG Base Directory Specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html)
on Unix, but also provides implementations for macOS and Windows systems.
## Installation
Make sure you have a working Go environment (Go 1.2 or higher is required).
See the [install instructions](http://golang.org/doc/install.html).
To install go-app-paths, simply run:
go get github.com/muesli/go-app-paths
## Usage
```go
import gap "github.com/muesli/go-app-paths"
```
### Scopes
You can initialize `gap` with either the `gap.User` or `gap.System` scope to
retrieve user- and/or system-specific base directories and paths:
```go
scope := gap.NewScope(gap.User, "app")
```
### Directories
`DataDirs` retrieves a priority-sorted list of data directories:
```go
dirs, err := scope.DataDirs()
```
| Platform | User Scope | System Scope |
| -------- | ---------------------------------------------------------------- | ------------------------------------------ |
| Unix | ["~/.local/share/app", "/usr/local/share/app", "/usr/share/app"] | ["/usr/local/share/app", "/usr/share/app"] |
| macOS | ["~/Library/Application Support/app"] | ["/Library/Application Support/app"] |
| Windows | ["%LOCALAPPDATA%/app"] | ["%PROGRAMDATA%/app"] |
---
`ConfigDirs` retrieves a priority-sorted list of config directories:
```go
dirs, err := scope.ConfigDirs()
```
| Platform | User Scope | System Scope |
| -------- | --------------------------------------------- | ---------------------------- |
| Unix | ["~/.config/app", "/etc/xdg/app", "/etc/app"] | ["/etc/xdg/app", "/etc/app"] |
| macOS | ["~/Library/Preferences/app"] | ["/Library/Preferences/app"] |
| Windows | ["%LOCALAPPDATA%/app/Config"] | ["%PROGRAMDATA%/app/Config"] |
---
`CacheDir` retrieves the app's cache directory:
```go
dir, err := scope.CacheDir()
```
| Platform | User Scope | System Scope |
| -------- | ------------------------ | ----------------------- |
| Unix | ~/.cache/app | /var/cache/app |
| macOS | ~/Library/Caches/app | /Library/Caches/app |
| Windows | %LOCALAPPDATA%/app/Cache | %PROGRAMDATA%/app/Cache |
### Default File Paths
`DataPath` retrieves the default path for a data file:
```go
path, err := scope.DataPath("filename")
```
| Platform | User Scope | System Scope |
| -------- | ------------------------------------------ | ----------------------------------------- |
| Unix | ~/.local/share/app/filename | /usr/local/share/app/filename |
| macOS | ~/Library/Application Support/app/filename | /Library/Application Support/app/filename |
| Windows | %LOCALAPPDATA%/app/filename | %PROGRAMDATA%/app/filename |
---
`ConfigPath` retrieves the default path for a config file:
```go
path, err := scope.ConfigPath("filename.conf")
```
| Platform | User Scope | System Scope |
| -------- | --------------------------------------- | -------------------------------------- |
| Unix | ~/.config/app/filename.conf | /etc/xdg/app/filename.conf |
| macOS | ~/Library/Preferences/app/filename.conf | /Library/Preferences/app/filename.conf |
| Windows | %LOCALAPPDATA%/app/Config/filename.conf | %PROGRAMDATA%/app/Config/filename.conf |
---
`LogPath` retrieves the default path for a log file:
```go
path, err := scope.LogPath("filename.log")
```
| Platform | User Scope | System Scope |
| -------- | ------------------------------------ | ----------------------------------- |
| Unix | ~/.local/share/app/filename.log | /var/log/app/filename.log |
| macOS | ~/Library/Logs/app/filename.log | /Library/Logs/app/filename.log |
| Windows | %LOCALAPPDATA%/app/Logs/filename.log | %PROGRAMDATA%/app/Logs/filename.log |
### Lookup Methods
`LookupData` retrieves a priority-sorted list of paths for existing data files
with the name `filename`:
```go
path, err := scope.LookupData("filename")
```
| Platform | User Scope | System Scope |
| -------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------ |
| Unix | ["~/.local/share/app/filename", "/usr/local/share/app/filename", "/usr/share/app/filename"] | ["/usr/local/share/app/filename", "/usr/share/app/filename"] |
| macOS | ["~/Library/Application Support/app/filename"] | ["/Library/Application Support/app/filename"] |
| Windows | ["%LOCALAPPDATA%/app/filename"] | ["%PROGRAMDATA%/app/filename"] |
---
`LookupConfig` retrieves a priority-sorted list of paths for existing config
files with the name `filename.conf`:
```go
path, err := scope.LookupConfig("filename.conf")
```
| Platform | User Scope | System Scope |
| -------- | --------------------------------------------------------------------------------------- | -------------------------------------------------------- |
| Unix | ["~/.config/app/filename.conf", "/etc/xdg/app/filename.conf", "/etc/app/filename.conf"] | ["/etc/xdg/app/filename.conf", "/etc/app/filename.conf"] |
| macOS | ["~/Library/Preferences/app/filename.conf"] | ["/Library/Preferences/app/filename.conf"] |
| Windows | ["%LOCALAPPDATA%/app/Config/filename.conf"] | ["%PROGRAMDATA%/app/Config/filename.conf"] |
|
