LogKitty

The Always-On Logcat Overlay for Android.

LogKitty is a developer tool that puts your system logs right where you need them: floating above your target app. No more switching back and forth between your device and Android Studio.

Features

• Always-On Overlay: A persistent bottom sheet that floats over other apps.
• Real-Time Logs: Streams logcat output directly to the overlay.
• Peek & Expand:
  • Peek: See the latest log line without obstruction.
  • Half: Scroll through recent logs.
  • Full: Deep dive into stack traces.
• Context Awareness: Automatically detects the foreground app to highlight or filter relevant logs.
• Copy to Clipboard: Quickly grab logs to share or analyze.
• Save to File: Save the current log buffer to a text file for sharing or later analysis.
• Settings: Manage overlay opacity, text size, prohibited tags, and more.

Documentation

The Privacy Policy and Permissions are published on the web. Comprehensive documentation is available in the docs/ directory:

• Setup Guide: Build instructions, prerequisites, and installation.
• Releasing: Signed App Bundle, versionCode, dynamic feature modules, and Play Console publishing.
• Pre-release checklist: Play setup, data-safety, and on-device smoke tests to run before publishing.
• Architecture: High-level overview of the system design (MVVM, Services).
• API Reference: Detailed description of key classes and components.
• File Descriptions: A map of the project structure.
• UI/UX Guidelines: Design philosophy and component breakdown.
• Task Flow: Typical user workflows.
• Contribution Guide: Code of conduct and rules for contributors/agents.

Installation

1. Download the latest APK from Releases.
2. Install on your Android device.
3. Grant Permissions:
   • Follow the in-app prompt to grant "Display Over Other Apps".
   • Required: Grant the READ_LOGS permission via ADB:

     adb shell pm grant com.hereliesaz.logkitty android.permission.READ_LOGS

Usage

1. Open LogKitty.
2. Tap "Start Overlay".
3. Navigate to the app you want to debug.
4. Watch the logs roll in!
5. Use the icons in the overlay header to Copy, Save, or open Settings.

Development

LogKitty is built with Kotlin and Jetpack Compose.

Build

./gradlew :app:assembleDebug

Versioning

See version.properties for the current version state. Local builds auto-increment the build number; CI passes -PversionBuild=$(git rev-list --count HEAD) for a strictly-increasing versionCode. See docs/RELEASING.md for signed App Bundle builds and Play publishing.