Getting Started

🚀 Getting Started with VortexKV

VortexKV can be installed and running in under 30 seconds via multiple deployment methods.

---

⚡ 1. One-Line Universal Installer (macOS & Linux)

curl -fsSL https://raw.githubusercontent.com/GargAnshu9468/vortexkv/main/install.sh | bash

---

🐳 2. Docker & Docker Compose

Launch single container:

docker run -d -p 7379:7379 -p 7380:7380 \
  -e VORTEX_REQUIREPASS="vortex_secure_2026" \
  ianshugarg/vortexkv:latest

Launch complete cluster with Prometheus & Grafana stack:

git clone https://github.com/GargAnshu9468/vortexkv.git
cd vortexkv
docker compose --profile monitoring up -d

---

🔨 3. Build from Source

Requirements: Go 1.22+

git clone https://github.com/GargAnshu9468/vortexkv.git
cd vortexkv
make build

Binaries generated in bin/:

• bin/vortex-server: Server daemon & embedded visual deck
• bin/vortex-cli: Interactive CLI client
• bin/vortex-operator: Kubernetes operator controller

---

🔌 Connecting via Redis CLI

redis-cli -p 7379 -a "vortex_secure_2026" PING
# PONG

redis-cli -p 7379 -a "vortex_secure_2026" SET mykey "CyberVortex"
redis-cli -p 7379 -a "vortex_secure_2026" GET mykey
# "CyberVortex"

🌌 Connecting via Web Studio

Open your browser at: 👉 http://localhost:7380

---

🏎️ Running Benchmarks

VortexKV delivers 6,870,000+ ops/sec pipelined throughput (world record) and 210,000+ ops/sec direct concurrency with 111µs p50 latency.

Run the official benchmark script:

./scripts/run_world_record_benchmark.sh

Or benchmark manually with redis-benchmark:

# 1. Direct Concurrency (50 concurrent clients, no pipelining)
redis-benchmark -p 7379 -a "vortex_secure_2026" -c 50 -n 100000 -t get,set -q

# 2. Pipelined Velocity (P=64 Multi-Reactor, 100 clients)
redis-benchmark -p 7379 -a "vortex_secure_2026" -c 100 -n 2000000 -P 64 -t ping,get -q