Skip to main content

A framework for controlling Android devices through LLM agents

Project description

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

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.0.dev4.tar.gz (1.0 MB 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.0.dev4-py3-none-any.whl (267.8 kB view details)

Uploaded Python 3

File details

Details for the file droidrun-0.5.0.dev4.tar.gz.

File metadata

  • Download URL: droidrun-0.5.0.dev4.tar.gz
  • Upload date:
  • Size: 1.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for droidrun-0.5.0.dev4.tar.gz
Algorithm Hash digest
SHA256 b97f6da7a2c74900d80954bd4da293221d442cd986726cccf9895994e12f5ab3
MD5 9ae28ac88343eedceab36d452232d64e
BLAKE2b-256 a4bce116a704ea2a7f9b382cb1cb6d4f5eaa3f51bbb814c4d89c0523bbc4cc44

See more details on using hashes here.

Provenance

The following attestation bundles were made for droidrun-0.5.0.dev4.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.0.dev4-py3-none-any.whl.

File metadata

  • Download URL: droidrun-0.5.0.dev4-py3-none-any.whl
  • Upload date:
  • Size: 267.8 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.0.dev4-py3-none-any.whl
Algorithm Hash digest
SHA256 692817cdd0738500a140f4c543ac962255e574db60ffdb7c9106e52d8a15ce26
MD5 4498f365bf52bb3cb37c5602ee38d507
BLAKE2b-256 febd5edee3a6c95568d9252d0438c1fe38e6864bfcb6630db78a51bb25b1832d

See more details on using hashes here.

Provenance

The following attestation bundles were made for droidrun-0.5.0.dev4-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