Command reference

d.dump("screen.json")   # saved on your PC

await d.dump("screen.json");   // saved on your PC

droidline dump screen.json

curl -s -X POST localhost:8780/devices/_/dump \
  -H 'content-type: application/json' > screen.json

{"id":1,"cmd":"dump"}

d.screenshot("shot.png")   # saved on your PC

await d.screenshot("shot.png");   // saved on your PC

droidline screenshot shot.png

curl -s localhost:8780/devices/_/screenshot.png -o shot.png

{"id":1,"cmd":"screenshot"}

d.current()

await d.current();

droidline current

curl -s -X POST localhost:8780/devices/_/current \
  -H 'content-type: application/json'

{"id":1,"cmd":"current"}

d.tap(540, 1200)

await d.tap(540, 1200);

droidline tap 540 1200

curl -s -X POST localhost:8780/devices/_/tap \
  -H 'content-type: application/json' \
  -d '{"x":540,"y":1200}'

{"id":1,"cmd":"tap","x":540,"y":1200}

d.long_tap(540, 1200, 800)

await d.longTap(540, 1200, 800);

droidline long_tap 540 1200 800

curl -s -X POST localhost:8780/devices/_/long_tap \
  -H 'content-type: application/json' \
  -d '{"x":540,"y":1200,"ms":800}'

{"id":1,"cmd":"long_tap","x":540,"y":1200,"ms":800}

d.swipe(540, 1600, 540, 400, 300)

await d.swipe(540, 1600, 540, 400, 300);

droidline swipe 540 1600 540 400 300

curl -s -X POST localhost:8780/devices/_/swipe \
  -H 'content-type: application/json' \
  -d '{"x1":540,"y1":1600,"x2":540,"y2":400,"ms":300}'

{"id":1,"cmd":"swipe","x1":540,"y1":1600,"x2":540,"y2":400,"ms":300}

d.touch("text", "Log in")

await d.touch("text", "Log in");

droidline touch text "Log in"

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

{"id":1,"cmd":"touch","by":"text","value":"Log in"}

d.long_touch("text", "Message")

await d.longTouch("text", "Message");

droidline long_touch text Message

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

{"id":1,"cmd":"long_touch","by":"text","value":"Message"}

d.scroll_to("text", "Settings")

await d.scrollTo("text", "Settings");

droidline scroll_to text Settings

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

{"id":1,"cmd":"scroll_to","by":"text","value":"Settings"}

d.input("id", "email", "me@example.com")

await d.input("id", "email", "me@example.com");

droidline input id email me@example.com

curl -s -X POST localhost:8780/devices/_/input \
  -H 'content-type: application/json' \
  -d '{"by":"id","value":"email","text":"me@example.com"}'

{"id":1,"cmd":"input","by":"id","value":"email","text":"me@example.com"}

d.clear("id", "email")

await d.clear("id", "email");

droidline clear id email

curl -s -X POST localhost:8780/devices/_/clear \
  -H 'content-type: application/json' \
  -d '{"by":"id","value":"email"}'

{"id":1,"cmd":"clear","by":"id","value":"email"}

d.sendkey("enter")

await d.sendkey("enter");

droidline sendkey enter

curl -s -X POST localhost:8780/devices/_/sendkey \
  -H 'content-type: application/json' \
  -d '{"key":"enter"}'

{"id":1,"cmd":"sendkey","key":"enter"}

d.exists("text", "Close ad")

await d.exists("text", "Close ad");

droidline exists text "Close ad"

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

{"id":1,"cmd":"exists","by":"text","value":"Close ad"}

d.wait("text", "Done", timeout=30)

await d.wait("text", "Done", { timeout: 30 });

droidline wait text Done --timeout 30

curl -s -X POST localhost:8780/devices/_/wait \
  -H 'content-type: application/json' \
  -d '{"by":"text","value":"Done","timeout":30}'

{"id":1,"cmd":"wait","by":"text","value":"Done","timeout":30}

