Skip to content

Installation

Prerequisites

  • Python 3.11 or higher
  • pip or uv package manager

uv is a fast Python package installer and resolver.

# Install uv if you haven't already
curl -LsSf https://astral.sh/uv/install.sh | sh

# Clone the repository
git clone https://github.com/nexi-lab/nexus.git
cd nexus

# Create virtual environment and install dependencies
uv venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
uv pip install -e ".[dev]"

Using pip

# Clone the repository
git clone https://github.com/nexi-lab/nexus.git
cd nexus

# Create virtual environment
python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

# Install package
pip install -e ".[dev]"

Verify Installation

# Check nexus CLI
nexus --version

# Run tests to verify everything works
pytest

Docker Installation

# Pull the latest image
docker pull nexus/nexus:latest

# Run in embedded mode
docker run -it --rm nexus/nexus:latest

Next Steps