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.dev0.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.dev0-py3-none-any.whl (267.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: droidrun-0.5.0.dev0.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.dev0.tar.gz
Algorithm Hash digest
SHA256 9766c7a3626c594871589ccb4a6f0854728be582fab6343d9500098c881decb7
MD5 71d7fdfa4fece89b5ea0d0c1ee956c0a
BLAKE2b-256 9fb9dd42fe09622d2f53296885f1055ebf8a84a16dcac41a5ba25c49686cda72

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: droidrun-0.5.0.dev0-py3-none-any.whl
  • Upload date:
  • Size: 267.4 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.dev0-py3-none-any.whl
Algorithm Hash digest
SHA256 4fc45e13785112e4427b1b95888c247ceee3960012d06cd59a515e1ea487b991
MD5 a099681c0cd881d27719cc70f92af170
BLAKE2b-256 424bc1c297c340e600dbb060607884fdde89180013599c69e3e36a01ea1ce05b

See more details on using hashes here.

Provenance

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