Skip to main content

Getting started

Connect to a local RESP server and send typed commands in a few lines.

Prerequisites​

  • .NET 10 SDK or later (Respire targets both net8.0 and net10.0)
  • Redis, Valkey, KeyDB, or another RESP2-compatible server

Install Respire​

Respire is available on NuGet. It is still pre-release, so its public APIs may change. Install the package with prerelease versions included:

dotnet add package Respire --prerelease

Start a server​

See Packages and namespaces for optional Redis features, .NET integrations, and the naming convention.

If you do not have a server running locally, Docker is the quickest option:

docker run --name respire-redis --rm -p 6379:6379 redis:7-alpine

Connect and write a value​

using Respire;

await using var redis = await RespireClient.ConnectAsync("redis://localhost");

await redis.SetAsync(
    "session:42",
    "active",
    expiry: TimeSpan.FromMinutes(30));

string? state = await redis.GetStringAsync("session:42");
Console.WriteLine(state);

ConnectAsync connects immediately and fails fast when the endpoint is unavailable. The client is IAsyncDisposable; use await using or dispose it during application shutdown.

Store a typed object​

The default serializer uses System.Text.Json:

public sealed record User(string Name, int LoginCount);

await redis.SetAsync("user:ada", new User("Ada", 7));
User? user = await redis.GetAsync<User>("user:ada");

Typed strings, byte arrays, numeric primitives, and Boolean values bypass the object serializer. Other values use the configured serializer. See values and serialization.

Explore commands by data type​

await redis.Hashes.SetAsync("user:ada", "role", "admin");
string? role = await redis.Hashes.GetStringAsync("user:ada", "role");

await redis.Sets.AddAsync("online", "ada", "grace");
bool online = await redis.Sets.ContainsAsync("online", "ada");

Root shortcuts cover frequent operations. Facets—Strings, Keys, Hashes, Lists, Sets, SortedSets, Streams, Scripts, Functions, and Server—keep IntelliSense focused.

Connection URI​

The common form is:

redis://[username:password@]host[:port][/database]

For connection timeouts, protocol selection, serialization, or logging, use RespireOptions.

Next​