Skip to content

Latest commit

 

History

History
472 lines (463 loc) · 24.2 KB

FLAGS.md

File metadata and controls

472 lines (463 loc) · 24.2 KB

The flag surface

Generated — do not edit. Run make flags to rebuild this and api/flags.json from the source.

API.md answers whether every front door reaches every tool. This answers the question underneath it: whether the CLI and the schema agree about what each tool accepts.

That is worth enforcing separately because the two ends fail in opposite directions and neither one shouts. Every tool's schema is additionalProperties: false, so an MCP client passing an undeclared key is refused outright; the CLI hands a plain map to the same handler, and a handler reads the keys it knows by name. A command writing call["speeed"] is therefore rejected loudly on one surface and silently ignored on the other — the one people use.

--device and --driver are persistent flags that daemonCall attaches to every call, so they are marked global and no command mentions them.

Arguments, by tool

Tool Argument Type Set by
app_accessibility device string global --device
app_accessibility driver string global --driver
app_accessibility setting string accessibility
app_accessibility value string accessibility
app_alert action string alert
app_alert button string alert
app_alert device string global --device
app_alert driver string global --driver
app_alert text string alert
app_appearance appearance string appearance
app_appearance device string global --device
app_appearance driver string global --driver
app_assistant app string assistant
app_assistant device string global --device
app_assistant driver string global --driver
app_assistant request string assistant
app_assistant timeout number assistant
app_audio action string audio
app_audio app string audio
app_audio device string global --device
app_audio driver string global --driver
app_audio expect array audio
app_audio ignore_ms integer audio
app_audio path string audio
app_audio return_data boolean —
app_audit device string global --device
app_audit driver string global --driver
app_background app string background
app_background device string global --device
app_background driver string global --driver
app_background seconds number background
app_batch device string global --device
app_batch driver string global --driver
app_batch steps array batch
app_battery device string global --device
app_battery driver string global --driver
app_biometric action string biometric
app_biometric device string global --device
app_biometric driver string global --driver
app_boot name string boot
app_boot window boolean boot
app_call action string call
app_call device string global --device
app_call driver string global --driver
app_call number string call
app_check claim string check
app_check model string check
app_check record string check
app_clear_data app string clear-data
app_clear_data content string —
app_clear_data device string global --device
app_clear_data driver string global --driver
app_clear_data name string —
app_clear_data path string clear-data
app_clipboard device string global --device
app_clipboard driver string global --driver
app_clipboard text string clipboard
app_context context string context
app_context device string global --device
app_context driver string global --driver
app_contexts device string global --device
app_contexts driver string global --driver
app_cookies action string cookies
app_cookies cookies array cookies
app_cookies device string global --device
app_cookies driver string global --driver
app_cookies name string cookies
app_crashes app string crashes
app_crashes device string global --device
app_crashes driver string global --driver
app_crashes id string crashes
app_crashes limit integer crashes
app_current device string global --device
app_current driver string global --driver
app_dialogs clear boolean dialogs
app_dialogs device string global --device
app_dialogs driver string global --driver
app_dialogs press string dialogs
app_dialogs when string dialogs
app_download app string download
app_download device string global --device
app_download device_path string download
app_download driver string global --driver
app_download name string download
app_download path string download
app_drag device string global --device
app_drag driver string global --driver
app_drag duration_ms integer drag
app_drag from string drag
app_drag hold_ms integer drag
app_drag to string drag
app_drag x1 integer drag
app_drag x2 integer drag
app_drag y1 integer drag
app_drag y2 integer drag
app_eval device string global --device
app_eval driver string global --driver
app_eval expression string eval
app_fill device string global --device
app_fill driver string global --driver
app_fill target string fill
app_fill text string fill
app_find device string global --device
app_find driver string global --driver
app_find locator string find
app_grant app string grant
app_grant device string global --device
app_grant driver string global --driver
app_grant permissions array grant
app_hit_test device string global --device
app_hit_test driver string global --driver
app_hit_test target string hit-test
app_hook args array hook
app_hook device string global --device
app_hook driver string global --driver
app_hook hook string hook
app_hook timeout_ms integer hook
app_install content string —
app_install device string global --device
app_install driver string global --driver
app_install name string —
app_install path string install
app_keyboard device string global --device
app_keyboard driver string global --driver
app_keyboard hide boolean keyboard
app_keyboard key string keyboard
app_keyboard text string keyboard
app_launch app string launch
app_launch device string global --device
app_launch driver string global --driver
app_launch gray_box boolean launch
app_launch hit_test boolean launch
app_list_apps device string global --device
app_list_apps driver string global --driver
app_list_apps system boolean apps
app_locale app string locale
app_locale device string global --device
app_locale driver string global --driver
app_locale locale string locale
app_location clear boolean location
app_location device string global --device
app_location driver string global --driver
app_location gpx string location
app_location gpx_data string —
app_location latitude number location
app_location longitude number location
app_location speed number location
app_location waypoints array location
app_lock device string global --device
app_lock driver string global --driver
app_lock state string lock
app_logs app string logs
app_logs device string global --device
app_logs driver string global --driver
app_logs level string logs
app_logs lines integer logs
app_logs source string logs
app_long_press device string global --device
app_long_press driver string global --driver
app_long_press duration_ms integer long-press
app_long_press target string long-press
app_long_press x integer long-press
app_long_press y integer long-press
app_map device string global --device
app_map diff boolean map
app_map driver string global --driver
app_network device string global --device
app_network download_kbps integer network
app_network driver string global --driver
app_network latency_ms integer network
app_network offline boolean network
app_network proxy string network
app_network reset boolean network
app_network upload_kbps integer network
app_notifications device string global --device
app_notifications driver string global --driver
app_notifications shade string notifications
app_notifications tag string notifications
app_notifications text string notifications
app_notifications title string notifications
app_open_url device string global --device
app_open_url driver string global --driver
app_open_url url string open
app_orientation device string global --device
app_orientation driver string global --driver
app_orientation orientation string orientation
app_press button string press
app_press device string global --device
app_press driver string global --driver
app_press gesture boolean press
app_press_drag device string global --device
app_press_drag driver string global --driver
app_press_drag duration_ms integer press-drag
app_press_drag from string press-drag
app_press_drag hold string press-drag
app_press_drag lead_ms integer press-drag
app_press_drag to string press-drag
app_press_drag x1 integer press-drag
app_press_drag x2 integer press-drag
app_press_drag x3 integer press-drag
app_press_drag y1 integer press-drag
app_press_drag y2 integer press-drag
app_press_drag y3 integer press-drag
app_press_tap device string global --device
app_press_tap driver string global --driver
app_press_tap hold string press-tap
app_press_tap lead_ms integer press-tap
app_press_tap tap string press-tap
app_press_tap x1 integer press-tap
app_press_tap x2 integer press-tap
app_press_tap y1 integer press-tap
app_press_tap y2 integer press-tap
app_record action string record
app_record device string global --device
app_record driver string global --driver
app_record path string record
app_record return_data boolean —
app_recording id string recording
app_recording offset integer recording
app_recording path string recording
app_recording query string recording
app_recording read string recording
app_recording record string recording
app_reset_permissions app string reset-permissions
app_reset_permissions device string global --device
app_reset_permissions driver string global --driver
app_revoke app string revoke
app_revoke device string global --device
app_revoke driver string global --driver
app_revoke permissions array revoke
app_rotate degrees number rotate
app_rotate device string global --device
app_rotate driver string global --driver
app_rotate radius integer rotate
app_rotate target string rotate
app_screen device string global --device
app_screen driver string global --driver
app_screen inspect boolean screen
app_screen profile string screen
app_screenshot device string global --device
app_screenshot driver string global --driver
app_screenshot path string screenshot
app_scroll_to device string global --device
app_scroll_to direction string scroll-to
app_scroll_to driver string global --driver
app_scroll_to target string scroll-to
app_session action string session
app_session app string session
app_session device string global --device
app_session driver string global --driver
app_session platform string session
app_set device string global --device
app_set driver string global --driver
app_set target string set, unset
app_set value boolean set, unset
app_shake device string global --device
app_shake driver string global --driver
app_shutdown name string shutdown
app_sms device string global --device
app_sms driver string global --driver
app_sms from string sms
app_sms text string sms
app_source device string global --device
app_source driver string global --driver
app_speech device string global --device
app_speech driver string global --driver
app_speech limit integer speech
app_speech listen string speech
app_speech target string speech
app_speech walk boolean speech
app_state app string state
app_state device string global --device
app_state driver string global --driver
app_storage action string storage
app_storage device string global --device
app_storage driver string global --driver
app_storage state object storage
app_swipe device string global --device
app_swipe direction string swipe
app_swipe driver string global --driver
app_swipe duration_ms integer swipe
app_swipe target string swipe
app_swipe x1 integer swipe
app_swipe x2 integer swipe
app_swipe y1 integer swipe
app_swipe y2 integer swipe
app_tap device string global --device
app_tap double boolean double-tap
app_tap driver string global --driver
app_tap fingers integer tap
app_tap target string double-tap, tap
app_tap x integer double-tap, tap
app_tap y integer double-tap, tap
app_terminate app string terminate
app_terminate device string global --device
app_terminate driver string global --driver
app_text device string global --device
app_text driver string global --driver
app_text target string text
app_time device string global --device
app_time driver string global --driver
app_timezone device string global --device
app_timezone driver string global --driver
app_timezone timezone string timezone
app_trace action string trace
app_trace device string global --device
app_trace driver string global --driver
app_trace maps boolean trace
app_trace name string trace
app_trace path string trace
app_trace return_data boolean —
app_trace screenshots boolean trace
app_type device string global --device
app_type driver string global --driver
app_type target string type
app_type text string type
app_uninstall app string uninstall
app_uninstall device string global --device
app_uninstall driver string global --driver
app_upload app string upload
app_upload content string —
app_upload device string global --device
app_upload device_path string upload
app_upload driver string global --driver
app_upload name string upload
app_upload path string upload
app_verdict claim string verdict
app_verdict evidence array verdict
app_verdict record string verdict
app_verdict status string verdict
app_verdict summary string verdict
app_wait_for condition string wait
app_wait_for count integer wait
app_wait_for device string global --device
app_wait_for driver string global --driver
app_wait_for exact boolean wait
app_wait_for not boolean wait
app_wait_for target string wait
app_wait_for text string wait
app_wait_for timeout_ms integer wait
app_zoom device string global --device
app_zoom direction string zoom
app_zoom driver string global --driver
app_zoom from integer zoom
app_zoom target string zoom
app_zoom to integer zoom

