Skip to content

Files and directories ​

quarry uses two directories, following the XDG layout on Linux and macOS alike:

DirectoryDefaultOverride
Config~/.config/quarryQUARRY_CONFIG_DIR, or $XDG_CONFIG_HOME/quarry
Data~/.local/share/quarryQUARRY_DATA_DIR, or $XDG_DATA_HOME/quarry

Keep the config directory in your dotfiles if you like: it holds settings, favourites and themes, but no API keys.

Config directory ​

FileContents
config.tomlSettings and saved connections. Created with comments on first run. See Configuration file.
config.toml.bakThe previous config.toml, kept whenever quarry rewrites it
favorites.tomlFavourite queries
themes/Your custom themes: *.toml, *.yaml, *.yml

With --config FILE, favorites.toml and themes/ are read from the directory that holds FILE.

Data directory ​

FileContents
history.txtStatement history, shared by the REPL and the TUI
quarry.logEvery statement, when log_queries = true
credentials.tomlAPI keys saved by --setup-llm
ui-state.tomlThe theme you last picked in the TUI

Permissions ​

config.toml, favorites.toml, history.txt, quarry.log, credentials.toml, ui-state.toml, and files you write with \o, tee and \export, are created readable only by you (mode 600).

Starting fresh ​

sh
rm -rf ~/.config/quarry ~/.local/share/quarry

quarry creates a new commented config.toml next time it runs.

Released under the MIT licence.