MVFC.Aspire.Helpers.Redis 6.4.0

.NET 9.0 This package targets .NET 9.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package MVFC.Aspire.Helpers.Redis --version 6.4.0
                    


                    

                
NuGet\Install-Package MVFC.Aspire.Helpers.Redis -Version 6.4.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="MVFC.Aspire.Helpers.Redis" Version="6.4.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="MVFC.Aspire.Helpers.Redis" Version="6.4.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="MVFC.Aspire.Helpers.Redis" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add MVFC.Aspire.Helpers.Redis --version 6.4.0
                    


                    

                
#r "nuget: MVFC.Aspire.Helpers.Redis, 6.4.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package MVFC.Aspire.Helpers.Redis@6.4.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=MVFC.Aspire.Helpers.Redis&version=6.4.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=MVFC.Aspire.Helpers.Redis&version=6.4.0
                    


                            Install as a Cake Tool

MVFC.Aspire.Helpers.Redis

🇧🇷 Leia em Português

Helper for integrating with Redis in .NET Aspire projects, including distributed caching and Redis Commander UI.

Overview

This project provides extension methods to facilitate integration with Redis in .NET Aspire projects, including distributed caching and Redis Commander UI.

Project Structure

Features

  • Adds a configured Redis container.
  • Support for Redis Commander UI.
  • Support for data persistence via Docker volume (AOF enabled).
  • Support for password.

Compatible Images:

  • redis
  • rediscommander/redis-commander (UI)

Installation

dotnet add package MVFC.Aspire.Helpers.Redis

Usage Example in AppHost

var builder = DistributedApplication.CreateBuilder(args);

var redis = builder.AddRedis("redis")
    .WithPassword("my-password")
    .WithCommander()
    .WithDataVolume("redis-data");

builder.AddProject<Projects.MVFC_Aspire_Helpers_Playground_Api>("api-example")
       .WithReference(redis)
       .WaitFor(redis);

await builder.Build().RunAsync();

Fluent Methods

Method Description
WithDockerImage(image, tag) Overrides the Docker image used.
WithPassword(password) Defines the Redis password.
WithCommander(port?) Adds the Redis Commander UI.
WithDataVolume(volumeName) Enables persistence with Docker volume (AOF).

Main Parameters for AddRedis

  • name: Redis resource name.
  • port (Optional): Redis Port (default: 6379).

Other important Optional parameters:

  • connectionStringSection (Optional): Defines the path to the environment variable or configuration containing the Redis connection string. Default is "ConnectionStrings:redis". Each : indicates a level/section within the appsettings.json file:
{
  "ConnectionStrings": {
    "redis": "localhost:6379"
  }
}

Port Details

  • Redis Port: defined via port parameter (default: 6379).
  • Redis Commander Port: random by default; can be defined via commanderPort parameter in WithCommander.

Requirements

  • .NET 9+
  • Aspire.Hosting >= 9.5.0

License

Apache-2.0

Product Compatible and additional computed target framework versions.
.NET net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
9.0.3 102 4/12/2026
9.0.2 96 4/12/2026
9.0.1 100 4/12/2026
9.0.0 101 4/12/2026
8.0.2 97 4/11/2026
8.0.1 109 4/3/2026
8.0.0 98 4/2/2026
7.3.3 101 3/31/2026
7.3.2 106 3/30/2026
7.3.1 98 3/30/2026
7.3.0 105 3/30/2026
7.2.2 100 3/29/2026
7.2.1 99 3/29/2026
7.2.0 100 3/29/2026
7.1.0 95 3/22/2026
6.4.4 96 3/21/2026
6.4.3 103 3/15/2026
6.4.2 99 3/15/2026
6.4.1 142 3/10/2026
6.4.0 96 3/9/2026
Loading failed