DataStore Inspector

A debugging library for Android that lets you inspect and edit SharedPreferences, DataStore Preferences, and Proto DataStore from a browser.

It runs a lightweight HTTP server inside your app and serves a web UI you can open from any browser on the same network.

---

Features

• View, edit, and delete SharedPreferences fields across all files
• View, edit, and delete DataStore Preferences fields
• View and edit Proto DataStore fields
• Color-coded type badges (String, Int, Long, Float, Double, Boolean, StringSet)
• Search keys by name in any tab
• Clear all keys from a store in one click
• Auto-refresh on a configurable interval (toggle in the UI)
• Light and dark theme

---

Setup

Step 1 — Add JitPack to your root settings.gradle.kts

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

Step 2 — Add the dependency

Use debugImplementation so the library is never included in release builds.

dependencies {
    debugImplementation("com.github.Yashraj254:Android-DataStore-Inspector:latest-version")
}

---

Usage

The inspector starts automatically — no call to start() needed. Just register your DataStore instances and open the browser.

Register as many DataStore instances as you need by chaining calls:

class SampleApplication : Application() {
    override fun onCreate() {
        super.onCreate()
        DatastoreInspector
            .registerDataStore("user_preferences", userPreferencesDataStore)
            .registerDataStore("app_settings", appSettingsDataStore)
            .registerProto("user_prefs", userProtoDataStore)
            .registerProto("app_config", appConfigDataStore)
    }
}

SharedPreferences are detected automatically — no registration needed.

---

Open the inspector

On an emulator or device connected via USB

Run this once to forward the port:

adb forward tcp:3000 tcp:3000

Then open http://localhost:3000 in your browser.

On a physical device over Wi-Fi

Find your device's IP address (Settings → About → IP address) and open:

http://<device-ip>:3000

---

Custom port

The default port is 3000. To use a different port, call start() manually before any other registration:

DatastoreInspector.start(this, port = 8080)

---

Proto DataStore

Proto DataStore fields are read using reflection by default — no extra setup needed if your proto message follows standard getter conventions.

For full control over field names and type conversions, provide a custom ProtoInspectorMapper:

class UserPreferencesProtoMapper : ProtoInspectorMapper<UserPreferences> {

    override fun toEntries(proto: UserPreferences): List<ProtoEntry> = listOf(
        ProtoEntry("username", proto.username, "String"),
        ProtoEntry("email", proto.email, "String"),
        ProtoEntry("number", proto.number, "String"),
        ProtoEntry("age", proto.age.toString(), "Int"),
        ProtoEntry("is_premium", proto.isPremium.toString(), "Boolean"),
        ProtoEntry("rating", proto.rating.toString(), "Float"),
        ProtoEntry("last_login", proto.lastLogin.toString(), "Long"),
        ProtoEntry("account_balance", proto.accountBalance.toString(), "Double"),
    )

    override fun updateField(proto: UserPreferences, key: String, value: String): UserPreferences {
        val builder = proto.toBuilder()
        when (key) {
            "username" -> builder.username = value
            "email" -> builder.email = value
            "number" -> builder.number = value
            "age" -> builder.age = value.toInt()
            "is_premium" -> builder.isPremium = value.toBoolean()
            "rating" -> builder.rating = value.toFloat()
            "last_login" -> builder.lastLogin = value.toLong()
            "account_balance" -> builder.accountBalance = value.toDouble()
        }
        return builder.build()
    }
}

Pass it when registering:

DatastoreInspector.registerProto("user_prefs", userProtoDataStore, UserPreferencesMapper())

---

Screenshots

Light Theme

Dark Theme

---

License

Copyright 2026 Yashraj Singh Jadon

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.