DroidTUI 🤖

A beautiful Terminal User Interface (TUI) for Android development — ADB commands, live logcat viewer, device dashboard, and more. Built with Rust, Ratatui, and the pure-Rust adb_client crate (no Android SDK required).

Features ✨

📺 Live Logcat Viewer

Full-screen, real-time logcat streaming with professional-grade tooling:

• Live streaming via adb_client's native API — no adb binary needed
• Regex search (r toggle) — powerful pattern matching (Error|Exception, OkHttp.*failed)
• Find filter (f) — case-insensitive substring search with match highlighting
• Exclude filter (e) — negative matching to hide noisy tags/messages
• Tag & PID filters (t, p) — dedicated filter fields
• Log level filter (l) — cycle minimum level V → D → I → W → E → F
• Per-tag color hashing — each tag gets a stable, visually distinct color
• Stack trace folding (F) — detect and fold/unfold Java/Kotlin stack traces
• Line detail popup (Enter) — inspect any line with full message, JSON formatting
• Bookmarks (m, [, ]) — mark lines and jump between them
• Copy to clipboard (y) — copy selected line via pbcopy/xclip
• Soft wrap (w) — wrap long messages across multiple rows with aligned indentation
• Compact mode (x) — hide timestamp/PID columns for more message space
• Horizontal scroll (←/→) — scroll long messages when wrap is off
• Auto-scroll — sticks to bottom; manual scroll disables; G/End re-enables
• Pause / Resume (Space) — freeze the view without losing the stream
• Live stats — lines/sec rate and per-level counters in the status bar
• Save logs (s) — save to file with path input dialog
• Save As… (S) — browse with integrated file explorer, Shift+S to save in current folder
• JSON export — Tab in save dialog cycles TXT/JSON format (JSONL for Nushell/jq)
• Bounded channel — sync_channel(10k) with backpressure prevents OOM during bursts
• JSON detection — auto-detects and pretty-prints JSON in log messages with syntax coloring

📱 ADB Command Dashboard

• Device panel — live device selector with model, Android version, battery, RAM, CPU stats
• 40+ typed commands — packages, system, network, root toolkit, bootloader & flash
• Fastboot support — OEM unlock/lock, wipe data, device info
• Type-safe execution — compile-time guarantees via adb_client crate

🎨 Theme System

• 12 named presets — Default, Dracula, Nord, Gruvbox Dark, Catppuccin Mocha, Tokyo Night, Solarized Dark, Moonfly, Oxocarbon, Forest, Neon, Mono
• Global selector (Shift+T) — works from any screen
• 11 colour fields — brand, accent, success, dim, fg, sel_bg, warn, error, surface, border, key_hint

🖥️ CLI Query Mode

Stream logcat as JSON lines to stdout — designed for piping into Nushell, jq, or grep:

droidtui --query                          # Stream live logcat as JSONL
droidtui --query --last 500               # Dump last 500 lines
droidtui --query --level E                # Only errors
droidtui --query --tag MyApp              # Filter by tag
droidtui --query --grep "timeout"         # Filter by message
droidtui --query | nu -c 'lines | each { from json } | where level == "Error"'

📂 Nushell Recipe Scripts

Pre-built analysis scripts in scripts/logcat/:

droidtui --query --last 5000 > logcat.jsonl
nu scripts/logcat/top_tags.nu logcat.jsonl

Installation 🔧

From crates.io

cargo install droidtui

From source

git clone https://github.com/sorinirimies/droidtui.git
cd droidtui
cargo install --path .

Prerequisites

• ADB server running (adb start-server) — the adb binary is only needed to start the server; all commands use the pure-Rust adb_client crate
• A connected Android device with USB debugging enabled

Usage 🎮

droidtui          # Launch the TUI
droidtui --query   # CLI mode — stream logcat as JSON
droidtui --help    # Show all options

Key Bindings — Main Menu

Key Bindings — Logcat Viewer

Navigation

Filters

Actions

Save Dialog

File Browser (Save As…)

Architecture 🏗️

DroidTUI follows an Elm-like architecture with clear separation of concerns:

┌── Model ──────────────────────┐
│ app state, menu, logcat,      │
│ device status, theme          │
├── Message ────────────────────┤
│ all possible state changes    │
├── Update ─────────────────────┤
│ message → state transitions   │
├── View ───────────────────────┤
│ model → terminal rendering    │
├── Event ──────────────────────┤
│ keyboard, tick → messages     │
└───────────────────────────────┘

Project Structure

droidtui/
├── src/
│   ├── main.rs       # Entry point + CLI query mode
│   ├── app.rs        # Event loop, key → message mapping
│   ├── model.rs      # All application state
│   ├── view.rs       # UI rendering (ratatui)
│   ├── update.rs     # State transitions
│   ├── message.rs    # Message enum
│   ├── event.rs      # Async event handling
│   ├── menu.rs       # Command menu widget
│   ├── adb.rs        # ADB client abstraction
│   ├── fastboot.rs   # Fastboot command support
│   ├── logcat.rs     # Logcat viewer (streaming, parsing, filters, stats)
│   ├── theme.rs      # Theme system (12 presets, selector)
│   ├── effects.rs    # Visual effects (TachyonFX)
│   └── lib.rs        # Library exports
├── scripts/
│   ├── logcat/       # Nushell recipe scripts
│   ├── bump_version.nu
│   └── release_prepare.nu
├── tests/
│   └── adb_integration_tests.rs
├── examples/
└── Cargo.toml

Dependencies 📦

Development 🛠️

cargo test                    # Run all 209 tests
cargo clippy --all-targets --all-features -- -D warnings  # Lint
cargo fmt --check             # Format check
just release patch            # Bump, test, tag, push

Adding New ADB Commands

1. Add a variant to AdbCommand in src/adb.rs
2. Implement the handler in AdbManager::execute
3. Add a menu entry in src/menu.rs via build_entries()
4. Tests in tests/adb_integration_tests.rs

Contributing 🤝

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing)
3. Run cargo fmt && cargo clippy --all-targets --all-features -- -D warnings && cargo test
4. Commit and push
5. Open a Pull Request

License 📄

MIT — Copyright (c) Sorin Albu-Irimies

Acknowledgments 🙏

• Ratatui — TUI framework
• adb_client — Pure-Rust ADB client
• TachyonFX — Visual effects
• tui-file-explorer — File browser widget

Made with ❤️ and ☕ for Android developers · Powered by Rust 🦀