d.wait_gone("text", "Loading")

await d.waitGone("text", "Loading");

droidline wait_gone text Loading

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

{"id":1,"cmd":"wait_gone","by":"text","value":"Loading"}

d.get_text("id", "balance")

await d.getText("id", "balance");

droidline get_text id balance

curl -s -X POST localhost:8780/devices/_/get_text \
  -H 'content-type: application/json' \
  -d '{"by":"id","value":"balance"}'

{"id":1,"cmd":"get_text","by":"id","value":"balance"}

d.checked("id", "auto_login")

await d.checked("id", "auto_login");

droidline checked id auto_login

curl -s -X POST localhost:8780/devices/_/checked \
  -H 'content-type: application/json' \
  -d '{"by":"id","value":"auto_login"}'

{"id":1,"cmd":"checked","by":"id","value":"auto_login"}

d.enabled("text", "Next")

await d.enabled("text", "Next");

droidline enabled text Next

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

{"id":1,"cmd":"enabled","by":"text","value":"Next"}

d.selected("text", "Home")

await d.selected("text", "Home");

droidline selected text Home

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

{"id":1,"cmd":"selected","by":"text","value":"Home"}

d.count("class", "android.widget.CheckBox")

await d.count("class", "android.widget.CheckBox");

droidline count class android.widget.CheckBox

curl -s -X POST localhost:8780/devices/_/count \
  -H 'content-type: application/json' \
  -d '{"by":"class","value":"android.widget.CheckBox"}'

{"id":1,"cmd":"count","by":"class","value":"android.widget.CheckBox"}

d.which([("text", "Log in"), ("id", "main_tab")], timeout=15)

await d.which([["text", "Log in"], ["id", "main_tab"]], { timeout: 15 });

droidline which text="Log in" id=main_tab --timeout 15

curl -s -X POST localhost:8780/devices/_/which \
  -H 'content-type: application/json' \
  -d '{"candidates":[["text","Log in"],["id","main_tab"]],"timeout":15}'

{"id":1,"cmd":"which","candidates":[["text","Log in"],["id","main_tab"]],"timeout":15}

d.in_app("com.android.chrome")

await d.inApp("com.android.chrome");

droidline in_app com.android.chrome

curl -s -X POST localhost:8780/devices/_/in_app \
  -H 'content-type: application/json' \
  -d '{"package":"com.android.chrome"}'

{"id":1,"cmd":"in_app","package":"com.android.chrome"}

d.keyboard_shown()

await d.keyboardShown();

droidline keyboard_shown

curl -s -X POST localhost:8780/devices/_/keyboard_shown \
  -H 'content-type: application/json'

{"id":1,"cmd":"keyboard_shown"}

d.last_toast()

await d.lastToast();

droidline last_toast

curl -s -X POST localhost:8780/devices/_/last_toast \
  -H 'content-type: application/json'

{"id":1,"cmd":"last_toast"}

d.color(540, 1200)

await d.color(540, 1200);

droidline color 540 1200

curl -s -X POST localhost:8780/devices/_/color \
  -H 'content-type: application/json' \
  -d '{"x":540,"y":1200}'

{"id":1,"cmd":"color","x":540,"y":1200}

d.screen_on()

await d.screenOn();

droidline screen_on

curl -s -X POST localhost:8780/devices/_/screen_on \
  -H 'content-type: application/json'

{"id":1,"cmd":"screen_on"}

d.locked()

await d.locked();

droidline locked

curl -s -X POST localhost:8780/devices/_/locked \
  -H 'content-type: application/json'

{"id":1,"cmd":"locked"}

d.wake()

await d.wake();

droidline wake

curl -s -X POST localhost:8780/devices/_/wake \
  -H 'content-type: application/json'

{"id":1,"cmd":"wake"}

d.lock()

await d.lock();

droidline lock

curl -s -X POST localhost:8780/devices/_/lock \
  -H 'content-type: application/json'

{"id":1,"cmd":"lock"}

