Docs Menu

Docs HomeRealm

Install Realm - Kotlin SDK

On this page

  • Prerequisites
  • Installation
  • Add Realm to the Project
  • Sync Gradle Files
  • Add Realm to the Project
  • Sync Gradle Files
  • Supported Target Environments

The Kotlin SDK supports two platforms, each with its own installation method:

  • Android

  • Kotlin Multiplatform

Before getting started, ensure your development environment meets the following prerequisites:

Additionally, Kotlin Multiplatform (KMM) projects require the following:

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.


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.

Kotlin Multiplatform supports a wide range of application environments.

The SDK supports the following environments:

  • android

  • iosArm64

  • iosSimulatorArm64

  • iosX64

  • jvm

  • macosArm64

  • macosX64

The SDK does not support the following environments:

  • androidNativeArm32

  • androidNativeArm64

  • androidNativeX86

  • androidNativeX64

  • iosArm32

  • js

  • linuxArm32Hfp

  • linuxArm64

  • linuxMips32

  • linuxMipsel32

  • linuxX64

  • mingwX64

  • mingwX86

  • tvosArm64

  • tvosSimulatorArm64

  • tvosX64

  • wasm32

  • watchosArm32

  • watchosArm64

  • watchosSimulatorArm64

  • watchosX86

  • watchosX64

←  Realm Kotlin SDKQuick Start - Kotlin SDK →
Share Feedback
© 2023 MongoDB, Inc.


  • Careers
  • Investor Relations
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2023 MongoDB, Inc.