sqlite-graphrag 1.0.5

Local GraphRAG memory for LLMs in a single SQLite file
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

# Migration Guide — neurographrag to sqlite-graphrag

- This guide covers the rename from legacy `neurographrag` to `sqlite-graphrag v1.0.2`
- The renamed project keeps the same core feature set as legacy `neurographrag v2.3.0`
- The public crate and repository are live; use the local checkout only when validating unreleased changes

## What Changes
- Binary name changes from `neurographrag` to `sqlite-graphrag`
- Cargo package name changes from `neurographrag` to `sqlite-graphrag`
- Rust crate path changes from `neurographrag` to `sqlite_graphrag`
- Environment variables change from `NEUROGRAPHRAG_*` to `SQLITE_GRAPHRAG_*`
- Default local database file becomes `./graphrag.sqlite` in the invocation directory
- Default XDG application directories change from `neurographrag` to `sqlite-graphrag`
- Database schema stays compatible; the biggest risk is path drift, not schema drift

## Step-by-Step Migration
### Step 1 — Install the renamed binary
```bash
cargo install --path .
```
- Install the published release with `cargo install sqlite-graphrag --version 1.0.2`

### Step 2 — Update command invocations
```bash
sqlite-graphrag init
sqlite-graphrag health --json
sqlite-graphrag recall "postgres migration" --k 5 --json
```
- Replace every `neurographrag ...` call in scripts, CI jobs, and local aliases

### Step 3 — Update environment variables
| Old | New |
| --- | --- |
| `NEUROGRAPHRAG_DB_PATH` | `SQLITE_GRAPHRAG_DB_PATH` |
| `NEUROGRAPHRAG_CACHE_DIR` | `SQLITE_GRAPHRAG_CACHE_DIR` |
| `NEUROGRAPHRAG_NAMESPACE` | `SQLITE_GRAPHRAG_NAMESPACE` |
| `NEUROGRAPHRAG_LANG` | `SQLITE_GRAPHRAG_LANG` |
| `NEUROGRAPHRAG_LOG_LEVEL` | `SQLITE_GRAPHRAG_LOG_LEVEL` |
| `NEUROGRAPHRAG_LOG_FORMAT` | `SQLITE_GRAPHRAG_LOG_FORMAT` |
| `NEUROGRAPHRAG_DISPLAY_TZ` | `SQLITE_GRAPHRAG_DISPLAY_TZ` |

### Step 4 — Decide how to handle the database path
- To keep using the legacy database file, point `SQLITE_GRAPHRAG_DB_PATH` to the old absolute path explicitly
- To start clean under the renamed defaults, do nothing and let `sqlite-graphrag` create `./graphrag.sqlite`
- Project-local `.neurographrag/config.toml` is no longer part of the default flow

### Step 5 — Verify the migrated setup
```bash
sqlite-graphrag health --json
sqlite-graphrag stats --json
sqlite-graphrag namespace-detect
```
- Confirm `schema_version` is valid and that the resolved namespace and database path are the expected ones

## Compatibility Notes
- There is no backward-compatibility alias for the old binary name in this repository copy
- Existing JSON contracts, exit codes, and operational semantics remain aligned with the legacy `v2.3.0` behavior
- The current public release under the new name is `sqlite-graphrag v1.0.2`

## Rollback
- Reinstall or restore the legacy `neurographrag` binary if you need to revert immediately
- Restore the old `NEUROGRAPHRAG_*` environment variables if needed
- If you changed paths, point the legacy binary back to the previous database file before retrying

## See Also
- `README.md` for the current installation path and pre-publication status
- `CHANGELOG.md` for legacy lineage and renamed release notes
- `docs/HOW_TO_USE.md` for current command examples