Install Realm for iOS, macOS, tvOS, and watchOS
On this page
- Overview
- Prerequisites
- Installation
- Add Package Dependency
- Specify the Repository
- Specify Options
- Select the Package Products
- Update the CocoaPods repositories
- Initialize CocoaPods for Your Project
- Add Realm as a Dependency in Your Podfile
- Install the Dependencies
- Use the CocoaPods-Generated
.xcworkspaceFile - Add Realm as a Dependency in Your Cartfile
- Install the Dependencies
- Add the Frameworks to Your Project
- Enable the Copy Frameworks Script (iOS, tvOS, and watchOS only)
- Download and Extract the Framework
- Copy Framework(s) Into Your Project
- Link Binaries
- Import Realm
- Troubleshooting
Overview
MongoDB Realm's Swift SDK enables your iOS, macOS, tvOS, and watchOS applications to interact with MongoDB Realm using either the Swift or Objective-C programming languages. This page details how to install Realm in your project and get started.
Prerequisites
Before getting started, ensure your development environment meets the following prerequisites:
- Xcode version 12.4 or higher.
- Target of iOS 9.0 or higher, macOS 10.9 or higher, tvOS 9.0 or higher, or watchOS 2.0 or higher.
- If using Swift Package Manager, target of iOS 11+ or macOS 10.10+ is required.
There are special considerations when using Realm Database with tvOS. See Build for tvOS for more information.
Installation
You can use SwiftPM, CocoaPods, or Carthage to add the
MongoDB Realm Swift SDK to your project.
Import Realm
Add the following line at the top of your source files to use MongoDB Realm:
Troubleshooting
If you have build issues after using one of these methods to install Realm, see our troubleshooting guidelines for information about resolving those issues realm.