Install Realm - Kotlin SDK
On this page
The Kotlin SDK supports two platforms, each with its own installation method:
Prerequisites
Before getting started, ensure your development environment meets the following prerequisites:
Android Studio Bumblebee 2021.1.1 or higher.
JDK 11 or higher.
Kotlin Plugin for Android Studio, version 1.6.10 or higher.
An Android Virtual Device (AVD) using a supported CPU architecture.
Additionally, Kotlin Multiplatform (KMM) projects require the following:
Kotlin Multiplatform Mobile (KMM) Plugin for Android Studio, version 0.3.1 or higher.
A KMM App created using the "KMM Application" template in Android Studio. Follow the instructions in the KMM documentation.
For more details on setting up your KMM environment, refer to the official Kotlin Multiplatform documentation. To verify your environment setup, follow Kotlin's guide to checking your environment.
Tip
Kotlin Plugin Version
The Kotlin Multiplatform ecosystem frequently changes. If you experience any issues installing the SDK, check your Kotlin Plugin version, since outdated plugins can lead to difficult to debug errors. To see which versions of the Kotlin Plugin are compatible with the SDK, see the realm-kotlin changelog.
Installation
Add Realm to the Project
Sync Gradle Files
After updating the Gradle configuration, resolve the dependencies by clicking File > Sync Project with Gradle Files in the Android Studio menu bar. You can now use the Kotlin SDK in your application.
Supported Target Environments
Kotlin Multiplatform supports a wide range of application environments.
Supported Environments
The Kotlin SDK supports the following environments:
androidiosArm64iosSimulatorArm64iosX64jvmmacosArm64macosX64
Unsupported Environments
The Kotlin SDK does not support the following environments:
androidNativeArm32androidNativeArm64androidNativeX86androidNativeX64iosArm32jslinuxArm32HfplinuxArm64linuxMips32linuxMipsel32linuxX64mingwX64mingwX86tvosArm64tvosSimulatorArm64tvosX64wasm32watchosArm32watchosArm64watchosSimulatorArm64watchosX86watchosX64