Skip to content

Repository files navigation

CashPilot Android

CashPilot Android

Release CI License codecov

CashPilot Android is the Android companion app for CashPilot. It detects which passive income apps are installed and running on your phone, without root, and reports them to your CashPilot fleet dashboard.

Features

  • Detects 11 passive income apps: EarnApp, IPRoyal Pawns, MystNodes, Traffmonetizer, Bytelixir, ByteBenefit, Grass, Titan Network, Nodle Cash, Uprock, Wipter
  • Instant detection from each app's ongoing notification (NotificationListenerService)
  • Confirms activity from per-app network traffic and recent foreground use (NetworkStatsManager, UsageStatsManager)
  • Periodic heartbeats to your server (POST /api/workers/heartbeat), so phones appear next to Docker workers in the fleet view
  • Sends data only to your own CashPilot server, plus one request to api.ipify.org to show your public IP
  • No root required; Android 8.0 or later

Quick start

  1. Download app-release.apk from the latest release and install it.
  2. Grant the three permissions it asks for: Notification Access, Usage Access, and the battery-optimisation exemption.
  3. In Settings, enter your CashPilot server URL and the fleet key (CASHPILOT_API_KEY on the server). Use https://; the app accepts http:// only for a LAN, loopback or Tailscale address.

Needs Android 8.0 (API 26) or later and a reachable CashPilot 1.x server.

Documentation

Everything below is on the site, https://geiserx.github.io/CashPilot-android/.

  • Getting started: install the APK, the first-run steps, and what a working start looks like
  • Usage: the dashboard, what each app state means, earnings, the notification
  • Configuration: every setting, the fleet key and enrollment, heartbeat timing, the app list
  • How it works: the three detection APIs, the running rule, what a heartbeat carries, privacy
  • Troubleshooting: symptom, cause, fix, and what to put in a bug report
  • Development: building, tests, releases, the stack
  • Related projects: the CashPilot server, desktop app and integrations

Related projects

CashPilot, CashPilot-Desktop, cashpilot-ha, cashpilot-mcp.

License

GPL-3.0-or-later

Releases

Packages

Used by

Contributors

Languages