March 23, 2025
+ 12

Description — Installing Couchbase Lite on Swift

Get Started

To get started coding Couchbase Lite for Swift apps, just create or open an existing XCode project and install the required Couchbase Lite version, for example 3.2.2, using one of the Install Couchbase Lite methods shown.

Enterprise users can also download the Couchbase Lite Vector Search extension library.

Couchbase Lite is distributed as an XCFramework, to support this:

  • The minimum required CocoaPods version is 1.15

  • The minimum required Carthage version is 0.38

Install Couchbase Lite

.

  1. Download the binaries from here — Extend with Mobile.

  2. Unpack the download zip file into your XCode project location.

  3. Select your target settings in XCode and drag CouchbaseLiteSwift.xcframework from your Finder to the Frameworks, Libraries, and Embedded Content section.

  4. Start using Couchbase Lite on Swift in your project.

Install Vector Search Extension

The Vector Search extension is an Enterprise-only feature.

You can get set up with the Vector Search Extension for iOS (Swift) by following these instructions.

To use Vector Search, you must have Couchbase Lite installed and add the Vector Search extension to your Couchbase Lite application. There is no Carthage support for the beta release of Vector Search. Vector Search is available only for 64-bit architectures and Intel processors that support the Advanced Vector Extensions 2 (AVX2) instruction set. To verify whether your device supports the AVX2 instructions set, follow these instructions.

  1. Download the binaries from here — binary download link.

  2. Unpack the download zip file into your XCode project location.

  3. Select your target settings in XCode and drag CouchbaseLiteVectorSearch.xcframework from your Finder to the Frameworks, Libraries, and Embedded Content section.

  4. Start using Couchbase Lite Vector Search on Swift in your project.