d.battery()

await d.battery();

droidline battery

curl -s -X POST localhost:8780/devices/_/battery \
  -H 'content-type: application/json'

{"id":1,"cmd":"battery"}

d.orientation()

await d.orientation();

droidline orientation

curl -s -X POST localhost:8780/devices/_/orientation \
  -H 'content-type: application/json'

{"id":1,"cmd":"orientation"}

d.info()

await d.info();

droidline info

curl -s -X POST localhost:8780/devices/_/info \
  -H 'content-type: application/json'

{"id":1,"cmd":"info"}

d.network()

await d.network();

droidline network

curl -s -X POST localhost:8780/devices/_/network \
  -H 'content-type: application/json'

{"id":1,"cmd":"network"}

d.proxy("@kr1", app="com.android.chrome")

await d.proxy("@kr1", { app: "com.android.chrome" });

droidline proxy @kr1 --app com.android.chrome

curl -s -X POST localhost:8780/devices/_/proxy \
  -H 'content-type: application/json' \
  -d '{"url":"@kr1","app":"com.android.chrome"}'

{"id":1,"cmd":"proxy","url":"@kr1","app":"com.android.chrome"}

d.proxy_check("com.android.chrome")

await d.proxyCheck("com.android.chrome");

droidline proxy_check com.android.chrome

curl -s -X POST localhost:8780/devices/_/proxy_check \
  -H 'content-type: application/json' \
  -d '{"app":"com.android.chrome"}'

{"id":1,"cmd":"proxy_check","app":"com.android.chrome"}

d.launch("com.android.settings")

await d.launch("com.android.settings");

droidline launch com.android.settings

curl -s -X POST localhost:8780/devices/_/launch \
  -H 'content-type: application/json' \
  -d '{"package":"com.android.settings"}'

{"id":1,"cmd":"launch","package":"com.android.settings"}

d.open_url("https://droidline.dev")

await d.openUrl("https://droidline.dev");

droidline open_url https://droidline.dev

curl -s -X POST localhost:8780/devices/_/open_url \
  -H 'content-type: application/json' \
  -d '{"url":"https://droidline.dev"}'

{"id":1,"cmd":"open_url","url":"https://droidline.dev"}

d.kill("com.android.chrome")

await d.kill("com.android.chrome");

droidline kill com.android.chrome

curl -s -X POST localhost:8780/devices/_/kill \
  -H 'content-type: application/json' \
  -d '{"package":"com.android.chrome"}'

{"id":1,"cmd":"kill","package":"com.android.chrome"}

d.clear_data("com.android.chrome")

await d.clearData("com.android.chrome");

droidline clear_data com.android.chrome

curl -s -X POST localhost:8780/devices/_/clear_data \
  -H 'content-type: application/json' \
  -d '{"package":"com.android.chrome"}'

{"id":1,"cmd":"clear_data","package":"com.android.chrome"}

d.apps()

await d.apps();

droidline apps

curl -s -X POST localhost:8780/devices/_/apps \
  -H 'content-type: application/json'

{"id":1,"cmd":"apps"}

d.installed("com.android.chrome")

await d.installed("com.android.chrome");

droidline installed com.android.chrome

curl -s -X POST localhost:8780/devices/_/installed \
  -H 'content-type: application/json' \
  -d '{"package":"com.android.chrome"}'

{"id":1,"cmd":"installed","package":"com.android.chrome"}

d.back()

await d.back();

droidline back

curl -s -X POST localhost:8780/devices/_/back \
  -H 'content-type: application/json'

{"id":1,"cmd":"back"}

d.home()

await d.home();

droidline home

curl -s -X POST localhost:8780/devices/_/home \
  -H 'content-type: application/json'

{"id":1,"cmd":"home"}

d.recents()

await d.recents();

droidline recents

curl -s -X POST localhost:8780/devices/_/recents \
  -H 'content-type: application/json'

{"id":1,"cmd":"recents"}

