SharpKV 1.0.0

SharpKV

SharpKV is a Redis-like key-value store for .NET. It supports an embedded in-memory API and a TCP server that speaks RESP for the commands listed below.

Highlights

• RESP-compatible protocol for the supported command set
• Use as an embedded library or run as a standalone server
• Append-only file (AOF) persistence
• TTL-based expiration
• Thread-safe operations
• Dockerfile included for container builds

Usage Modes

SharpKV can be used in two ways:

• Library (embedded): reference SharpKV and use KeyValueStore and extension helpers directly in your .NET process.
• Standalone server: run SharpKV.Server and connect via RESP (e.g., redis-cli or KVClient).

Examples

See examples/README.md for runnable samples and scripts.

• examples/SharpKV.Example.Embedded (embedded store usage)
• examples/SharpKV.Example.Client (client against a running server)
• examples/redis-tools (redis-cli and redis-benchmark helpers)

Quick Start

Prerequisites

• .NET 8 SDK

Install from NuGet

dotnet add package SharpKV

Build

git clone https://github.com/0xConstant1/SharpKV
cd SharpKV
dotnet build

Run the server

# Default (127.0.0.1:6379)
dotnet run --project src/SharpKV.Server

# Custom port with AOF persistence
dotnet run --project src/SharpKV.Server -- --port 7000 --aof data/store.aof

# Show all options
dotnet run --project src/SharpKV.Server -- --help

Test with redis-cli

redis-cli -p 6379

127.0.0.1:6379> SET greeting "Hello, SharpKV!"
OK
127.0.0.1:6379> GET greeting
"Hello, SharpKV!"
127.0.0.1:6379> INCR counter
(integer) 1
127.0.0.1:6379> SET session "abc123" EX 3600
OK
127.0.0.1:6379> TTL session
(integer) 3599

Library Usage

Use KeyValueStore directly for an embedded in-memory store:

using SharpKV;

using var store = new KeyValueStore();

store.Set("user:1:name", "Alice");
string? name = store.GetString("user:1:name");

store.Set("session:abc", "token123", TimeSpan.FromMinutes(30));
long ttl = store.TTL("session:abc");

store.Set("views", 0);
long count = store.Incr("views");

You can also store .NET objects as JSON via KeyValueStoreExtensions:

using SharpKV;

public record User(string Id, string Name, int Age);

using var store = new KeyValueStore();

var user = new User("u-123", "Alice", 32);
store.Set("user:u-123", user);

User? loaded = store.Get<User>("user:u-123");
Console.WriteLine(loaded?.Name);

For more helpers, see KeyValueStoreExtensions and the examples folder.

Server Mode

Command line options (see src/SharpKV.Server/Program.cs):

Usage:
  dotnet run --project src/SharpKV.Server -- [options]

Options:
  --host <address>        Bind address (default: 127.0.0.1)
  --port <number>         Port number (default: 6379)
  --max-connections <n>   Max concurrent connections (default: 1000)
  --aof <path>            Enable AOF persistence to file
  --client                Run client demo
  --help                  Show help

Docker

A Dockerfile is included at the repo root:

# Build and run
docker build -t sharpkv .
docker run -d -p 6379:6379 -v ./data:/app/data --name sharpkv sharpkv --aof /app/data/store.aof

Supported Commands

Development

Run tests

dotnet test

Run benchmarks

dotnet run --project SharpKV.Benchmarks -c Release

Project Structure

SharpKV/
|-- SharpKV.slnx
|-- src/
|   |-- SharpKV/                 # Core library
|   |-- SharpKV.Server/          # Standalone server
|-- SharpKV.Tests/               # Unit tests
|-- SharpKV.Benchmarks/          # Benchmarks
|-- examples/                    # Example apps and scripts

License

GPL-2.0-only License. See LICENSE.