-
-
Notifications
You must be signed in to change notification settings - Fork 0
Getting Started Installation
github-actions[bot] edited this page May 31, 2026
·
1 revision
| Requirement | Minimum |
|---|---|
| JDK | 25+ (OpenJDK with Vector API) |
| Maven | 3.9+ |
| RAM | 512 MB (scales with dataset) |
| Disk | 100 MB + index data |
git clone https://github.com/spectrayan/spector.git
cd spector
mvn clean install -DskipTestsSpector 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.jarStart 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 acceleration requires:
-
NVIDIA GPU with CUDA support
-
CUDA toolkit installed
-
Set
gpuEnabled=truein configuration
The system falls back to CPU SIMD automatically when GPU is unavailable.
Spector ships with an Ollama embedding provider. To enable auto-embedding:
- Install Ollama
- Pull an embedding model:
ollama pull nomic-embed-text - Configure the embedding endpoint in your application
- Home
- About
- Getting Started
-
Architecture
- Architecture--Overview
- Architecture--Core-Concepts
- Architecture--Mcp-Integration
- Architecture--Ingestion-Pipeline
- Architecture--Rag-Pipeline
- Architecture--Distributed-Mode
- Architecture--Gpu-Acceleration
-
Modules
- Modules
- Modules--Spector-Core
- Modules--Spector-Commons
- Modules--Spector-Config
- Modules--Spector-Storage
- Modules--Spector-Embed-Api
- Modules--Spector-Embed-Ollama
- Modules--Spector-Index
- Modules--Spector-Query
- Modules--Spector-Gpu
- Modules--Spector-Rag
- Modules--Spector-Engine
- Modules--Spector-Ingestion
- Modules--Spector-Memory
- Modules--Spector-Runtime
- Modules--Spector-Node
- Modules--Spector-Mcp
- Modules--Spector-Cli
- Modules--Spector-Client
- Modules--Spector-Spring
- Modules--Spector-Metrics
- Modules--Spector-Bench
- Modules--Spector-Dist
- Modules--Spector-Cortex
-
Deep Dives
- Deep-Dives--Ann-Search-Primer
- Deep-Dives--Hnsw-Explained
- Deep-Dives--Spector-Index-Architecture
- Deep-Dives--Svasq-Deep-Dive
- Deep-Dives--Understanding-Quantization
- Deep-Dives--Quantization-Comparison
- Deep-Dives--Turbo-Quant
- Deep-Dives--Real-Embedding-Benchmarks
- Deep-Dives--Svasq-Spectorindex-Whitepaper
-
🧠 Cognitive Memory
- Memory
- Memory--Getting-Started
- Architecture
- Biological Systems
- Advanced Profiles
- Deep Dives
- Memory--Api-Reference
- 🧬 Cortex Dashboard
- Reference
- Operations
- FAQ
- Roadmap
- 🔬 Labs