Commands, and what they send

A command with no flags of its own is not unusual: most take positional arguments and the two global flags.

Command Tools Flags Sends
accessibility app_accessibility — setting, value
alert app_alert --button --text action, button, text
appearance app_appearance — appearance
apps app_list_apps --system system
assistant app_assistant --app --timeout app, request, timeout
audio app_audio --app --expect --ignore-ms --output action, app, expect, ignore_ms, path
audit app_audit — —
background app_background --app app, seconds
batch app_batch — steps
battery app_battery — —
biometric app_biometric — action
boot app_boot --window name, window
call app_call --number action, number
check app_check --input --model claim, model, record
clear-data app_clear_data --bundle app, path
clipboard app_clipboard — text
context app_context — context
contexts app_contexts — —
cookies app_cookies, app_cookies, app_cookies --domain --expires --http-only --path --same-site --secure action, cookies, name
crashes app_crashes --app --limit app, id, limit
current app_current — —
daemon — — —
devices app_devices — —
dialogs app_dialogs --clear --press --when clear, press, when
doctor app_doctor — —
double-tap app_tap, app_tap — double, target, x, y
download app_download, app_download --app --device-path --output app, device_path, name, path
drag app_drag --duration-ms --hold-ms duration_ms, from, hold_ms, to, x1, x2, y1, y2
eval app_eval — expression
fill app_fill — target, text
find app_find — locator
grant app_grant — app, permissions
grid — --holder --want —
hit-test app_hit_test — target
hook app_hook --timeout-ms args, hook, timeout_ms
inspect — --open --port --record darwin, windows
install app_install — path
keyboard app_keyboard --hide --key --text hide, key, text
launch app_launch --gray-box --hit-test app, gray_box, hit_test
locale app_locale — app, locale
location app_location --clear --gpx --lat --lon --speed clear, gpx, latitude, longitude, speed, waypoints
lock app_lock — state
logs app_logs --app --level --lines --source app, level, lines, source
long-press app_long_press --duration duration_ms, target, x, y
map app_map --diff diff
mcp — --apps --mark-device-text --read-only —
network app_network --download --latency --no-proxy --offline --online --proxy --reset --upload download_kbps, latency_ms, offline, proxy, reset, upload_kbps
notifications app_notifications --post --shade --tag --title shade, tag, text, title
open app_open_url — url
orientation app_orientation — orientation
pipe — — —
press app_press --gesture button, gesture
press-drag app_press_drag --duration-ms --lead-ms duration_ms, from, hold, lead_ms, to, x1, x2, x3, y1, y2, y3
press-tap app_press_tap --lead-ms hold, lead_ms, tap, x1, x2, y1, y2
record app_record --output action, path
recording app_recording --input --offset --output id, offset, path, query, read, record
reset-permissions app_reset_permissions — app
revoke app_revoke — app, permissions
rotate app_rotate --degrees --radius --target degrees, radius, target
screen app_screen --inspect inspect, profile
screenshot app_screenshot --output path
scroll-to app_scroll_to --direction direction, target
session app_session --app --platform action, app, platform
set app_set — target, value
shake app_shake — —
show-report — — darwin, windows
shutdown app_shutdown — name
sms app_sms --from from, text
source app_source — —
speech app_speech --limit --listen --walk limit, listen, target, walk
start — --idle-timeout —
state app_state — app
status — — running
status — — —
stop — — status
storage app_storage, app_storage, app_storage --output action, state
swipe app_swipe --duration direction, duration_ms, target, x1, x2, y1, y2
tap app_tap, app_tap --fingers fingers, target, x, y
terminate app_terminate — app
test — --config --debug --grep --last-failed --list --no-screenshots --open --output --project --reporter --retries --timeout --trace --ui --ui-port --workers list
text app_text — target
time app_time — —
timezone app_timezone — timezone
trace app_trace --name --no-maps --no-screenshots --output action, maps, name, path, screenshots
type app_type — target, text
ui — --port —
uninstall app_uninstall — app
unset app_set — target, value
up — — —
upload app_upload --app --device-path --name app, device_path, name, path
verdict app_verdict --input --status --summary claim, evidence, record, status, summary
wait app_wait_for --count --exact --for --not --text --timeout condition, count, exact, not, target, text, timeout_ms
zoom app_zoom --from --target --to direction, from, target, to