-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy path.env.example
More file actions
45 lines (41 loc) · 3.07 KB
/
Copy path.env.example
File metadata and controls
45 lines (41 loc) · 3.07 KB
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
# Neuron — environment template
# Copy to ".env" (gitignored) and fill in. The server auto-loads a ".env" at
# startup (searching up from its working directory), so the values below are
# picked up automatically — `scripts/connect_turso.py` writes the two Turso keys
# here for you. A real environment variable always wins over the file, so a
# client `env` block still takes priority.
# - point at a specific file: set NEURON_ENV_FILE=/path/to/.env
# - disable auto-loading: set NEURON_NO_DOTENV=1
# (Auto-loading is always skipped under pytest so tests never hit the live cloud.)
#
# ─────────────────────────────────────────────────────────────────────────────
# Turso CLOUD (optional) — tier 1 of the DB layer (see src/neuron/db.py)
# ─────────────────────────────────────────────────────────────────────────────
# When BOTH of the following are set and non-empty, neuron.db switches the main
# graph store to a real Turso cloud database (libsql-client over HTTP), so memory
# survives across machines/sessions. vector_distance_cos() runs server-side.
#
# ⚠️ Prerequisite: install the cloud extra FIRST, otherwise importing the server
# will fail at startup (db.py imports libsql_client when these vars are set):
# pip install -e .[cloud] # or: pip install "neuron[cloud]"
#
# Easiest setup (recommended): let the onboarding tool prompt for the URL/token,
# TEST the connection for real (read + write probe), and fill in the two lines
# below only if it succeeds — the token is never printed:
# python scripts/connect_turso.py
# Offline sanity check (never connects): python scripts/check_cloud_config.py
#
TURSO_DATABASE_URL=libsql://your-db-name-your-org.turso.io
TURSO_AUTH_TOKEN=your-turso-auth-token
# If these are left empty/unset, Neuron falls back automatically to:
# - local pyturso engine (tier 2) if pyturso is installed (default), else
# - stdlib sqlite3 (tier 3, no native vector search).
# ─────────────────────────────────────────────────────────────────────────────
# Local tuning (optional)
# ─────────────────────────────────────────────────────────────────────────────
# Directory for per-context graph .db files. Default is a stable per-user dir so
# memory persists across restarts and survives reinstalls:
# Windows : %LOCALAPPDATA%\neuron\graphs
# Linux/mac : $XDG_DATA_HOME/neuron/graphs (or ~/.local/share/neuron/graphs)
# Set this to override (e.g. to a repo-local ./graphs, or a shared folder).
# NS_GRAPHS_DIR=/absolute/path/to/graphs