Skip to content

Getting Started Installation

github-actions[bot] edited this page May 31, 2026 · 1 revision

Installation

System Requirements

Requirement Minimum
JDK 25+ (OpenJDK with Vector API)
Maven 3.9+
RAM 512 MB (scales with dataset)
Disk 100 MB + index data

Building from Source

git clone https://github.com/spectrayan/spector.git
cd spector
mvn clean install -DskipTests

Running with JVM Flags

Spector uses incubator modules. The required JVM flags are configured in pom.xml, but if running manually:

java --add-modules jdk.incubator.vector \
     --enable-native-access=ALL-UNNAMED \
     -jar spector-node/target/spector-node.jar

Server Configuration

Start with custom port, dimensions, and API key:

mvn exec:java -pl spector-node \
  -Dexec.mainClass="com.spectrayan.spector.server.SpectorNode" \
  -Dexec.args="7070 384 my-secret-key"

Arguments: <port> <dimensions> [api-key]

GPU Support

GPU acceleration requires:

  • NVIDIA GPU with CUDA support

  • CUDA toolkit installed

  • Set gpuEnabled=true in configuration

The system falls back to CPU SIMD automatically when GPU is unavailable.

Embedding Provider

Spector ships with an Ollama embedding provider. To enable auto-embedding:

  1. Install Ollama
  2. Pull an embedding model: ollama pull nomic-embed-text
  3. Configure the embedding endpoint in your application

🏠 Home


Clone this wiki locally