d.open_notifications()

await d.openNotifications();

droidline open_notifications

curl -s -X POST localhost:8780/devices/_/open_notifications \
  -H 'content-type: application/json'

{"id":1,"cmd":"open_notifications"}

d.quick_settings()

await d.quickSettings();

droidline quick_settings

curl -s -X POST localhost:8780/devices/_/quick_settings \
  -H 'content-type: application/json'

{"id":1,"cmd":"quick_settings"}

d.data(False, wait=True)

await d.data(false, { wait: true });

droidline data false --wait

curl -s -X POST localhost:8780/devices/_/data \
  -H 'content-type: application/json' \
  -d '{"wait":true,"on":false}'

{"id":1,"cmd":"data","on":false,"wait":true}

d.wifi(False, wait=True)

await d.wifi(false, { wait: true });

droidline wifi false --wait

curl -s -X POST localhost:8780/devices/_/wifi \
  -H 'content-type: application/json' \
  -d '{"wait":true,"on":false}'

{"id":1,"cmd":"wifi","on":false,"wait":true}

d.airplane(True, wait=True)

await d.airplane(true, { wait: true });

droidline airplane true --wait

curl -s -X POST localhost:8780/devices/_/airplane \
  -H 'content-type: application/json' \
  -d '{"wait":true,"on":true}'

{"id":1,"cmd":"airplane","on":true,"wait":true}

d.clipboard("Hello")

await d.clipboard("Hello");

droidline clipboard Hello

curl -s -X POST localhost:8780/devices/_/clipboard \
  -H 'content-type: application/json' \
  -d '{"text":"Hello"}'

{"id":1,"cmd":"clipboard","text":"Hello"}

d.batch([("airplane", True), ("sleep", 3000), ("airplane", False)], wait=True)

await d.batch([["airplane", true], ["sleep", 3000], ["airplane", false]], { wait: true });

droidline batch '[["airplane",true],["sleep",3000],["airplane",false]]' --wait

curl -s -X POST localhost:8780/devices/_/batch \
  -H 'content-type: application/json' \
  -d '{"wait":true,"steps":[["airplane",true],["sleep",3000],["airplane",false]]}'

{"id":1,"cmd":"batch","steps":[["airplane",true],["sleep",3000],["airplane",false]],"wait":true}

d.chrome.go("droidline.dev")

await d.chrome.go("droidline.dev");

droidline chrome.go droidline.dev

curl -s -X POST localhost:8780/devices/_/chrome.go \
  -H 'content-type: application/json' \
  -d '{"url":"droidline.dev"}'

{"id":1,"cmd":"chrome.go","url":"droidline.dev"}

d.notifications()

await d.notifications();

droidline notifications

curl -s -X POST localhost:8780/devices/_/notifications \
  -H 'content-type: application/json'

{"id":1,"cmd":"notifications"}

d.has_notification("textContains", "shipped")

await d.hasNotification("textContains", "shipped");

droidline has_notification textContains shipped

curl -s -X POST localhost:8780/devices/_/has_notification \
  -H 'content-type: application/json' \
  -d '{"by":"textContains","value":"shipped"}'

{"id":1,"cmd":"has_notification","by":"textContains","value":"shipped"}

dl.wait_notification("textContains", "verification code", 60)

await dl.waitNotification("textContains", "verification code", 60);

droidline wait_notification textContains "verification code" 60

curl -s -X POST localhost:8780/server/wait_notification \
  -H 'content-type: application/json' \
  -d '{"by":"textContains","value":"verification code","timeout":60}'

{"id":1,"cmd":"wait_notification","by":"textContains","value":"verification code","timeout":60}

n = d.notifications()[0]
d.notification_reply(n["key"], "On my way")

const [n] = await d.notifications();
await d.notificationReply(n.key, "On my way");

KEY=$(droidline --json notifications | jq -r '.value[0].key')
droidline notification_reply "$KEY" "On my way"

