Droidline README

README проекта с github.com/KnifeLemon/Droidline. Одним файлом markdown: README.md.

Droidline: Android automation, one line at a time.

Automate real Android phones from your code.
Test your apps, script the tasks you repeat, run a shelf of phones, or let an AI agent use one.
Python, Node.js, the shell or HTTP. No ADB, no USB cable, no root.

Website · Docs · Download · Sponsor · Quick start · Languages · Guides

CI Latest release Android 9 or later Windows, macOS and Linux MIT license

English · 한국어 · 简体中文

No ADB, no cable
Install one app on the phone, turn on its permissions and pair it with a QR code. No developer options, no USB debugging, no root.
The same command everywhere
touch is touch in Python, Node.js, the CLI, HTTP and as an MCP tool, all generated from one spec.
Phones anywhere
The phone connects out to your PC, so it works on the same Wi-Fi or on mobile data through a tunnel or a relay you run. Every line is encrypted end to end.

What people use it for

Droidline uses only permissions an ordinary app can get, so a few things are out of reach: see What it cannot do.

See it in action

A script sends six lines to a phone: launch the demo app, close the ad, type an email, tick Keep me signed in, tap Log in, and wait for the main screen. Each line gets a reply with how the tap was delivered, and the phone screen changes to match.
Try the same demo in your browser, and pick elements on a simulated screen, on droidline.dev

Quick start

You need a PC (Windows, macOS or Linux) and an Android phone with Android 9 or later, on the same Wi-Fi for a first try. The installation guide walks through each step with screenshots.

  1. Run the server on your PC. Download the droidline archive for your system from Releases, put droidline on your PATH, and start it. Leave it running.

    droidline serve
    
  2. Install the app on the phone. Download droidline-agent.apk from the same release page and open it. On the app's Setup tab, turn on the accessibility service, the Droidline keyboard, notifications and unrestricted battery use. On Android 13 and later, allow restricted settings for the app first; the app shows where.

  3. Pair them. Run this on the PC and scan the QR code with the app's Pair tab:

    droidline pair
    

    No camera? Tap Pair on this Wi-Fi in the app and type the 6-digit code it shows: droidline pair 482913.

  4. Send a command.

    droidline launch com.android.settings
    droidline touch text "Network & internet"
    

No phone at hand? droidline-fakephone, included in every release, simulates one with a small demo app. The first-script tutorial builds a complete login script against it.

Use it from your language

Every interface talks to droidline serve on localhost:8780 and uses the same command names.

Python (pip install droidline, Python 3.9+)

from droidline import connect

d = connect()                                  # the phone paired with this PC
d.launch("dev.droidline.demo")
if d.exists("text", "Close ad"):               # conditions never wait and never fail
    d.touch("text", "Close ad")
d.input("id", "email", "knife")                # waits up to 10 s for the element
d.touch("text", "Log in")
print(d.get_text("id", "greeting"))

Node.js and TypeScript (npm install droidline, Node.js 18+)

import { connect } from "droidline";

const d = await connect();
await d.launch("dev.droidline.demo");
await d.input("id", "email", "knife");
await d.touch("text", "Log in", { timeout: 15 });
console.log(await d.getText("id", "greeting"));

C# and .NET (dotnet add package Droidline, .NET 8+ or .NET Framework 4.6.2+)

using Droidline;

await using var d = await DroidlineClient.ConnectAsync();
await d.LaunchAsync("dev.droidline.demo");
await d.InputAsync("id", "email", "knife");
await d.TouchAsync("text", "Log in", timeout: 15);
Console.WriteLine(await d.GetTextAsync("id", "greeting"));

Command line (comes with the server)

droidline touch text "Log in"
droidline which text="Log in" id=main_tab --timeout 15
droidline screenshot shot.png

HTTP (any language, any tool)

curl -s -X POST localhost:8780/devices/_/touch \
  -H 'content-type: application/json' -d '{"by":"text","value":"Log in"}'

AI agents over MCP (Claude, Cursor, VS Code and others)

{ "mcpServers": { "droidline": { "command": "droidline", "args": ["mcp"] } } }

