Android (Kotlin) — Installation

Requirements

Android 7.0+ (API 24)
Kotlin 1.9+, Android Gradle Plugin 8.5+

This is the native Kotlin library for apps with no Flutter involved. If your app is built with Flutter, use the Flutter SDK instead — it already covers iOS, Android, and Web from one package.

1. Add the dependency

The SDK is distributed via JitPack, built directly from GitHub releases. Add the JitPack repository in settings.gradle.kts:

settings.gradle.kts

dependencyResolutionManagement {
    repositories {
        google()
        mavenCentral()
        maven { url = uri("https://jitpack.io") }
    }
}

Then add the dependency in your app’s build.gradle.kts:

build.gradle.kts

dependencies {
    implementation("com.github.lerix.lerix-android:lerix:1.1.0")
}

Replace 1.0.0 with the version you want to pin to — see the releases page for available versions.

2. Initialize the SDK

Call Lerix.initialize() as early as possible — from a custom Application.onCreate(). This registers your app/device with the backend and installs automatic crash reporting.

LerixExampleApp.kt

import android.app.Application
import com.lerix.sdk.Lerix

class MyApplication : Application() {
    override fun onCreate() {
        super.onCreate()
        Lerix.initialize(
            context = this,
            apiKey = "your-api-key",
            projectId = "your-project-id",
            debugMode = true,
        )
    }
}

AndroidManifest.xml

<application android:name=".MyApplication" ...>

Find your API key and project ID in the Lerix Dashboard under Project Settings.

Parameters

Parameter	Type	Required	Description
`context`	`Context`	Yes	Any application/activity context
`apiKey`	`String`	Yes	Your project API key from the dashboard
`projectId`	`String`	Yes	Your project ID (slug) from the dashboard
`url`	`String`	No	Backend base URL. Defaults to `https://api.lerix.dev/v1` — only change this if you’re pointing at a self-hosted backend
`debugMode`	`Boolean`	No	Print SDK request/response logs to Logcat (default: `false`)
`enableCrashReporting`	`Boolean`	No	Install the automatic crash handler (default: `true`) — see Error Tracking
`onError`	`((Throwable) -> Unit)?`	No	Called if initialization itself fails (e.g. network unreachable)

3. Verify the integration

Throw a test error to confirm everything is working:

Lerix.throwError("Test error")

Then open your dashboard — the error should appear within seconds.

You’re all set! Continue to Error Tracking to report custom errors and enable automatic crash capture, or Push Notifications to enable push delivery.

Getting started

Frameworks

Modules

Developers

Android (Kotlin) — Installation

Requirements

1. Add the dependency

2. Initialize the SDK

Parameters

3. Verify the integration

​Requirements

​1. Add the dependency

​2. Initialize the SDK

​Parameters

​3. Verify the integration

Requirements

1. Add the dependency

2. Initialize the SDK

Parameters

3. Verify the integration