xdg

Documentation

Overview

Package XDG manages autokitteh's configuration and data directories, which are used to store optional files such as ".env", "config.yaml" (see the CLI command "ak config"), "fake_secrets_manager.json" (if you opt-out of using a real secrets manager), SaaS client credentials, etc.

This implementation obeys the XDG Base Directory Specification: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html

The common exceptions to the default base directories are:

• macOS (a.k.a. Darwin)
• Plan 9
• Windows

Index

• Constants
• func ConfigHomeDir() string
• func DataHomeDir() string
• func Reload()

Constants

const (
	ConfigEnvVar = "XDG_CONFIG_HOME"
	DataEnvVar   = "XDG_DATA_HOME"
)

Functions

func ConfigHomeDir

func ConfigHomeDir() string

ConfigHomeDir returns the XDG config-home directory for autokitteh, and guarantees that it exists, so callers can use it safely.

func DataHomeDir

func DataHomeDir() string

DataHomeDir returns the XDG config-home directory for autokitteh, and guarantees that it exists, so callers can use it safely.

func Reload

func Reload()