Configuration
Setup writes a config file for roots and indexing, plus a ready-to-paste MCP client block. As of
0.1.0, setup also auto-detects and installs skills for 13 AI clients
(Claude, Cursor, Windsurf, Copilot, Gemini, Kiro, Codex, Cline, Continue, OpenCode, and more).
Run localnest mcp config to generate client-specific config blocks.
Files written by setup
~/.localnest/config/localnest.config.json
Stores configured roots, indexing preferences, and memory settings such as consent and memory DB path.
~/.localnest/config/mcp.localnest.json
Contains the generated mcpServers.localnest block for your MCP client configuration.
~/.localnest/data/*
Holds the SQLite index, JSON fallback index, and local memory database.
Config priority
PROJECT_ROOTSLOCALNEST_CONFIG- current working directory fallback
Most common changes
Most teams only adjust these values:
PROJECT_ROOTS: set one or more explicit root paths.LOCALNEST_INDEX_BACKEND: keepsqlite-vecon Node 22+, otherwise usejson.LOCALNEST_SQLITE_VEC_EXTENSION: normally auto-written by setup forsqlite-vec; only override this if you are debugging a custom vec0 path.LOCALNEST_MEMORY_ENABLED: settrueonly when you explicitly want local memory features.
Practical guidance
- Use
PROJECT_ROOTSwhen you want a temporary override in CI or a one-off shell session. - Use
LOCALNEST_CONFIGwhen you need to point the server at a non-default config file. - Keep
LOCALNEST_INDEX_BACKENDaligned with the Node runtime available to your MCP client. - If you use
sqlite-vec, rerun setup instead of hand-editing vec0 paths unless you have a custom native build. - Leave memory backend on
autounless you are debugging backend selection.
Key environment variables
| Variable | Default | Description |
|---|---|---|
LOCALNEST_INDEX_BACKEND | sqlite-vec | index backend |
LOCALNEST_DB_PATH | ~/.localnest/data/localnest.db | SQLite DB path |
LOCALNEST_INDEX_PATH | ~/.localnest/data/localnest.index.json | JSON index path |
LOCALNEST_SQLITE_VEC_EXTENSION | setup-managed | vec0 shared library path for sqlite-vec native acceleration |
LOCALNEST_VECTOR_CHUNK_LINES | 60 | chunk size |
LOCALNEST_VECTOR_CHUNK_OVERLAP | 15 | chunk overlap |
LOCALNEST_VECTOR_MAX_TERMS | 80 | max terms per chunk |
LOCALNEST_VECTOR_MAX_FILES | 20000 | max files per index run |
LOCALNEST_MEMORY_ENABLED | false | enable local memory subsystem |
LOCALNEST_MEMORY_BACKEND | auto | memory backend selection |
LOCALNEST_MEMORY_DB_PATH | ~/.localnest/data/localnest.memory.db | SQLite memory DB path |
LOCALNEST_MEMORY_AUTO_CAPTURE | false | background memory capture behavior |
LOCALNEST_MEMORY_CONSENT_DONE | false | whether setup already collected memory consent |
LOCALNEST_UPDATE_PACKAGE | localnest-mcp | package checked for updates |
LOCALNEST_UPDATE_CHECK_INTERVAL_MINUTES | 120 | update check cache interval |
LOCALNEST_UPDATE_FAILURE_BACKOFF_MINUTES | 15 | retry backoff after failures |
Config schema notes
- Setup now writes config schema
version: 3. - Existing configs and the older flat
.localnestlayout are auto-migrated on startup, with timestamped backups stored under~/.localnest/backups/. - Memory remains disabled unless the user opted in during setup or explicitly enables it via environment variables.
Release validation
For release verification, prefer the installed-runtime harness over ad hoc manual checks:
node scripts/release/release-test-installed-runtime.mjs --version-label 0.1.0
This validates the installed binary and writes both markdown and JSON reports under reports/.