Skip to content

Commit 92d673a

Browse files
committed
docs: clarify default path resolution and harness auto-detection
Thread 7: "default:" → "resolves to ... when unset" to avoid misleading readers on non-XDG platforms. Thread 8: add "auto-detected from the host app at startup" to explain how {harness} is determined.
1 parent 77f94aa commit 92d673a

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -418,9 +418,9 @@ All durable states live in a local SQLite database. If the database can't be ope
418418

419419
| What | Path |
420420
|------|------|
421-
| SQLite database (tags, compartments, memories, dream queue, all state) | `$XDG_DATA_HOME/cortexkit/magic-context/context.db` (default: `~/.local/share/cortexkit/magic-context/context.db`) |
422-
| Embedding model cache (downloaded ONNX model, ~90 MB) | `$XDG_DATA_HOME/cortexkit/magic-context/models/` (default: `~/.local/share/cortexkit/magic-context/models/`) |
423-
| Log file (diagnostic, non-essential) | `{tmpdir}/{harness}/magic-context/magic-context.log``{tmpdir}` is the OS temp directory (`/tmp` on Linux/macOS, `%TEMP%` on Windows); `{harness}` is `opencode` (OpenCode) or `pi` (Pi) |
421+
| SQLite database (tags, compartments, memories, dream queue, all state) | `$XDG_DATA_HOME/cortexkit/magic-context/context.db` (resolves to `~/.local/share/cortexkit/magic-context/context.db` when unset) |
422+
| Embedding model cache (downloaded ONNX model, ~90 MB) | `$XDG_DATA_HOME/cortexkit/magic-context/models/` (resolves to `~/.local/share/cortexkit/magic-context/models/` when unset) |
423+
| Log file (diagnostic, non-essential) | `{tmpdir}/{harness}/magic-context/magic-context.log``{tmpdir}` is the OS temp directory (`/tmp` on Linux/macOS, `%TEMP%` on Windows); `{harness}` is auto-detected from the host app at startup: `opencode` (OpenCode) or `pi` (Pi) |
424424

425425
> **Sandboxed / ephemeral environments** — The SQLite database and embedding model cache **must persist** between sandbox resets to avoid data loss and repeated model downloads. These paths derive from `$XDG_DATA_HOME` (default `~/.local/share`); override by setting `$XDG_DATA_HOME` to point to a persistent mount. The log file uses the OS temp directory and is optional.
426426

0 commit comments

Comments
 (0)