squirix

Experimental distributed cache for .NET 10. Apps use the Squirix client SDK over HTTPS gRPC; server nodes own cache state, routing, durability, and ops endpoints. Replica groups favor consistency over availability (CP in CAP, PC/EC in PACELC); see consistency.

0.1.0-preview.9 — early preview, not production-ready. Release notes

NuGet packages

All packages are published under the squirix NuGet profile:

Package	Role
squirix	Client SDK — SquirixClient, ICache<T>, serialization
squirix.server	Server runtime — routing, durability, gRPC host
squirix.server.tool	Standalone squirix-server global tool

Quick start

dotnet add package squirix --version 0.1.0-preview.9
dotnet tool install -g squirix.server.tool --version 0.1.0-preview.9
squirix-server run

• NuGet package for the CLI: squirix.server.tool
• Command after install: squirix-server (run, init, doctor, validate-config, …)

Durable mode (journal + snapshots):

squirix-server run --persist --data-dir ./data

Client:

using System;
using System.Threading;
using Squirix.Client;

await using var client = await SquirixClient.ConnectAsync(new Uri("https://localhost:5001"), CancellationToken.None);
var cache = await client.GetCacheAsync<string>("demo", CancellationToken.None);
await cache.SetAsync("greeting", "hello", cancellationToken: CancellationToken.None);

Docker, JWT, and ASP.NET Core embedding: getting started.

Documentation

• Getting started · Client & server · Configuration
• Persistence · Clustering · Observability
• API · Architecture · Operations
• Operational runbook · Security (internode mTLS)
• Related projects

Contributing

Issues · contributing.md · [email protected]

SAST Tools

PVS-Studio - static code analyzer for Enterprise (C, C++, C#, Go, and Java) and Web (JS and TS) development.

License

Apache-2.0 — see LICENSE.