With Claude Code: claude mcp add droidline -- droidline mcp. In Claude Desktop you can instead open droidline.mcpb from Releases, which carries its own droidline; it is also listed in the MCP Registry as io.github.KnifeLemon/droidline. To give an agent fewer tools, add --tools dump,screenshot,touch or --read-only to the args; see Limit what an agent can use. Other languages can open a TCP socket and send one JSON line per command; see Other languages for Go, Java and PHP.

Features

Screenshots

Setup tab with every permission switched on Pair tab after pairing with a PC Status tab of a connected phone with its route and permissions
Setup: each permission with a button to its settings screen Pair: scan the QR code or use a 6-digit code Status: connection, route and permissions

Reach phones anywhere

The phone always opens the connection, so it needs no open port. Pick the route that fits your network; the phone tries them in order and returns to Wi-Fi when it can.

Route You need How it works
Same Wi-Fi Nothing The phone finds the PC with a UDP broadcast and connects directly.
Port forward One forwarded port The phone connects to your public address over TLS, pinned to the PC's certificate.
Tunnel cloudflared, ngrok or similar Your PC keeps a tunnel open; the phone reaches it through the tunnel's address.
Your relay Cloudflare Workers or a VPS PC and phone both connect out to a relay you deploy. It forwards lines it cannot read.

Past the two-line handshake every line is encrypted with keys only your PC and phone hold (P-256 and AES-256-GCM), so a tunnel or relay only carries ciphertext. The remote connection guides cover each route step by step.

What it cannot do

Droidline only uses permissions an ordinary app can get, so some things are out of reach. Better to know before you start:

The full list explains each one.

Documentation

I want to… Start here
Install everything step by step Installation
Write a first script without a phone Your first script
Use my language Python · Node.js · CLI · HTTP · AI agents
Find the right element on a screen Finding elements
Open apps, links and Settings pages, or list what is installed Apps
Point at elements, or record a script Inspector and recorder
Run Appium scripts Appium and WebDriver
Test with pytest or Node.js Test frameworks
Copy a working pattern Recipes
Look up a command Command reference
Reach phones on mobile data Remote phones
Fix something that does not work Troubleshooting
Understand the wire format spec/PROTOCOL.md

Build from source

