Skip to content

Installation

System Requirements

ComponentMinimumRecommended
CPU2 cores4+ cores
RAM2 GB8 GB
Disk1 GB20 GB SSD
OSLinux, macOS, Windows (WSL2)Ubuntu 22.04 LTS

Install via npm

npm install -g @nexusdb/cli@latest
nexusdb --version

Install via Docker

docker pull nexusdb/server:latest
docker run -d --name nexusdb \
  -p 4200:4200 \
  -v nexusdb-data:/data \
  nexusdb/server:latest

Install via Homebrew (macOS)

brew tap nexusdb/tap
brew install nexusdb

Verify Installation

nexusdb doctor

Expected output:

✓ Node.js 20.11.0
✓ NexusDB CLI 3.2.1
✓ Storage engine: ok
✓ Network: port 4200 available

Upgrading

From 2.x to 3.x

NexusDB 3.x includes breaking changes to the query API. Run the migration tool:

nexusdb migrate --from 2.x --dry-run
nexusdb migrate --from 2.x
Warning: Always backup your data before upgrading major versions. Use nexusdb backup create to create a snapshot.

Patch Updates

npm update -g @nexusdb/cli