curl -s -X POST localhost:8780/devices/_/notification_reply \
  -H 'content-type: application/json' \
  -d '{"key":"KEY","text":"On my way"}'

{"id":1,"cmd":"notification_reply","key":"KEY","text":"On my way"}

n = d.notifications()[0]
d.notification_click(n["key"])

const [n] = await d.notifications();
await d.notificationClick(n.key);

KEY=$(droidline --json notifications | jq -r '.value[0].key')
droidline notification_click "$KEY"

curl -s -X POST localhost:8780/devices/_/notification_click \
  -H 'content-type: application/json' \
  -d '{"key":"KEY"}'

{"id":1,"cmd":"notification_click","key":"KEY"}

n = d.notifications()[0]
d.notification_dismiss(n["key"])

const [n] = await d.notifications();
await d.notificationDismiss(n.key);

KEY=$(droidline --json notifications | jq -r '.value[0].key')
droidline notification_dismiss "$KEY"

curl -s -X POST localhost:8780/devices/_/notification_dismiss \
  -H 'content-type: application/json' \
  -d '{"key":"KEY"}'

{"id":1,"cmd":"notification_dismiss","key":"KEY"}

d.notify_filter(["com.android.chrome", "com.google.android.gm"])

await d.notifyFilter(["com.android.chrome", "com.google.android.gm"]);

droidline notify_filter com.android.chrome,com.google.android.gm

curl -s -X POST localhost:8780/devices/_/notify_filter \
  -H 'content-type: application/json' \
  -d '{"packages":["com.android.chrome","com.google.android.gm"]}'

{"id":1,"cmd":"notify_filter","packages":["com.android.chrome","com.google.android.gm"]}

stop = d.on_notification(package="com.google.android.gm", callback=print)
# ... later
stop()

const stop = await d.onNotification({ package: "com.google.android.gm" }, (n) => console.log(n.title, n.text));
// ... later
stop();

droidline on_notification --package com.google.android.gm

{"id":1,"cmd":"subscribe","events":["notification"]}

dl.devices()

await dl.devices();

droidline devices

curl -s localhost:8780/devices

{"id":1,"cmd":"devices"}

dl.pair("482913", name="shelf-01")

await dl.pair("482913", { name: "shelf-01" });

droidline pair 482913 --name shelf-01

curl -s -X POST localhost:8780/server/pair \
  -H 'content-type: application/json' \
  -d '{"code":"482913","name":"shelf-01"}'

{"id":1,"cmd":"pair","code":"482913","name":"shelf-01"}

dl.pair_qr()

await dl.pairQr();

droidline pair            # shows the QR code in the terminal

curl -s -X POST localhost:8780/server/pair_qr \
  -H 'content-type: application/json'

{"id":1,"cmd":"pair_qr"}

dl.rename("k7d2q9xa", "shelf-01")

await dl.rename("k7d2q9xa", "shelf-01");

droidline rename k7d2q9xa shelf-01

curl -s -X POST localhost:8780/server/rename \
  -H 'content-type: application/json' \
  -d '{"device":"k7d2q9xa","name":"shelf-01"}'

{"id":1,"cmd":"rename","device":"k7d2q9xa","name":"shelf-01"}

dl.revoke("shelf-01")

await dl.revoke("shelf-01");

droidline revoke shelf-01

curl -s -X POST localhost:8780/server/revoke \
  -H 'content-type: application/json' \
  -d '{"device":"shelf-01"}'

{"id":1,"cmd":"revoke","device":"shelf-01"}

dl.subscribe(["notification"])

await dl.subscribe(["notification"]);

{"id":1,"cmd":"subscribe","events":["notification"]}

dl.server_info()

await dl.serverInfo();

droidline server_info

curl -s -X POST localhost:8780/server/server_info \
  -H 'content-type: application/json'

{"id":1,"cmd":"server_info"}

dl.auth("your-client-token")

await dl.auth("your-client-token");

{"id":1,"cmd":"auth","token":"your-client-token"}