README

xdg logo

Go implementation of the XDG Base Directory Specification and XDG user directories.

Build status Code coverage pkg.go.dev documentation MIT license
Go report card Awesome Go GitHub contributors GitHub open issues Buy me a coffee

Provides an implementation of the XDG Base Directory Specification. The specification defines a set of standard paths for storing application files, including data and configuration files. For portability and flexibility reasons, applications should use the XDG defined locations instead of hardcoding paths.

The package also includes the locations of well known user directories and an implementation of the state directory proposal. Most flavors of Unix, Windows, macOS and Plan 9 are supported.

Full documentation can be found at: https://pkg.go.dev/github.com/adrg/xdg.

Installation

go get github.com/adrg/xdg

Default locations

The package defines sensible defaults for XDG variables which are empty or not present in the environment.

XDG Base Directory
Unix macOS Windows Plan 9
XDG_DATA_HOME ~/.local/share ~/Library/Application Support %LOCALAPPDATA% $home/lib
XDG_DATA_DIRS /usr/local/share
/usr/share
/Library/Application Support %APPDATA%\Roaming
%PROGRAMDATA%
/lib
XDG_CONFIG_HOME ~/.config ~/Library/Application Support %LOCALAPPDATA% $home/lib
XDG_CONFIG_DIRS /etc/xdg ~/Library/Preferences
/Library/Application Support
/Library/Preferences
%PROGRAMDATA% /lib
XDG_CACHE_HOME ~/.cache ~/Library/Caches %LOCALAPPDATA%\cache $home/lib/cache
XDG_RUNTIME_DIR /run/user/UID ~/Library/Application Support %LOCALAPPDATA% /tmp
XDG user directories
Unix macOS Windows Plan 9
XDG_DESKTOP_DIR ~/Desktop ~/Desktop %USERPROFILE%\Desktop $home/desktop
XDG_DOWNLOAD_DIR ~/Downloads ~/Downloads %USERPROFILE%\Downloads $home/downloads
XDG_DOCUMENTS_DIR ~/Documents ~/Documents %USERPROFILE%\Documents $home/documents
XDG_MUSIC_DIR ~/Music ~/Music %USERPROFILE%\Music $home/music
XDG_PICTURES_DIR ~/Pictures ~/Pictures %USERPROFILE%\Pictures $home/pictures
XDG_VIDEOS_DIR ~/Videos ~/Movies %USERPROFILE%\Videos $home/videos
XDG_TEMPLATES_DIR ~/Templates ~/Templates %USERPROFILE%\Templates $home/templates
XDG_PUBLICSHARE_DIR ~/Public ~/Public %PUBLIC% $home/public
Non-standard directories

State directory

Unix macOS Windows Plan 9
XDG_STATE_HOME ~/.local/state ~/Library/Application Support %LOCALAPPDATA% $home/lib/state

Application directories

Unix macOS Windows Plan 9
$XDG_DATA_HOME/applications /Applications %APPDATA%\Roaming\Microsoft\Windows\Start Menu\Programs $home/bin
~/.local/share/applications /bin
/usr/local/share/applications
/usr/share/applications
$XDG_DATA_DIRS/applications

Font directories

Unix macOS Windows Plan 9
$XDG_DATA_HOME/fonts ~/Library/Fonts %windir%\Fonts $home/lib/font
~/.fonts /Library/Fonts %LOCALAPPDATA%\Microsoft\Windows\Fonts /lib/font
~/.local/share/fonts /System/Library/Fonts
/usr/local/share/fonts /Network/Library/Fonts
/usr/share/fonts
$XDG_DATA_DIRS/fonts

Usage

XDG Base Directory
package main

import (
	"log"

	"github.com/adrg/xdg"
)

func main() {
	// XDG Base Directory paths.
	log.Println("Home data directory:", xdg.DataHome)
	log.Println("Data directories:", xdg.DataDirs)
	log.Println("Home config directory:", xdg.ConfigHome)
	log.Println("Config directories:", xdg.ConfigDirs)
	log.Println("Cache directory:", xdg.CacheHome)
	log.Println("Runtime directory:", xdg.RuntimeDir)

	// Non-standard directories.
	log.Println("Home state directory:", xdg.StateHome)
	log.Println("Application directories:", xdg.ApplicationDirs)
	log.Println("Font directories:", xdg.FontDirs)

	// Obtain a suitable location for application config files.
	// ConfigFile takes one parameter which must contain the name of the file,
	// but it can also contain a set of parent directories. If the directories
	// don't exist, they will be created relative to the base config directory.
	configFilePath, err := xdg.ConfigFile("appname/config.yaml")
	if err != nil {
		log.Fatal(err)
	}
	log.Println("Save the config file at:", configFilePath)

	// For other types of application files use:
	// xdg.DataFile()
	// xdg.CacheFile()
	// xdg.RuntimeFile()
	// xdg.StateFile()

	// Finding application config files.
	// SearchConfigFile takes one parameter which must contain the name of
	// the file, but it can also contain a set of parent directories relative
	// to the config search paths (xdg.ConfigHome and xdg.ConfigDirs).
	configFilePath, err = xdg.SearchConfigFile("appname/config.yaml")
	if err != nil {
		log.Fatal(err)
	}
	log.Println("Config file was found at:", configFilePath)

	// For other types of application files use:
	// xdg.SearchDataFile()
	// xdg.SearchCacheFile()
	// xdg.SearchRuntimeFile()
	// xdg.SearchStateFile()
}
XDG user directories
package main