Requirements: Go 1.26+, Node.js 22, Python 3.9+, and for the app, JDK 17+ with the Android SDK (Android Studio's bundled JDK works).

git clone https://github.com/KnifeLemon/Droidline.git
cd Droidline
go build ./server/cmd/...              # droidline, droidline-relay, droidline-fakephone
go test ./spec/ ./server/...
node scripts/gen.mjs --check           # SDK methods match spec/commands.json
cd sdk/python && python -m pytest
cd sdk/node && npm ci && npm test
dotnet test sdk/dotnet
cd agent && ./gradlew assembleDebug testDebugUnitTest

scripts/integration.sh runs the server, the simulated phone and both SDK demos together, which is what CI does.

Path What it is
spec/ commands.json (every command, in three languages), PROTOCOL.md, crypto test vectors
server/ Go: droidline (server, CLI, MCP), droidline-relay, droidline-fakephone
agent/ The Android app, in Kotlin
sdk/python, sdk/node, sdk/dotnet Official SDKs, generated from the spec plus a thin client
relay/worker A relay for Cloudflare Workers
examples/ Demo scripts that run against the simulated phone

Contributing

Pull requests are welcome; CONTRIBUTING.md explains how the spec, generator and tests fit together. The most useful contribution right now is a report from a real phone: which brand and Android version, and whether the Settings recipes for force stop, clearing data and the network switches work with its labels. If Droidline saves you some taps, a ⭐ helps other people find it.

Status

Version 0.1. The server, CLI, MCP adapter, relay and both SDKs pass their tests against the phone simulator, and the app passes its unit tests and runs on an Android 13 emulator. Testing across phone brands is the next step. docs/STATUS.md lists exactly what has been verified and how.

Security and privacy

Pairing decides who may control a phone, and everything after the handshake is encrypted end to end. Report security problems privately as described in SECURITY.md.

Droidline collects no usage data and sends no telemetry. The server listens on your own machine; the app talks only to the PC it is paired with, and to GitHub once a day to check for a new release. Use Droidline on phones and accounts you own or may automate; the terms say what it is for.

License

MIT. See LICENSE.

Star history

Droidline (KnifeLemon/Droidline)

Ищем в базе…

Что это такое?Droidline позволяет автоматизировать реальные Android-телефоны из вашего собственного кода: пишите скрипты на Python, Node.js, C#, через CLI, HTTP или как инструмент MCP, чтобы нажимать, вводить текст, считывать и отслеживать экран телефона. Не нужны кабель ADB, отладка по USB и root-доступ.
Это библиотека или отдельный сервер?Это небольшой сервер на Go (droidline serve), который вы запускаете на своём ПК в паре с приложением-агентом на телефоне. Интерфейсы Python, Node.js, C#, CLI и HTTP — это лишь клиенты, которые общаются с тем же сервером. Кроме того, сервер предоставляет инструмент MCP для ИИ-агентов.
Как его запустить?Запустите исполняемый файл сервера droidline из Releases на ПК, установите droidline-agent.apk на телефон и включите на нём службу специальных возможностей и нужные разрешения. Затем свяжите их, отсканировав QR-код или введя 6-значный код, и начинайте отправлять команды.
Что нужно на самом телефоне?Только приложение Droidline на телефоне с Android 9+ с включёнными службой специальных возможностей, клавиатурой и доступом к уведомлениям. Параметры разработчика и отладка по USB не нужны.
Что он не умеет?Он не может разблокировать экран блокировки, открыть закрытые для других приложений экраны или принудительно остановить приложение, очистить его данные либо переключить сеть одной встроенной командой. Эти действия выполняются нажатием кнопок в «Настройках» через рецепты. Игры с интерфейсом, нарисованным самой игрой, требуют нажатий по координатам.
Работает ли сервер на любом компьютере и с любым телефоном?Исполняемый файл сервера работает на Windows, macOS или Linux. Он управляет Android-телефонами версии 9 и новее, доступными по той же Wi-Fi сети, через туннель или через ретранслятор, который вы развёртываете самостоятельно.
Шифруется ли соединение между ПК и телефоном и отправляет ли Droidline данные о себе?Каждая строка после сопряжения шифруется сквозным шифрованием с помощью P-256 и AES-256-GCM. Droidline не собирает данные об использовании и телеметрию, а лишь раз в день проверяет на GitHub наличие новой версии.
Может ли ИИ-агент реально управлять телефоном через это?Да, Droidline поставляется с инструментом MCP, чтобы такие агенты, как Claude, ChatGPT или Cursor, могли считывать экран в виде дерева элементов через dump() и действовать на его основе. Можно ограничить их возможности флагами, например --tools или --read-only.
Могу ли я запустить сразу целый парк телефонов?Да, один ПК может управлять «полкой с телефонами»: команды для одного телефона выполняются по порядку, а разные телефоны работают параллельно. У каждого есть своё имя и, если нужно, отдельный прокси для каждого приложения.
Как подключиться к телефону, который не в моей Wi-Fi сети?Телефон всегда сам инициирует соединение, поэтому всё работает через проброшенный порт, туннель вроде cloudflared или ngrok либо ретранслятор, который вы развёртываете самостоятельно на Cloudflare Workers или VPS. Если доступен Wi-Fi, соединение переходит на него.
Что будет, если телефон потеряет сеть во время команды?Телефон продолжит работу ровно с того места, где остановился, а выполнявшаяся команда получит ответ из кэша вместо повторного запуска. Благодаря этому многошаговое действие, например переключение режима полёта, работает как один надёжный вызов.
Какие есть похожие проекты?prod-FARM-IOS-Core, mobile-mcp, appium, artemis, andee, buddy-android, dsh-ios, dsh-android
Автор
KnifeLemon
Размер
2.8 MB
Звёзды
550
Возраст
1 мес
Коммиты · 90 дней