droidrun 0.3.1__py3-none-any.whl → 0.3.3__py3-none-any.whl

droidrun/cli/main.py

@@ -7,13 +7,23 @@ import click
 import os
 import logging
 import warnings
+from contextlib import nullcontext
 from rich.console import Console
+from adbutils import adb
 from droidrun.agent.droid import DroidAgent
 from droidrun.agent.utils.llm_picker import load_llm
-from droidrun.adb import DeviceManager
 from droidrun.tools import AdbTools, IOSTools
+from droidrun.agent.context.personas import DEFAULT, BIG_AGENT
 from functools import wraps
 from droidrun.cli.logs import LogHandler
+from droidrun.telemetry import print_telemetry_message
+from droidrun.portal import (
+    download_portal_apk,
+    enable_portal_accessibility,
+    PORTAL_PACKAGE_NAME,
+    ping_portal,
+)
+from droidrun.macro.cli import macro_cli
 
 # Suppress all warnings
 warnings.filterwarnings("ignore")
@@ -21,7 +31,6 @@ os.environ["TOKENIZERS_PARALLELISM"] = "false"
 os.environ["GRPC_ENABLE_FORK_SUPPORT"] = "false"
 
 console = Console()
-device_manager = DeviceManager()
 
 
 def configure_logging(goal: str, debug: bool):
@@ -30,16 +39,21 @@ def configure_logging(goal: str, debug: bool):
 
     handler = LogHandler(goal)
     handler.setFormatter(
-        logging.Formatter("%(levelname)s %(message)s", "%H:%M:%S")
+        logging.Formatter("%(levelname)s %(name)s %(message)s", "%H:%M:%S")
         if debug
         else logging.Formatter("%(message)s", "%H:%M:%S")
     )
     logger.addHandler(handler)
 
-
     logger.setLevel(logging.DEBUG if debug else logging.INFO)
     logger.propagate = False
 
+    if debug:
+        tools_logger = logging.getLogger("droidrun-tools")
+        tools_logger.addHandler(handler)
+        tools_logger.propagate = False
+        tools_logger.setLevel(logging.DEBUG if debug else logging.INFO)
+
     return handler
 
 
@@ -64,9 +78,11 @@ async def run_command(
     reasoning: bool,
     reflection: bool,
     tracing: bool,
-    debug: bool,
+    debug: bool,    
+    use_tcp: bool,
     save_trajectory: bool = False,
     ios: bool = False,
+    allow_drag: bool = False,
     **kwargs,
 ):
     """Run a command on your Android device using natural language."""
