u2-cli 0.1.0__tar.gz

u2_cli-0.1.0/.github/workflows/pypi.yml

@@ -0,0 +1,52 @@
+# This workflow will upload a Python Package to PyPI when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: PyPI
+
+on:
+  push:
+    tags: [ 'v*.*.*' ]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  release-build-and-publish-pypi:
+    runs-on: ubuntu-latest
+
+    environment:
+      name: pypi
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: "Set up Python"
+        uses: actions/setup-python@v6
+        with:
+          python-version-file: "pyproject.toml"
+
+      - name: Install the project
+        run: uv sync --all-extras --dev
+
+      - name: Build release distributions
+        run: uv build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v7
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish PyPI
+        env:
+          UV_PUBLISH_TOKEN: ${{ secrets.UV_PUBLISH_TOKEN }}
+        run: uv publish

u2_cli-0.1.0/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

u2_cli-0.1.0/CLAUDE.md

@@ -0,0 +1,61 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Overview
+
+`u2-cli` is a CLI tool wrapping [uiautomator2](https://github.com/openatx/uiautomator2) to control Android devices, designed for use by AI agents.
+
+## Commands
+
+```bash
+# Install deps and activate env
+uv sync
+
+# Run CLI during development (no install needed)
+uv run src/u2/__init__.py <cmd>
+
+# Run after installing as a package
+uv run u2 <cmd>
+
+# Lint
+uv run ruff check .
+uv run ruff format .
+
+# Build for PyPI
+uv build
+```
+
+## Architecture
+
+All CLI commands output JSON: `{"success": bool, "output": str, "code": str}` where `code` is the uiautomator2 Python expression that was executed, example: `d(text='Hello').click()`, `d.shell('ls')`.
+
+The CLI is built with [Typer](https://typer.tiangolo.com/) and organized into sub-apps:
+
+```
+src/u2/
+├── __init__.py    # Root app, State dataclass, global --serial/-s flag, main()
+├── device.py      # device sub-app: info, battery, wlan-ip, shell, keyevent, push, pull, screen-on, screen-off, orientation
+├── app.py         # app sub-app: start, stop, install, uninstall, clear, list, current, wait-activity
+├── screen.py      # screen sub-app: screenshot, dump, size, brightness
+├── interact.py    # interact sub-app: tap, long-tap, swipe, drag, type, clear
+├── element.py     # element sub-app: find, wait, exists, get-text, set-text, tap, long-tap (selector-based)
+└── watch.py       # watch sub-app: add, remove, list, run (uiautomator2 Watcher)
+```
+
+**Sub-app responsibilities:**
+
+- `device` — physical device state and low-level operations: device info, battery, IP, adb shell, key events (`home`, `back`, `power`, etc.), file push/pull, screen on/off, rotation
+- `app` — app lifecycle: install/uninstall APK, start/stop by package, clear data, list installed apps, get current foreground app, wait for a target activity
+- `screen` — visual state: screenshot (PNG to stdout or file), XML hierarchy dump, screen size, brightness
+- `interact` — coordinate-based input: tap, long-tap, swipe (from/to coords), drag, send text to focused element, clear focused text
+- `element` — selector-based element interaction: find elements by `text`, `resourceId`, `className`, `xpath`, `description`; check existence; get/set text; tap or long-tap matched elements
+- `watch` — register/run UI watchers that auto-click or trigger actions when a matching element appears
+
+**Global state:** The `--serial`/`-s` flag (Android device serial) is stored in a module-level `State` dataclass in `__init__.py`. Sub-command modules access it via `from u2 import state`.
+
+**Entry point:** `u2 = "u2:main"` in `pyproject.toml`.
+
+## Linting
+
+Ruff is configured with `FBT` rules enabled — boolean positional arguments in function signatures trigger warnings. Typer-style boolean CLI options require `# noqa: FBT001/FBT002` suppressions.

u2_cli-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Lanbao
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

u2_cli-0.1.0/PKG-INFO

@@ -0,0 +1,12 @@
+Metadata-Version: 2.4
+Name: u2-cli
+Version: 0.1.0
+Summary: CLI tool for executing uiautomator2 commands to control Android devices from the AI Agent
+License-File: LICENSE
+Requires-Python: >=3.12
+Requires-Dist: typer>=0.24.1
+Requires-Dist: uiautomator2>=3.5.0
+Description-Content-Type: text/markdown
+
+# u2-cli
+CLI tool for executing uiautomator2 commands to control Android devices from the AI Agent

u2_cli-0.1.0/README.md

@@ -0,0 +1,2 @@
+# u2-cli
+CLI tool for executing uiautomator2 commands to control Android devices from the AI Agent

u2_cli-0.1.0/pyproject.toml

@@ -0,0 +1,32 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "u2-cli"
+version = "0.1.0"
+description = "CLI tool for executing uiautomator2 commands to control Android devices from the AI Agent"
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = [
+    "typer>=0.24.1",
+    "uiautomator2>=3.5.0",
+]
+
+[project.scripts]
+u2 = "u2:main"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/u2"]
+
+[tool.ruff]
+line-length = 100
+
+[tool.ruff.lint]
+select = ["E", "F", "FBT"]
+ignore = ["FBT003"]
+
+[dependency-groups]
+dev = [
+    "ruff>=0.15.6",
+]

u2_cli-0.1.0/skills/u2-cli/SKILL.md

@@ -0,0 +1,159 @@
+---
+name: u2-cli
+description: Use this skill when the user wants to control an Android device using the u2-cli tool. Triggers when: controlling an Android device via CLI, automating Android UI interactions, using uiautomator2 from the command line, finding/tapping/swiping UI elements on Android, taking screenshots or dumping UI hierarchy, managing Android apps, or running adb-based device operations through u2.
+---
+
+# u2-cli Skill
+
+You are helping the user control an Android device using `u2-cli`, a CLI tool wrapping uiautomator2.
+
+The complete command reference is in [references/commands.md](references/commands.md). Always consult it for exact syntax, flags, and defaults.
+
+Install:
+
+```bash
+uv pip install u2-cli
+```
+
+## Core Workflow
+
+### 1. Orient yourself
+
+Before interacting with the device, understand its current state:
+
+```bash
+u2 screen dump --simplify          # Get UI hierarchy as compact JSON
+u2 screen screenshot /tmp/sc.png   # Take a screenshot for visual context
+u2 app current                     # See what app is in foreground
+```
+
+Use `screen dump --simplify` as your primary tool for understanding what's on screen — it produces a compact JSON tree with pruned noise, shortened class names, and only the relevant attributes.
+
+### 2. Find elements before acting on them
+
+Verify elements exist before tapping or typing:
+
+```bash
+u2 element exists --text "Login"
+u2 element find --xpath "//android.widget.Button"
+u2 element wait --resource-id com.example:id/submit --timeout 5
+```
+
+### 3. Prefer `element` commands over coordinate `interact` commands
+
+Use selector-based `element tap/long-tap` when you can identify elements by text, resource-id, or xpath. Fall back to `interact tap <x> <y>` only when no selector is available.
+
+### 4. Parse output correctly
+
+All commands return JSON:
+```json
+{"success": true, "output": "...", "code": "d(text='Login').click()"}
+```
+
+Check `success` before proceeding. The `output` field contains the actual data (parse as JSON if it's a list/dict). The `code` field shows what uiautomator2 expression ran.
+
+---
+
+## Common Tasks
+
+### Navigate the UI
+
+```bash
+u2 device keyevent back           # Press Back
+u2 device keyevent home           # Press Home
+u2 interact swipe 540 1500 540 500 --duration 0.3   # Scroll up
+u2 interact swipe 540 500 540 1500 --duration 0.3   # Scroll down
+```
+
+### Tap an element
+
+```bash
+# By text
+u2 element tap --text "Sign In"
+
+# By resource ID
+u2 element tap --resource-id com.example:id/btn_login
+
+# By XPath
+u2 element tap --xpath "//android.widget.Button[@text='OK']"
+
+# By coordinates (fallback)
+u2 interact tap 540 960
+```
+
+### Type text
+
+```bash
+# Tap the input field first, then type
+u2 element tap --resource-id com.example:id/email_input
+u2 interact type "user@example.com"
+
+# Or set text directly on an element
+u2 element set-text "user@example.com" --resource-id com.example:id/email_input
+```
+
+### Launch an app
+
+```bash
+# Start fresh (stop + start)
+u2 app start com.example.app --stop --wait
+
+# Wait for specific activity to load
+u2 app wait-activity .MainActivity --timeout 15
+```
+
+### Handle popups automatically
+
+```bash
+# Block for 30s, auto-click any "Allow" button that appears
+u2 watch add allow-popup --xpath "//android.widget.Button[@text='Allow']" --timeout 30
+
+# One-shot: trigger immediately if a dialog is currently visible
+u2 watch run --xpath "//android.widget.Button[@text='OK']"
+```
+
+### Capture screen state
+
+```bash
+# Screenshot to file
+u2 screen screenshot /tmp/screen.png
+
+# Screenshot to stdout (pipe to viewer/tool)
+u2 screen screenshot | display
+
+# UI hierarchy for AI analysis
+u2 screen dump --simplify
+```
+
+---
+
+## Strategy for Autonomous Tasks
+
+When given a multi-step task (e.g., "fill in this form", "open settings and enable X"):
+
+1. **Dump the screen** with `screen dump --simplify` to understand current state
+2. **Plan the steps** based on what elements are visible
+3. **Act step by step**, checking success after each command
+4. **Re-dump** after navigation or significant UI changes
+5. **Use `element wait`** before acting when a screen transition is expected
+
+If an element isn't found, try:
+- `element find` with a broader selector to explore what's on screen
+- `screen dump --simplify` to re-check the current UI state
+- Scrolling with `interact swipe` and then retrying
+
+---
+
+## Device Selection
+
+When multiple devices are connected, prefix all commands with `-s SERIAL`:
+
+```bash
+u2 -s emulator-5554 screen dump --simplify
+u2 -s R3CN10XXXXX element tap --text "Login"
+```
+
+Get available devices with:
+```bash
+adb devices
+```

u2_cli-0.1.0/skills/u2-cli/references/commands.md

@@ -0,0 +1,130 @@
+# u2-cli Command Reference
+
+## Global Options
+
+Applies to every command:
+
+```
+u2 [-s SERIAL] <sub-app> <command> [args]
+```
+
+| Flag | Short | Type | Description |
+|------|-------|------|-------------|
+| `--serial` | `-s` | `str` | Android device serial (required when multiple devices connected) |
+
+**Output format (all commands):**
+```json
+{"success": bool, "output": str, "code": str}
+```
+- `success` — whether the operation succeeded
+- `output` — result data or error message
+- `code` — the uiautomator2 Python expression that was executed
+
+---
+
+## `device` sub-app
+
+Physical device state and low-level operations.
+
+| Command | Args | Description |
+|---------|------|-------------|
+| `device info` | — | Returns `d.device_info` dict |
+| `device battery` | — | Returns battery info dict |
+| `device wlan-ip` | — | Returns WLAN IP string |
+| `device shell <cmd>` | `cmd: str` | Run adb shell command, returns stdout |
+| `device keyevent <key>` | `key: str` | Send key event (e.g. `home`, `back`, `power`) |
+| `device push <src> <dst>` | `src: str`, `dst: str` | Push local file to device |
+| `device pull <src> <dst>` | `src: str`, `dst: str` | Pull file from device |
+| `device screen-on` | — | Turn screen on |
+| `device screen-off` | — | Turn screen off |
+| `device orientation [value]` | `value?: natural\|left\|right\|upsidedown` | Get or set orientation |
+
+---
+
+## `app` sub-app
+
+App lifecycle management.
+
+| Command | Args / Flags | Description |
+|---------|-------------|-------------|
+| `app start <package>` | `--activity/-a str`, `--wait bool`, `--stop bool` | Launch app, optionally stopping first and waiting |
+| `app stop <package>` | `package: str` | Stop app by package name |
+| `app install <path>` | `path: str` | Install APK from path or URL |
+| `app uninstall <package>` | `package: str` | Uninstall app |
+| `app clear <package>` | `package: str` | Clear app data |
+| `app list` | `--filter/-f str` (`-3` third-party, `-s` system, `-d` disabled, `-e` enabled) | List installed packages |
+| `app current` | — | Returns current foreground app (package, activity, pid) |
+| `app wait-activity <activity>` | `--timeout/-t float` (default: 10.0) | Wait for activity to appear; `success` reflects result |
+
+---
+
+## `screen` sub-app
+
+Visual state capture.
+
+| Command | Args / Flags | Description |
+|---------|-------------|-------------|
+| `screen screenshot [path]` | `path?: str` | Save PNG to file (JSON output), or omit to write raw PNG bytes to stdout |
+| `screen dump` | `--compressed bool`, `--pretty bool`, `--simplify/-s bool` | Dump UI hierarchy as XML or simplified JSON |
+| `screen size` | — | Returns screen size as `WxH` string (e.g. `1080x2340`) |
+| `screen brightness [value]` | `value?: int (0–255)` | Get or set screen brightness |
+
+**`screen dump --simplify`** returns compact JSON tree with pruned/collapsed nodes:
+- Keys: `type`, `text`, `desc`, `id`, `bounds`, plus boolean flags (`clickable`, `scrollable`, etc.) only when `true`, plus `children`
+- Class names are shortened (e.g. `TextView` → `text`)
+
+---
+
+## `interact` sub-app
+
+Coordinate-based input actions.
+
+| Command | Args / Flags | Description |
+|---------|-------------|-------------|
+| `interact tap <x> <y>` | `x: int`, `y: int` | Tap at coordinates |
+| `interact long-tap <x> <y>` | `x: int`, `y: int`, `--duration/-d float` (default: 0.5) | Long press at coordinates |
+| `interact swipe <fx> <fy> <tx> <ty>` | from/to coords, `--duration/-d float` (default: 0.5) | Swipe between two points |
+| `interact drag <sx> <sy> <ex> <ey>` | start/end coords, `--duration/-d float` (default: 0.5) | Drag between two points |
+| `interact type <text>` | `text: str` | Type text into focused element (clipboard paste, supports Unicode/Chinese) |
+| `interact clear` | — | Clear text in focused element |
+
+---
+
+## `element` sub-app
+
+Selector-based element interaction. At least one selector required per command.
+
+**Shared selector options:**
+
+| Flag | Short | Description |
+|------|-------|-------------|
+| `--text` | `-t` | Element text |
+| `--resource-id` | `-r` | Resource ID |
+| `--class-name` | `-c` | Class name |
+| `--xpath` | `-x` | XPath expression (uses `d.xpath(...)` path) |
+| `--description` | `-d` | Content description |
+
+Multiple non-xpath selectors can be combined. XPath takes a separate code path.
+
+| Command | Extra Flags | Description |
+|---------|------------|-------------|
+| `element find` | `--timeout/-T float` (default: 0.0) | Find elements, returns JSON array of element info dicts |
+| `element wait` | `--timeout/-T float` (default: 10.0) | Wait for element; `success` reflects result |
+| `element exists` | — | `output` is `"true"` or `"false"` |
+| `element get-text` | `--timeout/-T float` (default: 10.0) | Returns element's text in `output` |
+| `element set-text <value>` | `value: str`, `--timeout/-T float` (default: 10.0) | Set element text |
+| `element tap` | `--timeout/-T float` (default: 10.0) | Tap matched element |
+| `element long-tap` | `--duration/-D float` (default: 0.5), `--timeout/-T float` (default: 10.0) | Long-tap matched element |
+
+---
+
+## `watch` sub-app
+
+UI watchers that auto-trigger actions when a matching element appears.
+
+| Command | Args / Flags | Description |
+|---------|-------------|-------------|
+| `watch add <name>` | `--xpath/-x str` (required), `--action/-a str` (default: `click`), `--timeout/-t float` (default: 30.0) | Register watcher, start it, block for timeout, then stop. Actions: `click`, `back`, `home`, `recent` |
+| `watch remove <name>` | `name: str` (use `__all__` to remove all) | Remove watcher (in-memory, same process only) |
+| `watch list` | — | Returns whether watcher loop is running |
+| `watch run` | `--xpath/-x str` (required), `--action/-a str` (default: `click`) | One-shot: register `__run__` watcher, fire once, remove it. `success` reflects whether it triggered |