Installation

This page shows you how to install the .NET client for Elasticsearch.

For SDK style projects, you can install the Elasticsearch client by running the following .NET CLI command in your terminal:

dotnet add package Elastic.Clients.Elasticsearch

This command adds a package reference to your project (csproj) file for the latest stable version of the client.

If you prefer, you may also manually add a package reference inside your project file:

<PackageReference Include="Elastic.Clients.Elasticsearch" Version="{latest-version}" />

NOTE: The version number should reflect the latest published version from NuGet.org. To install a different version, modify the version as necessary.

For Visual Studio users, the .NET client can also be installed from the Package Manager Console inside Visual Studio using the following command:

Install-Package Elastic.Clients.Elasticsearch

Alternatively, search for Elastic.Clients.Elasticsearch in the NuGet Package Manager UI.

To learn how to connect the Elasticsearch client, refer to the Connecting section.

The Elasticsearch client is compatible with currently maintained .NET runtime versions. Compatibility with End of Life (EOL) .NET runtimes is not guaranteed or supported.

Language clients are forward compatible:

Given a constant major version of the client, each related minor version is compatible with its equivalent- and all later Elasticsearch minor versions of the same or next higher major version.

For example:

Language clients are also backward compatible across minor versions within the same major version (without strong guarantees), but never backward compatible with earlier Elasticsearch major versions.

Refer to the end-of-life policy for more information.