@@ -78,6 +94,7 @@ async def run_command(
     with log_handler.render() as live:
         try:
             logger.info(f"🚀 Starting: {command}")
+            print_telemetry_message()
 
             if not kwargs.get("temperature"):
                 kwargs["temperature"] = 0
@@ -87,23 +104,34 @@ async def run_command(
             # Device setup
             if device is None and not ios:
                 logger.info("🔍 Finding connected device...")
-                device_manager = DeviceManager()
-                devices = await device_manager.list_devices()
+                
+                devices = adb.list()
                 if not devices:
                     raise ValueError("No connected devices found.")
                 device = devices[0].serial
                 logger.info(f"📱 Using device: {device}")
             elif device is None and ios:
-                raise ValueError("iOS device not specified. Please specify the device base url (http://device-ip:6643) via --device")
+                raise ValueError(
+                    "iOS device not specified. Please specify the device base url (http://device-ip:6643) via --device"
+                )
             else:
                 logger.info(f"📱 Using device: {device}")
 
-            tools = AdbTools(serial=device) if not ios else IOSTools(url=device)
+            tools = AdbTools(serial=device, use_tcp=use_tcp) if not ios else IOSTools(url=device)
+            # Set excluded tools based on CLI flags
+            excluded_tools = [] if allow_drag else ["drag"]
+            
+            # Select personas based on --drag flag
+            personas = [BIG_AGENT] if allow_drag else [DEFAULT]
 
             # LLM setup
             log_handler.update_step("Initializing LLM...")
             llm = load_llm(
-                provider_name=provider, model=model, base_url=base_url, api_base=api_base, **kwargs
+                provider_name=provider,
+                model=model,
+                base_url=base_url,
+                api_base=api_base,
+                **kwargs,
             )
             logger.info(f"🧠 LLM ready: {provider}/{model}")
 
@@ -116,10 +144,13 @@ async def run_command(
             if tracing:
                 logger.info("🔍 Tracing enabled")
 
+
             droid_agent = DroidAgent(
                 goal=command,
                 llm=llm,
                 tools=tools,
+                personas=personas,
+                excluded_tools=excluded_tools,
                 max_steps=steps,
                 timeout=1000,
                 vision=vision,
@@ -127,7 +158,7 @@ async def run_command(
                 reflection=reflection,
                 enable_tracing=tracing,
                 debug=debug,
-                save_trajectories=save_trajectory
+                save_trajectories=save_trajectory,
             )
 
             logger.info("▶️  Starting agent execution...")
@@ -202,13 +233,19 @@ class DroidRunCLI(click.Group):
     default=None,
 )
 @click.option(
-    "--vision", is_flag=True, help="Enable vision capabilites by using screenshots", default=False
+    "--vision",
+    is_flag=True,
+    help="Enable vision capabilites by using screenshots",
+    default=False,
 )
 @click.option(
     "--reasoning", is_flag=True, help="Enable planning with reasoning", default=False
 )
 @click.option(
-    "--reflection", is_flag=True, help="Enable reflection step for higher reasoning", default=False
+    "--reflection",
+    is_flag=True,
+    help="Enable reflection step for higher reasoning",
+    default=False,
 )
 @click.option(
     "--tracing", is_flag=True, help="Enable Arize Phoenix tracing", default=False
@@ -216,6 +253,9 @@ class DroidRunCLI(click.Group):
 @click.option(
     "--debug", is_flag=True, help="Enable verbose debug logging", default=False
 )
+@click.option(
+    "--use-tcp", is_flag=True, help="Use TCP communication for device control", default=False
+)
 @click.option(
     "--save-trajectory",
     is_flag=True,
@@ -236,6 +276,7 @@ def cli(
     reflection: bool,
     tracing: bool,
     debug: bool,
+    use_tcp: bool,
     save_trajectory: bool,
 ):
     """DroidRun - Control your Android device through LLM agents."""
@@ -271,13 +312,19 @@ def cli(
     default=None,
 )
 @click.option(
-    "--vision", is_flag=True, help="Enable vision capabilites by using screenshots", default=False
+    "--vision",
+    is_flag=True,
+    help="Enable vision capabilites by using screenshots",
+    default=False,
 )
 @click.option(
     "--reasoning", is_flag=True, help="Enable planning with reasoning", default=False
 )
 @click.option(
-    "--reflection", is_flag=True, help="Enable reflection step for higher reasoning", default=False
+    "--reflection",
+    is_flag=True,
+    help="Enable reflection step for higher reasoning",
+    default=False,
 )
 @click.option(
     "--tracing", is_flag=True, help="Enable Arize Phoenix tracing", default=False
@@ -285,6 +332,9 @@ def cli(
 @click.option(
     "--debug", is_flag=True, help="Enable verbose debug logging", default=False
 )
+@click.option(
+    "--use-tcp", is_flag=True, help="Use TCP communication for device control", default=False
+)
 @click.option(
     "--save-trajectory",
     is_flag=True,
@@ -292,8 +342,13 @@ def cli(
     default=False,
 )
 @click.option(
-    "--ios", is_flag=True, help="Run on iOS device", default=False
+    "--drag",
+    "allow_drag",
+    is_flag=True,
+    help="Enable drag tool",
+    default=False,
 )
+@click.option("--ios", is_flag=True, help="Run on iOS device", default=False)
 def run(
     command: str,
     device: str | None,
@@ -308,7 +363,9 @@ def run(
     reflection: bool,
     tracing: bool,
     debug: bool,
+    use_tcp: bool,
     save_trajectory: bool,
+    allow_drag: bool,
     ios: bool,
 ):
     """Run a command on your Android device using natural language."""
@@ -326,18 +383,19 @@ def run(
         reflection,
         tracing,
         debug,
+        use_tcp,
         temperature=temperature,
         save_trajectory=save_trajectory,
-        ios=ios
+        allow_drag=allow_drag,
+        ios=ios,
     )
 
 
 @cli.command()
-@coro
-async def devices():
+def devices():
     """List connected Android devices."""
     try:
-        devices = await device_manager.list_devices()
+        devices = adb.list()
         if not devices:
             console.print("[yellow]No devices connected.[/]")
             return
@@ -350,28 +408,25 @@ async def devices():
 
 
 @cli.command()
-@click.argument("ip_address")
-@click.option("--port", "-p", default=5555, help="ADB port (default: 5555)")
-@coro
-async def connect(ip_address: str, port: int):
+@click.argument("serial")
+def connect(serial: str):
     """Connect to a device over TCP/IP."""
     try:
-        device = await device_manager.connect(ip_address, port)
-        if device:
-            console.print(f"[green]Successfully connected to {ip_address}:{port}[/]")
+        device = adb.connect(serial)
+        if device.count("already connected"):
+            console.print(f"[green]Successfully connected to {serial}[/]")
         else:
-            console.print(f"[red]Failed to connect to {ip_address}:{port}[/]")
+            console.print(f"[red]Failed to connect to {serial}: {device}[/]")
     except Exception as e:
         console.print(f"[red]Error connecting to device: {e}[/]")
 
 
 @cli.command()
 @click.argument("serial")
-@coro
-async def disconnect(serial: str):
+def disconnect(serial: str):
     """Disconnect from a device."""
     try:
-        success = await device_manager.disconnect(serial)
+        success = adb.disconnect(serial, raise_error=True)
         if success:
             console.print(f"[green]Successfully disconnected from {serial}[/]")
         else:
@@ -381,18 +436,16 @@ async def disconnect(serial: str):
 
 
 @cli.command()
-@click.option("--path", required=True, help="Path to the APK file to install")
 @click.option("--device", "-d", help="Device serial number or IP address", default=None)
-@coro
-async def setup(path: str, device: str | None):
-    """Install an APK file and enable it as an accessibility service."""
+@click.option("--path", help="Path to the Droidrun Portal APK to install on the device. If not provided, the latest portal apk version will be downloaded and installed.", default=None)
+@click.option(
+    "--debug", is_flag=True, help="Enable verbose debug logging", default=False
+)
+def setup(path: str | None, device: str | None, debug: bool):
+    """Install and enable the DroidRun Portal on a device."""
     try:
-        if not os.path.exists(path):
-            console.print(f"[bold red]Error:[/] APK file not found at {path}")
-            return
-
         if not device:
-            devices = await device_manager.list_devices()
+            devices = adb.list()
             if not devices:
                 console.print("[yellow]No devices connected.[/]")
                 return
@@ -400,72 +453,108 @@ async def setup(path: str, device: str | None):
             device = devices[0].serial
             console.print(f"[blue]Using device:[/] {device}")
 
-        device_obj = await device_manager.get_device(device)
+        device_obj = adb.device(device)
         if not device_obj:
             console.print(
                 f"[bold red]Error:[/] Could not get device object for {device}"
             )
             return
-        
-        console.print(f"[bold blue]Step 1/2: Installing APK:[/] {path}")
-        result = await device_obj.install_app(path, False, True)
 
-        if "Error" in result:
-            console.print(f"[bold red]Installation failed:[/] {result}")
-            return
+        if not path:
+            console.print("[bold blue]Downloading DroidRun Portal APK...[/]")
+            apk_context = download_portal_apk(debug)
         else:
+            console.print(f"[bold blue]Using provided APK:[/] {path}")
+            apk_context = nullcontext(path)
+
+        with apk_context as apk_path:
+            if not os.path.exists(apk_path):
+                console.print(f"[bold red]Error:[/] APK file not found at {apk_path}")
+                return
+
+            console.print(f"[bold blue]Step 1/2: Installing APK:[/] {apk_path}")
+            try:
+                device_obj.install(apk_path, uninstall=True, flags=["-g"], silent=not debug)
+            except Exception as e:
+                console.print(f"[bold red]Installation failed:[/] {e}")
+                return
+
             console.print(f"[bold green]Installation successful![/]")
 
-        console.print(f"[bold blue]Step 2/2: Enabling accessibility service[/]")
+            console.print(f"[bold blue]Step 2/2: Enabling accessibility service[/]")
 
-        package = "com.droidrun.portal"
+            try:
+                enable_portal_accessibility(device_obj)
 
-        try:
-            await device_obj._adb.shell(
-                device,
-                "settings put secure enabled_accessibility_services com.droidrun.portal/com.droidrun.portal.DroidrunPortalService",
-            )
+                console.print("[green]Accessibility service enabled successfully![/]")
+                console.print(
+                    "\n[bold green]Setup complete![/] The DroidRun Portal is now installed and ready to use."
+                )
 
-            await device_obj._adb.shell(
-                device, "settings put secure accessibility_enabled 1"
-            )
+            except Exception as e:
+                console.print(
+                    f"[yellow]Could not automatically enable accessibility service: {e}[/]"
+                )
+                console.print(
+                    "[yellow]Opening accessibility settings for manual configuration...[/]"
+                )
+
+                device_obj.shell(
+                    "am start -a android.settings.ACCESSIBILITY_SETTINGS"
+                )
+
+                console.print(
+                    "\n[yellow]Please complete the following steps on your device:[/]"
+                )
+                console.print(
+                    f"1. Find [bold]{PORTAL_PACKAGE_NAME}[/] in the accessibility services list"
+                )
+                console.print("2. Tap on the service name")
+                console.print(
+                    "3. Toggle the switch to [bold]ON[/] to enable the service"
+                )
+                console.print("4. Accept any permission dialogs that appear")
+
+                console.print(
+                    "\n[bold green]APK installation complete![/] Please manually enable the accessibility service using the steps above."
+                )
 
-            console.print("[green]Accessibility service enabled successfully![/]")
-            console.print(
-                "\n[bold green]Setup complete![/] The DroidRun Portal is now installed and ready to use."
-            )
+    except Exception as e:
+        console.print(f"[bold red]Error:[/] {e}")
 
-        except Exception as e:
-            console.print(
-                f"[yellow]Could not automatically enable accessibility service: {e}[/]"
-            )
-            console.print(
-                "[yellow]Opening accessibility settings for manual configuration...[/]"
-            )
+        if debug:
+            import traceback
 
-            await device_obj._adb.shell(
-                device, "am start -a android.settings.ACCESSIBILITY_SETTINGS"
-            )
+            traceback.print_exc()
 
-            console.print(
-                "\n[yellow]Please complete the following steps on your device:[/]"
-            )
-            console.print(
-                f"1. Find [bold]{package}[/] in the accessibility services list"
-            )
-            console.print("2. Tap on the service name")
-            console.print("3. Toggle the switch to [bold]ON[/] to enable the service")
-            console.print("4. Accept any permission dialogs that appear")
 
-            console.print(
-                "\n[bold green]APK installation complete![/] Please manually enable the accessibility service using the steps above."
-            )
+@cli.command()
+@click.option("--device", "-d", help="Device serial number or IP address", default=None)
+@click.option(
+    "--debug", is_flag=True, help="Enable verbose debug logging", default=False
+)
+def ping(device: str | None, debug: bool):
+    """Ping a device to check if it is ready and accessible."""
+    try:
+        device_obj = adb.device(device)
+        if not device_obj:
+            console.print(f"[bold red]Error:[/] Could not find device {device}")
+            return
 
+        ping_portal(device_obj, debug)
+        console.print(
+            "[bold green]Portal is installed and accessible. You're good to go![/]"
+        )
     except Exception as e:
         console.print(f"[bold red]Error:[/] {e}")
-        import traceback
+        if debug:
+            import traceback
+
+            traceback.print_exc()
+
 
-        traceback.print_exc()
+# Add macro commands as a subgroup
+cli.add_command(macro_cli, name="macro")
 
 
 if __name__ == "__main__":
@@ -481,9 +570,11 @@ if __name__ == "__main__":
     reflection = False
     tracing = True
     debug = True
+    use_tcp = True
     base_url = None
     api_base = None
     ios = False
+    allow_drag = False
     run_command(
         command=command,
         device=device,
@@ -496,8 +587,10 @@ if __name__ == "__main__":
         reflection=reflection,
         tracing=tracing,
         debug=debug,
+        use_tcp=use_tcp,
         base_url=base_url,
         api_base=api_base,
         api_key=api_key,
-        ios=ios
+        allow_drag=allow_drag,
+        ios=ios,
     )

droidrun/macro/__init__.py

@@ -0,0 +1,14 @@
+"""
+DroidRun Macro Module - Record and replay UI automation sequences.
+
+This module provides functionality to replay macro sequences that were
+recorded during DroidAgent execution.
+"""
+
+from .replay import MacroPlayer, replay_macro_file, replay_macro_folder
+
+__all__ = [
+    "MacroPlayer",
+    "replay_macro_file", 
+    "replay_macro_folder"
+] 

droidrun/macro/__main__.py

@@ -0,0 +1,10 @@
+"""
+Entry point for running DroidRun macro CLI as a module.
+
+Usage: python -m droidrun.macro <command>
+"""
+
+from droidrun.macro.cli import macro_cli
+
+if __name__ == "__main__":
+    macro_cli()