A newer version of this documentation is available.

View Latest

Installation - Couchbase Lite on Objective-C

      +

      Description — Installing Couchbase Lite on Objective-C

      Get Started

      Create or open an existing Xcode project and install Couchbase Lite 3.1.9 using one of the Install Methods methods shown.

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

      • The minimum required Cocoapods version is 1.9

      • The minimum required Carthage version is 38.0

      Install Methods

      • Direct Download

      • Carthage

      • CocoaPods

      • Get the binary download here — Extend with Mobile.

      • Unpack the download

      • Within Finder, Drag CouchbaseLite.xcframework to the Xcode navigator.

      • Click on Project  General  Embedded Binary and add CouchbaseLite.xcframework to this section.

      • Import the xcframework and start using it in your project.

        #include <CouchbaseLite/CouchbaseLite.h>
        ...
      The minimum required version of Carthage is 38.0
      1. Install Carthage

      2. In your Cartfile, add the following.

        Couchbase Lite Community Edition
        binary "https://packages.couchbase.com/releases/couchbase-lite-ios/carthage/CouchbaseLite-Community.json" ~> 3.1.9
        Couchbase Lite Enterprise Edition
        binary "https://packages.couchbase.com/releases/couchbase-lite-ios/carthage/CouchbaseLite-Enterprise.json" ~> 3.1.9
      3. Run carthage update --platform ios.

      4. Drag CouchbaseLite.xcframework from Carthage/Build/ to the Xcode navigator.

      5. Click on Project > General > Embedded Binary and add CouchbaseLite.xcframework to this section.

      The minimum required version of Cocoapods is 1.9
      1. Install Cocoapods

      2. In your Podfile, add the following.

        Couchbase Lite Community Edition
        target '<your target name>' do
          use_frameworks!
          pod 'CouchbaseLite', '3.1.9'
        end
        Couchbase Lite Enterprise Edition
        target '<your target name>' do
          use_frameworks!
          pod 'CouchbaseLite-Enterprise', '3.1.9'
        end
      3. Install the pods and open the .xcworkspace file generated by Cocoapods.

        pod install