Skip to main content

Configuration

Setup writes a config file for roots and indexing, plus a ready-to-paste MCP client block. Most installations only need to change roots or switch index backends. This branch also persists memory settings into config and generated MCP snippets.

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

  1. PROJECT_ROOTS
  2. LOCALNEST_CONFIG
  3. 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: keep sqlite-vec on Node 22+, otherwise use json.
  • LOCALNEST_SQLITE_VEC_EXTENSION: normally auto-written by setup for sqlite-vec; only override this if you are debugging a custom vec0 path.
  • LOCALNEST_MEMORY_ENABLED: set true only when you explicitly want local memory features.

Practical guidance

  • Use PROJECT_ROOTS when you want a temporary override in CI or a one-off shell session.
  • Use LOCALNEST_CONFIG when you need to point the server at a non-default config file.
  • Keep LOCALNEST_INDEX_BACKEND aligned 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 auto unless you are debugging backend selection.

Key environment variables

VariableDefaultDescription
LOCALNEST_INDEX_BACKENDsqlite-vecindex backend
LOCALNEST_DB_PATH~/.localnest/data/localnest.dbSQLite DB path
LOCALNEST_INDEX_PATH~/.localnest/data/localnest.index.jsonJSON index path
LOCALNEST_SQLITE_VEC_EXTENSIONsetup-managedvec0 shared library path for sqlite-vec native acceleration
LOCALNEST_VECTOR_CHUNK_LINES60chunk size
LOCALNEST_VECTOR_CHUNK_OVERLAP15chunk overlap
LOCALNEST_VECTOR_MAX_TERMS80max terms per chunk
LOCALNEST_VECTOR_MAX_FILES20000max files per index run
LOCALNEST_MEMORY_ENABLEDfalseenable local memory subsystem
LOCALNEST_MEMORY_BACKENDautomemory backend selection
LOCALNEST_MEMORY_DB_PATH~/.localnest/data/localnest.memory.dbSQLite memory DB path
LOCALNEST_MEMORY_AUTO_CAPTUREfalsebackground memory capture behavior
LOCALNEST_MEMORY_CONSENT_DONEfalsewhether setup already collected memory consent
LOCALNEST_UPDATE_PACKAGElocalnest-mcppackage checked for updates
LOCALNEST_UPDATE_CHECK_INTERVAL_MINUTES120update check cache interval
LOCALNEST_UPDATE_FAILURE_BACKOFF_MINUTES15retry backoff after failures

Config schema notes

  • Setup now writes config schema version: 3.
  • Existing configs and the older flat .localnest layout 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.0.5

This validates the installed binary and writes both markdown and JSON reports under reports/.