import (
	"log"

	"github.com/adrg/xdg"
)

func main() {
	// XDG user directories.
	log.Println("Desktop directory:", xdg.UserDirs.Desktop)
	log.Println("Download directory:", xdg.UserDirs.Download)
	log.Println("Documents directory:", xdg.UserDirs.Documents)
	log.Println("Music directory:", xdg.UserDirs.Music)
	log.Println("Pictures directory:", xdg.UserDirs.Pictures)
	log.Println("Videos directory:", xdg.UserDirs.Videos)
	log.Println("Templates directory:", xdg.UserDirs.Templates)
	log.Println("Public directory:", xdg.UserDirs.PublicShare)
}

Stargazers over time

Stargazers over time

Contributing

Contributions in the form of pull requests, issues or just general feedback, are always welcome.
See CONTRIBUTING.MD.

Contributors: adrg, wichert, bouncepaw, gabriel-vasile, KalleDK, djdv.

References

For more information see:

License

Copyright (c) 2014 Adrian-George Bostan.

This project is licensed under the MIT license. See LICENSE for more details.

Documentation

Overview

    Package xdg provides an implementation of the XDG Base Directory Specification. The specification defines a set of standard paths for storing application files including data and configuration files. For portability and flexibility reasons, applications should use the XDG defined locations instead of hardcoding paths. The package also includes the locations of well known user directories. The current implementation supports Windows, Mac OS and most flavors of Unix.

    For more information regarding the XDG Base Directory Specification see:
    https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html
    
    For more information regarding the XDG user directories see:
    https://wiki.archlinux.org/index.php/XDG_user_directories
    
    For more information regarding the XDG state directory proposal see:
    https://wiki.debian.org/XDGBaseDirectorySpecification#Proposal:_STATE_directory
    https://lists.freedesktop.org/archives/xdg/2016-December/013803.html
    

    Index

    Examples

    Constants

    This section is empty.

    Variables

    View Source
    var (
    	// Home contains the path of the user's home directory.
    	Home string
    
    	// DataHome defines the base directory relative to which user-specific
    	// data files should be stored. This directory is defined by the
    	// $XDG_DATA_HOME environment variable. If the variable is not set,
    	// a default equal to $HOME/.local/share should be used.
    	DataHome string
    
    	// DataDirs defines the preference-ordered set of base directories to
    	// search for data files in addition to the DataHome base directory.
    	// This set of directories is defined by the $XDG_DATA_DIRS environment
    	// variable. If the variable is not set, the default directories
    	// to be used are /usr/local/share and /usr/share, in that order. The
    	// DataHome directory is considered more important than any of the
    	// directories defined by DataDirs. Therefore, user data files should be
    	// written relative to the DataHome directory, if possible.
    	DataDirs []string
    
    	// ConfigHome defines the base directory relative to which user-specific
    	// configuration files should be written. This directory is defined by
    	// the $XDG_CONFIG_HOME environment variable. If the variable is not
    	// not set, a default equal to $HOME/.config should be used.
    	ConfigHome string
    
    	// ConfigDirs defines the preference-ordered set of base directories to
    	// search for configuration files in addition to the ConfigHome base
    	// directory. This set of directories is defined by the $XDG_CONFIG_DIRS
    	// environment variable. If the variable is not set, a default equal
    	// to /etc/xdg should be used. The ConfigHome directory is considered
    	// more important than any of the directories defined by ConfigDirs.
    	// Therefore, user config files should be written relative to the
    	// ConfigHome directory, if possible.
    	ConfigDirs []string
    
    	// CacheHome defines the base directory relative to which user-specific
    	// non-essential (cached) data should be written. This directory is
    	// defined by the $XDG_CACHE_HOME environment variable. If the variable
    	// is not set, a default equal to $HOME/.cache should be used.
    	CacheHome string
    
    	// RuntimeDir defines the base directory relative to which user-specific
    	// non-essential runtime files and other file objects (such as sockets,
    	// named pipes, etc.) should be stored. This directory is defined by the
    	// $XDG_RUNTIME_DIR environment variable. If the variable is not set,
    	// applications should fall back to a replacement directory with similar
    	// capabilities. Applications should use this directory for communication
    	// and synchronization purposes and should not place larger files in it,
    	// since it might reside in runtime memory and cannot necessarily be
    	// swapped out to disk.
    	RuntimeDir string
    
    	// StateHome defines the base directory relative to which user-specific
    	// volatile data files should be stored. This directory is defined by
    	// the non-standard $XDG_STATE_HOME environment variable. If the variable
    	// is not set, a default equal to ~/.local/state should be used.
    	StateHome string
    
    	// UserDirs defines the locations of well known user directories.
    	UserDirs UserDirectories
    
    	// FontDirs defines the common locations where font files are stored.
    	FontDirs []string
    
    	// ApplicationDirs defines the common locations of applications.
    	ApplicationDirs []string
    )

    Functions

    func CacheFile

    func CacheFile(relPath string) (string, error)

      CacheFile returns a suitable location for the specified cache file. The relPath parameter must contain the name of the cache file, and optionally, a set of parent directories (e.g. appname/app.cache). If the specified directories do not exist, they will be created relative to the base cache directory. On failure, an error containing the attempted paths is returned.

      Example
      Output:
      
      

      func ConfigFile

      func ConfigFile(relPath string) (string, error)

        ConfigFile returns a suitable location for the specified config file. The relPath parameter must contain the name of the config file, and optionally, a set of parent directories (e.g. appname/app.yaml). If the specified directories do not exist, they will be created relative to the base config directory. On failure, an error containing the attempted paths is returned.

        Example
        Output:
        
        

        func DataFile

        func DataFile(relPath string) (string, error)

          DataFile returns a suitable location for the specified data file. The relPath parameter must contain the name of the data file, and optionally, a set of parent directories (e.g. appname/app.data). If the specified directories do not exist, they will be created relative to the base data directory. On failure, an error containing the attempted paths is returned.

          Example
          Output:
          
          

          func Reload

          func Reload()

            Reload refreshes base and user directories by reading the environment. Defaults are applied for XDG variables which are empty or not present in the environment.

            func RuntimeFile

            func RuntimeFile(relPath string) (string, error)

              RuntimeFile returns a suitable location for the specified runtime file. The relPath parameter must contain the name of the runtime file, and optionally, a set of parent directories (e.g. appname/app.pid). If the specified directories do not exist, they will be created relative to the base runtime directory. On failure, an error containing the attempted paths is returned.

              Example
              Output:
              
              

              func SearchCacheFile

              func SearchCacheFile(relPath string) (string, error)

                SearchCacheFile searches for the specified file in the cache search path. The relPath parameter must contain the name of the cache file, and optionally, a set of parent directories (e.g. appname/app.cache). If the file cannot be found, an error specifying the searched path is returned.

                Example
                Output:
                
                

                func SearchConfigFile

                func SearchConfigFile(relPath string) (string, error)

                  SearchConfigFile searches for the specified file in config search paths. The relPath parameter must contain the name of the config file, and optionally, a set of parent directories (e.g. appname/app.yaml). If the file cannot be found, an error specifying the searched paths is returned.

                  Example
                  Output:
                  
                  

                  func SearchDataFile

                  func SearchDataFile(relPath string) (string, error)

                    SearchDataFile searches for specified file in the data search paths. The relPath parameter must contain the name of the data file, and optionally, a set of parent directories (e.g. appname/app.data). If the file cannot be found, an error specifying the searched paths is returned.

                    Example
                    Output:
                    
                    

                    func SearchRuntimeFile

                    func SearchRuntimeFile(relPath string) (string, error)

                      SearchRuntimeFile searches for the specified file in the runtime search path. The relPath parameter must contain the name of the runtime file, and optionally, a set of parent directories (e.g. appname/app.pid). If the file cannot be found, an error specifying the searched path is returned.

                      Example
                      Output:
                      
                      

                      func SearchStateFile

                      func SearchStateFile(relPath string) (string, error)

                        SearchStateFile searches for the specified file in the state search path. The relPath parameter must contain the name of the state file, and optionally, a set of parent directories (e.g. appname/app.state). If the file cannot be found, an error specifying the searched path is returned.

                        Example
                        Output:
                        
                        

                        func StateFile

                        func StateFile(relPath string) (string, error)

                          StateFile returns a suitable location for the specified state file. State files are usually volatile data files, not suitable to be stored relative to the $XDG_DATA_HOME directory. The relPath parameter must contain the name of the state file, and optionally, a set of parent directories (e.g. appname/app.state). If the specified directories do not exist, they will be created relative to the base state directory. On failure, an error containing the attempted paths is returned.

                          Example
                          Output:
                          
                          

                          Types

                          type UserDirectories

                          type UserDirectories struct {
                          	// Desktop defines the location of the user's desktop directory.
                          	Desktop string
                          
                          	// Download defines a suitable location for user downloaded files.
                          	Download string
                          
                          	// Documents defines a suitable location for user document files.
                          	Documents string
                          
                          	// Music defines a suitable location for user audio files.
                          	Music string
                          
                          	// Pictures defines a suitable location for user image files.
                          	Pictures string
                          
                          	// VideosDir defines a suitable location for user video files.
                          	Videos string
                          
                          	// Templates defines a suitable location for user template files.
                          	Templates string
                          
                          	// PublicShare defines a suitable location for user shared files.
                          	PublicShare string
                          }

                            UserDirectories defines the locations of well known user directories.