Installation

Requirements

• Python 3.11 or higher
• pip or pipx

Basic Installation

Install NeuralMemory from PyPI:

pip install neural-memory

This installs the core library with CLI support.

Optional Dependencies

NeuralMemory has optional features you can install as needed:

Server (FastAPI + Web UI)

pip install neural-memory[server]

Includes:

• FastAPI REST API
• Interactive Web UI for brain visualization
• WebSocket sync support

Vietnamese NLP

pip install neural-memory[nlp-vi]

Includes:

• underthesea - Vietnamese NLP toolkit
• pyvi - Vietnamese word segmentation

English NLP

pip install neural-memory[nlp-en]

Includes:

• spaCy - Industrial NLP
• en_core_web_sm model

Neo4j Storage

pip install neural-memory[neo4j]

For production deployments with Neo4j graph database.

All Features

pip install neural-memory[all]

Installs everything above.

Development Installation

For contributing or local development:

git clone https://github.com/nhadaututtheky/neural-memory
cd neural-memory
pip install -e ".[dev]"
pre-commit install

Verify Installation

# Check CLI
nmem --version

# Check help
nmem --help

# Check brain status
nmem brain list

Environment Variables

Variable	Description	Default
NEURAL_MEMORY_DIR	Data directory	~/.neural-memory
NEURAL_MEMORY_BRAIN	Default brain name	default
NEURAL_MEMORY_JSON	Always output JSON	false

Troubleshooting

Command not found

If nmem is not found after installation:

# Check if scripts are in PATH
python -m neural_memory.cli --help

# Or use pipx for isolated install
pipx install neural-memory

Permission errors on Windows

Run terminal as Administrator or install with --user:

pip install --user neural-memory

Missing dependencies

If optional features fail:

# Reinstall with all dependencies
pip install --force-reinstall neural-memory[all]