Manual Installation

If you aren't using CocoaPods, ObjectBox can easily be installed manually. Just download, add the framework to your project, and run our setup script.


You can get the newest from our GitHub Releases page:

Unpack the ZIP-archive and put the entire folder somewhere in your project's folder (for example, if your project is in /Users/vivien/RecordsDatabase/RecordsDatabase.xcodeproj, you could put ObjectBox at /Users/vivien/RecordsDatabase/ObjectBox ).

Add the Framework to your Project

Like with any embedded framework, you link to it and copy it into your application:

  • Find the ObjectBox.framework for your platform from the ObjectBox/Carthage/Build/ folder (e.g. ObjectBox/Carthage/Build/iOS/ObjectBox.framework).

  • Open your project's target settings by clicking the little blue project icon at the top of the Project Navigator in Xcode.

  • Select the General tab for your target and find the Frameworks, Libraries and Embedded Content section.

  • Drag the ObjectBox.framework into the list and choose "Embed & Sign" from the popup at its right.

  • macOS and Xcode 10 and earlier only:

    • Go to the Build Phases tab and add a Copy Files build phase.

    • Select Frameworks as the Destination from the popup.

    • Drag the ObjectBox.framework into it.

You're done, your project is linking to ObjectBox.

Setup Script

Then open Terminal and run

gem install xcodeproj /path/to/ObjectBox/setup.rb /path/to/MyProject.xcodeproj

where /path/to/ is again where your project is, like /Users/vivien/RecordsDatabase/ above.

The first call installs a helper library needed by the installation script to do its work. This library is not needed once you have run the script. Nobody else using your project needs to do this.


You can now open your project and follow the rest of this tutorial.

Last updated