Full Installation

  • how-to
    Installation instructions for the Couchbase .NET Client.

    This page covers installation of the SDK. A quick start guide in our Getting Started Guide should work for most users — and for anyone in a hurry to try out the SDK and our Hello World program, that page is usually the best place to get started — but more detailed installation instructions are provided here on this page for every supported platform. This guide assumes you have some familiarity with development using .NET — if you are evaluating the SDK as a software architect, tester, or other non-.NET role, you will benefit from our Platform Help page.

    .NET Compatibility

    The Couchbase .NET SDK is compatible with .NET Standard 2.0 and .NET Standard 2.1, via the currently supported Microsoft .NET SDKs. Currently, that includes .NET 6.0 and later for .NET Standard 2.1 and .NET Framework 4.6.2 and later for .NET Standard 2.0. The .NET Standard documentation and .NET Standard version chart may be useful to help understand other available options.

    Couchbase strongly recommends using the latest LTS version of .NET that’s officially supported by both Microsoft and Couchbase. Other .NET implementations may work, but aren’t tested, and are outside the scope of technical support. See the Compatibility section for more details.

    The library is distributed in a number of ways:


    NuGet package host at nuget.org (recommended)


    Zip files for each release are linked from the Release Notes here.

    Build from Source

    Build the library from source available on GitHub (not officially supported)


    Quick Installation Using NuGet

    For every release, we currently package the binaries and store the latest version in NuGet. If you are not familiar with NuGet, it’s the official and most widely supported package manager for Microsoft Visual Studio and .NET in general.

    NuGet from Visual Studio

    Using Visual Studio 2013 or later, follow these steps to get started with the Couchbase .NET SDK:

    1. From the IDE, right-click the project you want to add the dependency to.

    2. In the context menu, click Manage NuGet Packages. The NuGet package manager modal dialog opens.

    3. From the Tree View menu on the left, select Online > nuget.org.

    4. In the search box at the top right-hand side of the dialog, type CouchbaseNetClient and then press enter on your keyboard.

    5. In the search results, select the CouchbaseNetClient package and then click Install.

    NuGet from the Package Manager Console

    From the Package Manager Console within your project:

    1. From the Visual Studio menu bar, click Tools.

    2. Select NuGet Package Manager > Package Manager Console.

    3. In the console, enter the package installation command:

      • To install the latest version:

     Install-Package CouchbaseNetClient
    • To install a specific version, include the version parameter. For example:

     Install-Package CouchbaseNetClient -Version 3.2.3

    Downloading and referencing the binaries

    If you do not want to use NuGet to include the Couchbase .NET SDK in your project, you can download and reference the binaries directly. If you chose this route, you’ll also be responsible for including and resolving dependencies used internally by the SDK.

    To download and reference the binaries directly:

    1. Download the version of the SDK you want to install.

    2. In Visual Studio, right-click the project you want to include the SDK in and then click Add.

    3. Click Reference to open the Reference Manager.

    4. On the left side, click Browse and select the binaries you downloaded.

    5. Click OK.

    After you have referenced the Couchbase .NET SDK binaries, you need to locate and reference the dependencies it uses in a similar fashion. At the time of this writing, the dependencies are:

    Other versions might not be compatible with the current SDK version.

    Building from source

    If none of the other installation options suffice or if you want to debug the source or perhaps contribute, building directly from the source is the best option for you. All source is located on GitHub.

    The software provided via NuGet and S3 are the official releases that have been through a rigorous testing process. Code on GitHub that is not tagged as an official release is still in development.

    To build the .NET SDK from source:

    1. (Optional) Fork the GitHub repository: https://github.com/couchbase/couchbase-net-client/fork

    2. Using a Git console, enter the command to clone the repository:

    git clone https://github.com/couchbase/couchbase-net-client.git
    1. Enter the command to retrieve the latest code from GitHub:

    git pull origin master
    1. Navigate to the directory that the source was cloned to and open the solution.

    2. Build the solution.

    After you have successfully built the source, it’s then just a matter of referencing the binaries (.DLL files) from your consuming project. Note that you can checkout a specific tag for each release as well.