Skip to content
Cimka Docs

Quickstart

  1. Create your account. Open the dashboard, choose the Register tab and fill in Full Name, Email, Password (8+ characters), Organization Name and Organization Slug. Click Create Account.

    You become the Admin of a new organization, and its wallet receives free credit to get started.

  2. Confirm your email. Click the link in the confirmation email. The Confirm your email screen continues automatically once you’ve confirmed (or click I’ve confirmed, continue). Use Resend confirmation email if it didn’t arrive.

  3. Register your app. Go to Settings → SDK Configuration Generator → Register SDK:

    • Platform: choose Android.
    • App Info: enter the app name and the application id (the applicationId from your build.gradle.kts, e.g. com.acme.shop). Turn on App is Live and add the Store URL if the app is published.
    • License: copy the License Key, SDK API Key and Application ID.

  4. Download the config. With your app selected, click Download Config and save the file as app/src/main/assets/cimka_config.json.

  5. Add the SDK. Follow Android installation, then initialize it:

    class MyApp : Application() {
        override fun onCreate() {
            super.onCreate()
            Cimka.initialize(this)
            CimkaXml.register()     // View/XML apps
            CimkaOffline.register() // optional
        }
    }

    Add the network interceptor to your OkHttp client:

    OkHttpClient.Builder().addInterceptor(Cimka.interceptor).build()

  6. Run your app. Open it, navigate a few screens and make a network call. Within seconds you’ll see:

    • a live session under Analyze → User Sessions,
    • your device under Clients → Devices,
    • the release under Analyze → Releases,
    • screens, taps and requests under Log Components.

  7. Trigger a test crash to see crash reporting end to end:

    throw RuntimeException("Cimka test crash")

    Restart the app — the crash appears under Log Components → Crashes.

What’s next

Section titled “What’s next”
  • Protect sensitive data: add your API’s sensitive field names under Settings → Data Masking.
  • Choose what to collect: toggle log types per app in App Config.
  • Identify users: call Cimka.identify(userId) after login — see Core API.
  • Invite your team: Team & roles.
  • Watch your balance: sessions are billed from a prepaid wallet — see Billing.