Skip to content

Add note about XDG_DATA_HOME #244

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
theferrit32 merged 2 commits into from
Oct 10, 2025
Merged

Add note about XDG_DATA_HOME #244

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
01e84aa
Add note about XDG_DATA_HOME
theferrit32 Sep 16, 2025
42f519f
Merge branch 'main' into XDG_DATA_HOME-docs
theferrit32 Oct 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,13 @@ Run tests:
SEQREPO_DATAPROXY_URI=seqrepo+file:///usr/local/share/seqrepo/latest
```

The wags-tails library also uses XDG_DATA_HOME/XDG_DATA_DIRS, which can vary by platform, terminal, and shell settings. If you see an error about writing to `/usr/` or an application data directory, it may be related to this. For example if XDG_DATA_DIRS is not set, the `ghostty` terminal sets it automatically and the value it may set it to may not exist or be writable by your user account. An easy fix is to add to your shell startup script (e.g. ~/.bashrc, ~/.zshrc, etc) and set these variables to some location in your user home directory.

```shell
export XDG_DATA_HOME="$HOME/.local/share"
export XDG_DATA_DIRS="$XDG_DATA_HOME:$XDG_DATA_DIRS"
```

6. Finally, run tests with the following command:

```shell
Expand Down