aerogear ios sync client Build Status Pod Version

NOTE: The library has been tested with Xcode 6.3

AeroGear iOS Differential Synchronization Client Engine represents a client side implementation for AeroGear Differential Synchronization (DS) Server.

This client uses the communication with the backend server implementation. The iOS SyncEngine performs the actual work of the DiffSync protocol, please refer to its for more details.

Project Info
License: Apache License, Version 2.0
Build: CocoaPods
Issue tracker:
Mailing lists: aerogear-users (subscribe)
aerogear-dev (subscribe)

Build, test and play with aerogear-ios-sync-client

  1. Clone this project

  2. Get the dependencies

The project uses cocoapods 0.36 release for handling its dependencies. As a pre-requisite, install cocoapods and then install the pod. On the root directory of the project run: bash pod install 3. open AeroGearSyncClient.xcworkspace

Adding the library to your project

To add the library in your project, you can either use Cocoapods or manual install in your project. See the respective sections below for instructions:

Using Cocoapods

Support for Swift frameworks is supported from CocoaPods-0.36 release upwards. In your Podfile add:

source ''

xcodeproj 'YourProjectName.xcodeproj'
platform :ios, '8.0'

pod 'AeroGearSyncClient'
pod 'AeroGearSync/JSONPatch'

NOTE: AeroGearSync is using podsubspec, you will need to specify which algorithm option you want to go. For more details, see aerogear-ios-cookbook/Jedi app. and then:

pod install

to install your dependencies.

Manual Installation

Follow these steps to add the library in your Swift project:

  1. Add AeroGearSyncClient as a submodule in your project. Open a terminal and navigate to your project directory. Then enter: bash git submodule add
  2. Open the aerogear-ios-sync-client folder, and drag the AeroGearSyncClient.xcodeproj into the file navigator in Xcode.
  3. In Xcode select your application target and under the Targets heading section, ensure that the ‘iOS Deployment Target’ matches the application target of AeroGearSyncClient.framework (Currently set to 8.0).
  4. Select the Build Phases heading section, expand the Target Dependencies group and add AeroGearSyncClient.framework.
  5. Click on the + button at the top left of the panel and select New Copy Files Phase. Rename this new phase to Copy Frameworks, set the Destination to Frameworks, and add AeroGearSyncClient.framework.

Repeat the same instructions for aerogear-ios-sync.


For more details about the current release, please consult our documentation.


If you would like to help develop AeroGear you can join our developer’s mailing list, join #aerogear on Freenode, or shout at us on Twitter @aerogears.

Also takes some time and skim the contributor guide


Join our user mailing list for any questions or help! We really hope you enjoy app development with AeroGear!

Found a bug?

If you found a bug please create a ticket for us on Jira with some steps to reproduce it.