Skip to main content

A framework for controlling Android devices through LLM agents

Project description

DroidRun is not affiliated with, endorsed by, or sponsored by Google LLC or the Android Open Source Project. Android™ is a trademark of Google LLC.

DroidRun is a powerful framework for controlling Android and iOS devices through LLM agents. It allows you to automate device interactions using natural language commands. Checkout our benchmark results

⚖️ Disclaimer

Droidrun is an independent, open-source project and is not affiliated with, endorsed by, or sponsored by Google LLC or the Android Open Source Project. "Android" is a trademark of Google LLC. All other trademarks and brand names mentioned are the property of their respective owners. DroidRun is a third-party tool that interacts with the Android platform but is not part of the Android ecosystem.

Why Droidrun?

  • 🤖 Control Android and iOS devices with natural language commands
  • 🔀 Supports multiple LLM providers (OpenAI, Anthropic, Gemini, Ollama, DeepSeek)
  • 🧠 Planning capabilities for complex multi-step tasks
  • 💻 Easy to use CLI with enhanced debugging features
  • 🐍 Extendable Python API for custom automations
  • 📸 Screenshot analysis for visual understanding of the device
  • 🫆 Execution tracing with Arize Phoenix

📦 Installation

Note: Python 3.14 is not currently supported. Please use Python 3.11 – 3.13.

pip install droidrun

🚀 Quickstart

Read on how to get droidrun up and running within seconds in our docs!

Quickstart Video

🎬 Demo Videos

  1. Accommodation booking: Let Droidrun search for an apartment for you

    Droidrun Accommodation Booking Demo


  1. Trend Hunter: Let Droidrun hunt down trending posts

    Droidrun Trend Hunter Demo


  1. Streak Saver: Let Droidrun save your streak on your favorite language learning app

    Droidrun Streak Saver Demo

💡 Example Use Cases

  • Automated UI testing of mobile applications
  • Creating guided workflows for non-technical users
  • Automating repetitive tasks on mobile devices
  • Remote assistance for less technical users
  • Exploring mobile UI with natural language commands

👥 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

Security Checks

To ensure the security of the codebase, we have integrated security checks using bandit and safety. These tools help identify potential security issues in the code and dependencies.

Running Security Checks

Before submitting any code, please run the following security checks:

  1. Bandit: A tool to find common security issues in Python code.

    bandit -r droidrun
    
  2. Safety: A tool to check your installed dependencies for known security vulnerabilities.

    safety scan
    

Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

droidrun-0.5.1.dev3.tar.gz (708.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

droidrun-0.5.1.dev3-py3-none-any.whl (273.2 kB view details)

Uploaded Python 3

File details

Details for the file droidrun-0.5.1.dev3.tar.gz.

File metadata

  • Download URL: droidrun-0.5.1.dev3.tar.gz
  • Upload date:
  • Size: 708.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for droidrun-0.5.1.dev3.tar.gz
Algorithm Hash digest
SHA256 07ae25d88ee3bcd55bb84d955e896aaf53b058c367e56ffcea9f37be6ea646cd
MD5 2cdac05d86845c3f1751f3af9dd9a31f
BLAKE2b-256 e4dc35af333f8606a688fd5e289aade64e06e8e77c98c3567b8e5dead9f3e86e

See more details on using hashes here.

Provenance

The following attestation bundles were made for droidrun-0.5.1.dev3.tar.gz:

Publisher: publish.yml on droidrun/droidrun

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file droidrun-0.5.1.dev3-py3-none-any.whl.

File metadata

  • Download URL: droidrun-0.5.1.dev3-py3-none-any.whl
  • Upload date:
  • Size: 273.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for droidrun-0.5.1.dev3-py3-none-any.whl
Algorithm Hash digest
SHA256 9568903df6f3bb669ee9ad5eae6b54d8e696924cb1c520e2bc5616f7ceddaae1
MD5 92b1df1a37d5ec257dbbe1d60af929c1
BLAKE2b-256 0cf393527064d0ca3329544b6a7e8eb1afb06773466465c7bd62ef9b1279e668

See more details on using hashes here.

Provenance

The following attestation bundles were made for droidrun-0.5.1.dev3-py3-none-any.whl:

Publisher: publish.yml on droidrun/droidrun

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page