Skip to main content

ValKeyper Documentation

Build fast, scalable applications with an in-memory key-value store that replicates Redis core features — persistence, replication, streams, and transactions.

Get StartedExplore Commands

Quick Start

Get ValKeyper up and running in minutes with these simple steps

1

Clone the repository

Download ValKeyper from GitHub to get started.
git clone https://github.com/koul1sh/valkeyper.git
cd valkeyper
2

Build the project

Compile ValKeyper using Go’s build tools.
go build
This creates the valkeyper executable in your current directory.
3

Start the server

Launch ValKeyper on the default port (6379).
./valkeyper
You can customize the port with --port flag:
./valkeyper --port 6380
4

Connect and test

Use redis-cli to connect and run your first commands.
redis-cli -p 6379
Try these commands:
PING
SET greeting "Hello, World!"
GET greeting

127.0.0.1:6379> PING
PONG
127.0.0.1:6379> SET greeting "Hello, World!"
OK
127.0.0.1:6379> GET greeting
"Hello, World!"

Explore by Topic

Deep dive into ValKeyper’s features and capabilities

Core Concepts

Understand ValKeyper’s architecture, RESP protocol, and data model.

Commands

Explore the full command set for strings, keys, streams, and transactions.

Replication

Set up master-slave replication for high availability.

Persistence

Learn about RDB file format and data durability.

Streams

Build event-driven applications with real-time data flows.

Transactions

Ensure atomicity with MULTI/EXEC transaction blocks.

Key Features

Everything you need to build scalable, high-performance applications

Redis Compatible

Works seamlessly with redis-cli and supports core Redis commands for easy integration.

RDB Persistence

Load data from RDB files for durability across server restarts.

Master-Slave Replication

Scale reads and ensure high availability with built-in replication support.

Key Expiration

Set time-to-live (TTL) on keys with automatic expiration handling.

Event Streams

Build real-time applications with XADD, XREAD, and XRANGE stream commands.

ACID Transactions

Ensure data consistency with MULTI/EXEC transaction blocks.

Ready to get started?

Jump into the quickstart guide and have ValKeyper running in under 5 minutes.

Start Building Now