Skip to content

docs(readme): document local state dir + PINAKES_STATE_ROOT #52

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
001TMF merged 1 commit into from
Jun 14, 2026
Merged

docs(readme): document local state dir + PINAKES_STATE_ROOT #52

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,22 @@ Get a free key from your [NCBI account](https://www.ncbi.nlm.nih.gov/account/)

---

## Local state

Pinakes stores its content-addressed snapshots and reproducibility manifests under your OS cache
directory by default — `~/Library/Caches/pinakes` on macOS, `$XDG_CACHE_HOME/pinakes` (else
`~/.cache/pinakes`) on Linux. It is created on first use; back it up or clear it like any cache.
Relocate it with `PINAKES_STATE_ROOT`:

```sh
export PINAKES_STATE_ROOT=/path/to/pinakes-state # where the local snapshot store lives
```

Everything stays local: a pinned query and its `pinakes verify` re-run read this directory with
**no network access**.

---

## Why Pinakes

Three guarantees, none of which a raw API call or a typical MCP wrapper gives you:
Expand Down