Skip to main content

Windows Installation

To install the Ionic Couchbase Lite integration into Capacitor Windows, first follow the Installation guide to install the @ionic-enterprise/couchbase-lite package.

Note: this plugin requires @ionic-enterprise/capacitor-windows 1.5.0 or greater.

Then, run:

npx cap sync @ionic-enterprise/capacitor-windows

Follow the guide below that is most relevant to your app (packaged or unpackaged):

Packaged Apps (using Windows App SDK)#

When using Ionic Couchbase Lite in a packaged app context,

Open in Visual Studio#

Open your project in visual studio by running

npx cap open @ionic-enterprise/capacitor-windows

This will attempt to automatically locate your Visual Studio 2022 or 2019 installation, in that order. If your installation is in a non-standard location, set the CAPACITOR_VISUAL_STUDIO_PATH environment variable to the location of devenv.exe for your Visual Studio install, and then re-run the above command.

Install the Plugin in Visual Studio#

Open the Package Manager Console:

Package Manager Console

Then run:

Install-Package IonicCouchbaseLite -ProjectName AppInstall-Package Couchbase.Lite.Enterprise -Version 2.8.6 -ProjectName App

Unpackaged Apps (using WPF):#

When using Ionic Couchbase Lite in an unpackaged (standard .exe/win32) context, use the following instructions to install the plugin.

Note: this requires @ionic-enterprise/couchbase-lite 2.5.5 or greater.

Open in Visual Studio#

Open your project in visual studio by running

npx cap open @ionic-enterprise/capacitor-windows

This will attempt to automatically locate your Visual Studio 2022 or 2019 installation, in that order. If your installation is in a non-standard location, set the CAPACITOR_VISUAL_STUDIO_PATH environment variable to the location of devenv.exe for your Visual Studio install, and then re-run the above command.

Install the Plugin in Visual Studio#

Open the Package Manager Console and install the package:

Package Manager Console

Then, enter into the console the following (note the .WPF package name):

Install-Package IonicCouchbaseLite.WPF -ProjectName AppInstall-Package Couchbase.Lite.Enterprise -Version 2.8.6 -ProjectName App

Installation Complete#

The plugin should now be installed in your project. Rerun the above commands to update the package in the future.