Get started with the Meilisearch integrations

⭐ Community Toolkit

Meilisearch is a fast, open-source search engine that makes search and discovery easy. The Aspire Meilisearch integration enables you to connect to existing Meilisearch instances or create new instances from Aspire using the docker.io/getmeili/meilisearch container image.

In this introduction, you’ll see how to install and use the Aspire Meilisearch integrations in a simple configuration. If you already have this knowledge, see Meilisearch hosting integration for full reference details.

Nota

To follow this guide, you must have created an Aspire solution to work with. To learn how to do that, see Build your first Aspire app.

Set up hosting integration

To begin, install the Aspire Meilisearch Hosting integration in your Aspire AppHost project:

Aspire CLI

Aspire CLI — Añadir paquete CommunityToolkit.Aspire.Hosting.Meilisearch

aspire add communitytoolkit-meilisearch

La CLI de Aspire es interactiva; asegúrate de seleccionar el resultado adecuado cuando se te pida:

Aspire CLI — Ejemplo de salida

Select an integration to add:

> communitytoolkit-meilisearch (CommunityToolkit.Aspire.Hosting.Meilisearch)
> Other results listed as selectable options...

Nota

Si solo hay un resultado, la CLI lo selecciona automáticamente. Aún tendrás que confirmar la versión.

apphost.cs (C# file-based app)

C# — AppHost.cs

#:package CommunityToolkit.Aspire.Hosting.Meilisearch@*

PackageReference (*.csproj)

XML — Añadir referencia de paquete CommunityToolkit.Aspire.Hosting.Meilisearch

<PackageReference Include="CommunityToolkit.Aspire.Hosting.Meilisearch" Version="*" />

Next, in the AppHost project, register and consume the Meilisearch integration using the AddMeilisearch extension method to add the Meilisearch container to the application builder:

C# — AppHost.cs

var builder = DistributedApplication.CreateBuilder(args);

var meilisearch = builder.AddMeilisearch("meilisearch");

builder.AddProject<Projects.ExampleProject>()
       .WithReference(meilisearch);

// After adding all resources, run the app...

Set up client integration

To get started with the Aspire Meilisearch client integration, install the NuGet package in the client-consuming project:

.NET CLI

.NET CLI — Add CommunityToolkit.Aspire.Meilisearch package

dotnet add package CommunityToolkit.Aspire.Meilisearch

Program.cs (C# file-based app)

Program.cs

#:package CommunityToolkit.Aspire.Meilisearch@*

PackageReference (*.csproj)

XML — Add CommunityToolkit.Aspire.Meilisearch package reference

<PackageReference Include="CommunityToolkit.Aspire.Meilisearch" Version="*" />

In the Program.cs file of your client-consuming project, call the AddMeilisearchClient extension method to register a MeilisearchClient for use via the dependency injection container:

builder.AddMeilisearchClient(connectionName: "meilisearch");

You can then retrieve the MeilisearchClient instance using dependency injection. For example, to retrieve the client from a service:

public class ExampleService(MeilisearchClient client)
{
    // Use client...
}

For full reference details, see Meilisearch hosting integration and Meilisearch client integration.

See also

• Meilisearch
• Meilisearch Client
• Aspire Community Toolkit GitHub repo