System requirements
Install methods
pip (recommended)
From source
Optional extras
Dashboard (optional)
The web dashboard is a Next.js app infrontend/:
Getting Started
Installation
Install NeuralCleave on Linux, macOS, or Windows.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Install NeuralCleave on Linux, macOS, or Windows.
| Component | Minimum | Recommended |
|---|---|---|
| Python | 3.11 | 3.12 |
| RAM | 2 GB | 8 GB (16 GB for local voice) |
| Disk | 500 MB | 4 GB (models add more) |
| OS | Linux / macOS / Windows 10+ | Ubuntu 22.04 LTS |
| Node.js | 20 | 22 (for dashboard only) |
pip install neuralcleave
pip install "neuralcleave[all]"
git clone https://github.com/TheAmitChandra/NeuralCleave.git
cd NeuralCleave
pip install -e ".[all]"
| Extra | Installs |
|---|---|
voice | faster-whisper, pyaudio, openwakeword, kokoro |
embeddings | sentence-transformers, faiss-cpu |
channels | python-telegram-bot, discord.py, slack-sdk, etc. |
all | Everything above |
frontend/:
cd frontend
npm install
npm run dev # development
npm run build # production build
neuralcleave --version
# NeuralCleave 2.1.5
neuralcleave doctor
# Checking dependencies...
# ✓ Python 3.12.3
# ✓ Gateway dependencies
# ✓ Voice dependencies (faster-whisper, openwakeword)
# ✓ All checks passed
pip install --upgrade neuralcleave
neuralcleave migrate