# JavaScript API index Read a function’s page before using it. Each page includes its signature, argument units, return value, error behavior and a short example. Examples with com.example.app or sample identifiers must be adapted after inspection. ## Apps - [openApp](https://mcp.applesauceos.com/doc/api/openapp.md) — Bring an installed app to the foreground. Aliases: appRun, appActivate. - [waitForApp](https://mcp.applesauceos.com/doc/api/waitforapp.md) — Launch an app if necessary and wait for its helper. - [appKill](https://mcp.applesauceos.com/doc/api/appkill.md) — Request termination of an app. - [appInfo](https://mcp.applesauceos.com/doc/api/appinfo.md) — Read installed-app metadata. - [getAppState](https://mcp.applesauceos.com/doc/api/getappstate.md) — Read an app’s process state. - [appStateInfo](https://mcp.applesauceos.com/doc/api/appstateinfo.md) — Read installation, process and foreground state separately. - [frontMostAppId](https://mcp.applesauceos.com/doc/api/frontmostappid.md) — Identify the foreground app. - [frontMostAppOrientation](https://mcp.applesauceos.com/doc/api/frontmostapporientation.md) — Read interface orientation. Aliases: getDeviceOrientation. - [openURL](https://mcp.applesauceos.com/doc/api/openurl.md) — Ask iOS to open a URL or supported URL scheme. ## Touches and keyboard - [tap](https://mcp.applesauceos.com/doc/api/tap.md) — Touch and release a screen position. - [touchDown](https://mcp.applesauceos.com/doc/api/touchdown.md) — Begin a finger contact without releasing it. - [touchMove](https://mcp.applesauceos.com/doc/api/touchmove.md) — Move an existing finger contact. - [touchUp](https://mcp.applesauceos.com/doc/api/touchup.md) — Release a finger contact. - [swipe](https://mcp.applesauceos.com/doc/api/swipe.md) — Simulate a finger-1 swipe between two positions. - [keyDown](https://mcp.applesauceos.com/doc/api/keydown.md) — Press a hardware button. - [keyUp](https://mcp.applesauceos.com/doc/api/keyup.md) — Release a hardware button. - [KEY_TYPE](https://mcp.applesauceos.com/doc/api/key_type.md) — Named hardware button values. - [typeText](https://mcp.applesauceos.com/doc/api/typetext.md) — Type into the foreground app. - [deleteText](https://mcp.applesauceos.com/doc/api/deletetext.md) — Send backspaces to the focused input. - [hideKeyboard](https://mcp.applesauceos.com/doc/api/hidekeyboard.md) — Ask the foreground app to dismiss its keyboard. - [copyText](https://mcp.applesauceos.com/doc/api/copytext.md) — Replace the clipboard text. - [readClipboard](https://mcp.applesauceos.com/doc/api/readclipboard.md) — Read clipboard text. - [setTouchPressure](https://mcp.applesauceos.com/doc/api/settouchpressure.md) — Store a touch-pressure preference. ## Timing and runtime - [usleep](https://mcp.applesauceos.com/doc/api/usleep.md) — Pause the script for a fixed duration. - [msleep](https://mcp.applesauceos.com/doc/api/msleep.md) — Pause the script for a fixed duration. - [sleep](https://mcp.applesauceos.com/doc/api/sleep.md) — Pause the script for a fixed duration. - [stop](https://mcp.applesauceos.com/doc/api/stop.md) — Request cancellation of the current script. - [setSpeed](https://mcp.applesauceos.com/doc/api/setspeed.md) — Store a playback speed preference. ## Device and feedback - [getScreenInfo](https://mcp.applesauceos.com/doc/api/getscreeninfo.md) — Read panel dimensions. - [getDeviceInfo](https://mcp.applesauceos.com/doc/api/getdeviceinfo.md) — Read a structured device summary. - [getBatteryInfo](https://mcp.applesauceos.com/doc/api/getbatteryinfo.md) — Read battery status. - [getTemperature](https://mcp.applesauceos.com/doc/api/gettemperature.md) — Read device temperature. - [getVersion](https://mcp.applesauceos.com/doc/api/getversion.md) — Read the installed ApplesauceOS version. - [getSN](https://mcp.applesauceos.com/doc/api/getsn.md) — Read the device serial number. - [getLocalIP](https://mcp.applesauceos.com/doc/api/getlocalip.md) — Read the local Wi-Fi IP address. - [kernelVersion](https://mcp.applesauceos.com/doc/api/kernelversion.md) — Read the kernel version. - [setBrightness](https://mcp.applesauceos.com/doc/api/setbrightness.md) — Change screen brightness. Aliases: setScreenBrightnessTo. - [setKeepAwake](https://mcp.applesauceos.com/doc/api/setkeepawake.md) — Change the persisted keep-screen-awake preference. - [getKeepAwake](https://mcp.applesauceos.com/doc/api/getkeepawake.md) — Read the keep-screen-awake preference. - [setAvoidSafeMode](https://mcp.applesauceos.com/doc/api/setavoidsafemode.md) — Change the persisted safe-mode-avoidance preference. - [getAvoidSafeMode](https://mcp.applesauceos.com/doc/api/getavoidsafemode.md) — Read the safe-mode-avoidance preference. - [vibrate](https://mcp.applesauceos.com/doc/api/vibrate.md) — Request a vibration. - [say](https://mcp.applesauceos.com/doc/api/say.md) — Speak a string. - [playSound](https://mcp.applesauceos.com/doc/api/playsound.md) — Play a system sound. - [playSystemAlarm](https://mcp.applesauceos.com/doc/api/playsystemalarm.md) — Play system sound 1304. - [showNotice](https://mcp.applesauceos.com/doc/api/shownotice.md) — Show a compact notification banner. - [alert](https://mcp.applesauceos.com/doc/api/alert.md) — Show a device alert. - [log](https://mcp.applesauceos.com/doc/api/log.md) — Append messages to the script log. Aliases: console.log, console.warn, console.error. - [clearLog](https://mcp.applesauceos.com/doc/api/clearlog.md) — Clear the shared script log. ## Shell and system - [execResult](https://mcp.applesauceos.com/doc/api/execresult.md) — Run a shell command and inspect its outcome. - [exec](https://mcp.applesauceos.com/doc/api/exec.md) — Run a shell command and return combined output. - [execAsRoot](https://mcp.applesauceos.com/doc/api/execasroot.md) — Run a command as root. - [isVpnActive](https://mcp.applesauceos.com/doc/api/isvpnactive.md) — Check whether a VPN appears active. - [enableVPN](https://mcp.applesauceos.com/doc/api/enablevpn.md) — Request activation of the existing VPN configuration. - [disableVPN](https://mcp.applesauceos.com/doc/api/disablevpn.md) — Request VPN disconnection. ## Files and encoding - [scriptsDir](https://mcp.applesauceos.com/doc/api/scriptsdir.md) — Locate the installed Scripts directory. - [jbrootForPath](https://mcp.applesauceos.com/doc/api/jbrootforpath.md) — Resolve a path for the current jailbreak layout. - [readFile](https://mcp.applesauceos.com/doc/api/readfile.md) — Read a UTF-8 text file. - [writeFile](https://mcp.applesauceos.com/doc/api/writefile.md) — Write UTF-8 text to a file. - [fileExists](https://mcp.applesauceos.com/doc/api/fileexists.md) — Check whether a path exists. - [listDir](https://mcp.applesauceos.com/doc/api/listdir.md) — List names in a directory. - [copyFile](https://mcp.applesauceos.com/doc/api/copyfile.md) — Copy a file. - [moveFile](https://mcp.applesauceos.com/doc/api/movefile.md) — Move or rename a path. - [deleteFile](https://mcp.applesauceos.com/doc/api/deletefile.md) — Remove a file or directory. - [makeDir](https://mcp.applesauceos.com/doc/api/makedir.md) — Create a directory. - [sha256](https://mcp.applesauceos.com/doc/api/sha256.md) — Convert text to SHA-256 hexadecimal digest. - [sha256Base64](https://mcp.applesauceos.com/doc/api/sha256base64.md) — Convert text to SHA-256 digest encoded as Base64. - [md5](https://mcp.applesauceos.com/doc/api/md5.md) — Convert text to MD5 hexadecimal digest. - [base64Encode](https://mcp.applesauceos.com/doc/api/base64encode.md) — Convert text to Base64-encoded UTF-8 text. - [base64Decode](https://mcp.applesauceos.com/doc/api/base64decode.md) — Convert text to Decoded UTF-8 text. ## Screen and vision - [screenshot](https://mcp.applesauceos.com/doc/api/screenshot.md) — Save the screen as a PNG file. - [getColor](https://mcp.applesauceos.com/doc/api/getcolor.md) — Sample one screen pixel. - [getColors](https://mcp.applesauceos.com/doc/api/getcolors.md) — Sample several pixels from a single capture. - [rgbToInt](https://mcp.applesauceos.com/doc/api/rgbtoint.md) — Pack RGB channels into an integer. - [intToRgb](https://mcp.applesauceos.com/doc/api/inttorgb.md) — Unpack an RGB integer. - [ocr](https://mcp.applesauceos.com/doc/api/ocr.md) — Read text from the screen or an image. - [recognizeTextSupportedLanguages](https://mcp.applesauceos.com/doc/api/recognizetextsupportedlanguages.md) — Discover OCR languages on this device. - [searchColor](https://mcp.applesauceos.com/doc/api/searchcolor.md) — Find pixels matching a color. - [findColors](https://mcp.applesauceos.com/doc/api/findcolors.md) — Find a pattern of color anchors. - [findImage](https://mcp.applesauceos.com/doc/api/findimage.md) — Find a template image on the screen. ## UIHelper queries - [UIHelper.forApp](https://mcp.applesauceos.com/doc/api/uihelper-forapp.md) — Create a query client pinned to one app. - [UIHelper.findElement](https://mcp.applesauceos.com/doc/api/uihelper-findelement.md) — Find the first matching element. Aliases: findElement. - [UIHelper.findElements](https://mcp.applesauceos.com/doc/api/uihelper-findelements.md) — Find all matching elements. Aliases: findElements. - [UIHelper.waitForElement](https://mcp.applesauceos.com/doc/api/uihelper-waitforelement.md) — Wait for a matching element. Aliases: waitForElement. - [UIHelper.exists](https://mcp.applesauceos.com/doc/api/uihelper-exists.md) — Check presence without polling. - [UIHelper.waitForGone](https://mcp.applesauceos.com/doc/api/uihelper-waitforgone.md) — Wait until no element matches. Aliases: waitForGone. - [UIHelper.waitForAny](https://mcp.applesauceos.com/doc/api/uihelper-waitforany.md) — Wait for any of several possible screen states. Aliases: waitForAny. - [UIHelper.waitForAll](https://mcp.applesauceos.com/doc/api/uihelper-waitforall.md) — Wait until every selector has a match. Aliases: waitForAll. - [UIHelper.waitFor](https://mcp.applesauceos.com/doc/api/uihelper-waitfor.md) — Wait for a custom read-only condition. - [UIHelper.tap](https://mcp.applesauceos.com/doc/api/uihelper-tap.md) — Wait for a visible, enabled element and tap once. - [UIHelper.findElementsInRect](https://mcp.applesauceos.com/doc/api/uihelper-findelementsinrect.md) — Find elements whose snapshot centers lie in a rectangle. - [UIHelper.getTree](https://mcp.applesauceos.com/doc/api/uihelper-gettree.md) — Inspect the nested UI/accessibility hierarchy. - [UIHelper.observe](https://mcp.applesauceos.com/doc/api/uihelper-observe.md) — Inspect elements with short references and selector suggestions. ## Element actions - [Element.tap](https://mcp.applesauceos.com/doc/api/element-tap.md) — Activate an element once. Aliases: Element.click. - [Element.setText](https://mcp.applesauceos.com/doc/api/element-settext.md) — Replace the value of a supported UIKit text field/view. Aliases: Element.setValue. - [Element.typeText](https://mcp.applesauceos.com/doc/api/element-typetext.md) — Focus an element and insert text. Aliases: Element.addValue. - [Element.clear](https://mcp.applesauceos.com/doc/api/element-clear.md) — Clear a supported UIKit text field/view. Aliases: Element.clearValue. - [Element.scroll](https://mcp.applesauceos.com/doc/api/element-scroll.md) — Scroll the nearest scroll view by 75% of its viewport. - [Element.scrollIntoView](https://mcp.applesauceos.com/doc/api/element-scrollintoview.md) — Reveal an existing element in its nearest scroll view. - [Element.getAttributes](https://mcp.applesauceos.com/doc/api/element-getattributes.md) — Read fresh element attributes. - [Element.getText](https://mcp.applesauceos.com/doc/api/element-gettext.md) — Read fresh element text. - [Element.getValue](https://mcp.applesauceos.com/doc/api/element-getvalue.md) — Read the fresh element value. - [Element.getRect](https://mcp.applesauceos.com/doc/api/element-getrect.md) — Read fresh element bounds. - [Element.isDisplayed](https://mcp.applesauceos.com/doc/api/element-isdisplayed.md) — Check current visibility. - [Element.isEnabled](https://mcp.applesauceos.com/doc/api/element-isenabled.md) — Check whether interaction is enabled. - [Element.getAttribute](https://mcp.applesauceos.com/doc/api/element-getattribute.md) — Read one named fresh attribute. - [Element.exists](https://mcp.applesauceos.com/doc/api/element-exists.md) — Check whether this reference is still valid, or query its descendants. - [Element.snapshot](https://mcp.applesauceos.com/doc/api/element-snapshot.md) — Read the snapshot captured by the last query. - [Element.findElement](https://mcp.applesauceos.com/doc/api/element-findelement.md) — Find the first matching element. Scoped to descendants. - [Element.findElements](https://mcp.applesauceos.com/doc/api/element-findelements.md) — Find all matching elements. Scoped to descendants. - [Element.waitForElement](https://mcp.applesauceos.com/doc/api/element-waitforelement.md) — Wait for a matching element. Scoped to descendants. - [Element.waitForGone](https://mcp.applesauceos.com/doc/api/element-waitforgone.md) — Wait until no element matches. Scoped to descendants. - [Element.waitForAny](https://mcp.applesauceos.com/doc/api/element-waitforany.md) — Wait for any of several possible screen states. Scoped to descendants. - [Element.waitForAll](https://mcp.applesauceos.com/doc/api/element-waitforall.md) — Wait until every selector has a match. Scoped to descendants. - [Element.waitFor](https://mcp.applesauceos.com/doc/api/element-waitfor.md) — Wait for a custom read-only condition. Scoped to descendants. - [Element.findElementsInRect](https://mcp.applesauceos.com/doc/api/element-findelementsinrect.md) — Find elements whose snapshot centers lie in a rectangle. Scoped to descendants. - [Element.getTree](https://mcp.applesauceos.com/doc/api/element-gettree.md) — Inspect the nested UI/accessibility hierarchy. Scoped to descendants. - [Element.toJSON](https://mcp.applesauceos.com/doc/api/element-tojson.md) — Serialize this native element reference. - [Element.id](https://mcp.applesauceos.com/doc/api/element-id.md) — Read the cached native object reference. ## Modules and async - [require](https://mcp.applesauceos.com/doc/api/require.md) — Load a CommonJS module or JSON file. - [require.resolve](https://mcp.applesauceos.com/doc/api/require-resolve.md) — Resolve a module without executing it. - [module.exports](https://mcp.applesauceos.com/doc/api/module-exports.md) — Define the value returned by require(). - [exports](https://mcp.applesauceos.com/doc/api/exports.md) — Add properties to the module’s initial exports object. - [__dirname](https://mcp.applesauceos.com/doc/api/__dirname.md) — Locate the current module’s folder. - [__filename](https://mcp.applesauceos.com/doc/api/__filename.md) — Locate the current module file. - [args](https://mcp.applesauceos.com/doc/api/args.md) — Read arguments supplied when starting a script. - [require.cache](https://mcp.applesauceos.com/doc/api/require-cache.md) — Inspect loaded CommonJS modules for this run. - [require.main](https://mcp.applesauceos.com/doc/api/require-main.md) — Identify the entry module. - [module.require](https://mcp.applesauceos.com/doc/api/module-require.md) — Load a module relative to this module. - [setTimeout](https://mcp.applesauceos.com/doc/api/settimeout.md) — Schedule a callback once. - [setInterval](https://mcp.applesauceos.com/doc/api/setinterval.md) — Schedule a callback repeatedly. - [setImmediate](https://mcp.applesauceos.com/doc/api/setimmediate.md) — Schedule a callback after current synchronous work. - [clearTimeout](https://mcp.applesauceos.com/doc/api/cleartimeout.md) — Cancel a scheduled callback. - [clearInterval](https://mcp.applesauceos.com/doc/api/clearinterval.md) — Cancel a scheduled callback. - [clearImmediate](https://mcp.applesauceos.com/doc/api/clearimmediate.md) — Cancel a scheduled callback. - [globalThis](https://mcp.applesauceos.com/doc/api/globalthis.md) — Access the script global object. Aliases: global. - [at](https://mcp.applesauceos.com/doc/api/at.md) — Access the automation API namespace. - [module](https://mcp.applesauceos.com/doc/api/module.md) — Inspect the current CommonJS module. ## HTTP requests - [fetch](https://mcp.applesauceos.com/doc/api/fetch.md) — Make an asynchronous text/JSON HTTP request. - [Response.text](https://mcp.applesauceos.com/doc/api/response-text.md) — Consume an HTTP response body. - [Response.json](https://mcp.applesauceos.com/doc/api/response-json.md) — Consume an HTTP response body. - [Headers.get](https://mcp.applesauceos.com/doc/api/headers-get.md) — Read response headers. - [Headers.has](https://mcp.applesauceos.com/doc/api/headers-has.md) — Read response headers. - [Headers.entries](https://mcp.applesauceos.com/doc/api/headers-entries.md) — Read response headers. - [Headers.forEach](https://mcp.applesauceos.com/doc/api/headers-foreach.md) — Read response headers. - [request](https://mcp.applesauceos.com/doc/api/request.md) — Use the built-in callback-style HTTP adapter. - [request.get](https://mcp.applesauceos.com/doc/api/request-get.md) — Send an HTTP GET request. - [request.post](https://mcp.applesauceos.com/doc/api/request-post.md) — Send an HTTP POST request. - [request.put](https://mcp.applesauceos.com/doc/api/request-put.md) — Send an HTTP PUT request. - [request.patch](https://mcp.applesauceos.com/doc/api/request-patch.md) — Send an HTTP PATCH request. - [request.delete](https://mcp.applesauceos.com/doc/api/request-delete.md) — Send an HTTP DELETE request. - [request.head](https://mcp.applesauceos.com/doc/api/request-head.md) — Send an HTTP HEAD request. - [request.defaults](https://mcp.applesauceos.com/doc/api/request-defaults.md) — Create a callable adapter with default options. - [RequestHandle.abort](https://mcp.applesauceos.com/doc/api/requesthandle-abort.md) — Cancel a pending callback-style request. - [httpRequest](https://mcp.applesauceos.com/doc/api/httprequest.md) — Make a synchronous text HTTP request. - [httpGet](https://mcp.applesauceos.com/doc/api/httpget.md) — Make a synchronous GET request. - [Response.properties](https://mcp.applesauceos.com/doc/api/response-properties.md) — Read HTTP response state. ## Objective-C - [RemoteObjC.forApp](https://mcp.applesauceos.com/doc/api/remoteobjc-forapp.md) — Create or reuse a native client for a running app. Aliases: ObjC.forApp. - [ObjC.class](https://mcp.applesauceos.com/doc/api/objc-class.md) — Get a class loaded in SpringBoard and call its native methods directly. - [ObjC.hasClass](https://mcp.applesauceos.com/doc/api/objc-hasclass.md) — Check whether a class is loaded. - [ObjC.call](https://mcp.applesauceos.com/doc/api/objc-call.md) — Call an exact Objective-C selector. - [ObjC.create](https://mcp.applesauceos.com/doc/api/objc-create.md) — Allocate and initialize a native object. - [ObjC.getInfo](https://mcp.applesauceos.com/doc/api/objc-getinfo.md) — Inspect the target process/session. - [ObjC.out](https://mcp.applesauceos.com/doc/api/objc-out.md) — Prepare an object output parameter, such as NSError**. Aliases: RemoteObjC.out. - [ObjC.setTimeout](https://mcp.applesauceos.com/doc/api/objc-settimeout.md) — Set the total remote-call wait. - [ObjC.close](https://mcp.applesauceos.com/doc/api/objc-close.md) — Release a native session and invalidate its references. - [ObjC.reconnect](https://mcp.applesauceos.com/doc/api/objc-reconnect.md) — Open a fresh session after a restart or close. - [RemoteObjC.closeAll](https://mcp.applesauceos.com/doc/api/remoteobjc-closeall.md) — Close remote native clients created by this script. - [ObjCObject.call](https://mcp.applesauceos.com/doc/api/objcobject-call.md) — Invoke an exact selector on a proxy. - [ObjCObject.get](https://mcp.applesauceos.com/doc/api/objcobject-get.md) — Read a value through native key-value coding. - [ObjCObject.set](https://mcp.applesauceos.com/doc/api/objcobject-set.md) — Set a value through native key-value coding. - [ObjCObject.toJS](https://mcp.applesauceos.com/doc/api/objcobject-tojs.md) — Copy Foundation values into JavaScript. - [ObjCObject.respondsTo](https://mcp.applesauceos.com/doc/api/objcobject-respondsto.md) — Check selector support. - [ObjCObject.signature](https://mcp.applesauceos.com/doc/api/objcobject-signature.md) — Read native method type information. - [ObjCObject.release](https://mcp.applesauceos.com/doc/api/objcobject-release.md) — Release this retained proxy. - [ObjCObject.metadata](https://mcp.applesauceos.com/doc/api/objcobject-metadata.md) — Read cached native reference metadata. - [classExists](https://mcp.applesauceos.com/doc/api/classexists.md) — Inspect a local Objective-C class. - [classHasSelector](https://mcp.applesauceos.com/doc/api/classhasselector.md) — Inspect a local Objective-C class. - [ObjC.C](https://mcp.applesauceos.com/doc/api/objc-c.md) — Use the C client that shares this Objective-C session. - [ObjCObject.toJSON](https://mcp.applesauceos.com/doc/api/objcobject-tojson.md) — Copy a supported Foundation value when JSON.stringify serializes a proxy. - [ObjCObject.toString](https://mcp.applesauceos.com/doc/api/objcobject-tostring.md) — Read the native object’s description as a JavaScript string. - [ObjCOut.value](https://mcp.applesauceos.com/doc/api/objcout-value.md) — Read an object output parameter after a native call. ## Native C functions - [RemoteC.forApp](https://mcp.applesauceos.com/doc/api/remotec-forapp.md) — Create or reuse a C client for a running app. Aliases: C.forApp. - [C.bind](https://mcp.applesauceos.com/doc/api/c-bind.md) — Resolve a native function and cache its prepared signature. - [C.bindAddress](https://mcp.applesauceos.com/doc/api/c-bindaddress.md) — Bind a function at its current runtime address. - [C.call](https://mcp.applesauceos.com/doc/api/c-call.md) — Bind through the cache and invoke immediately. - [C.alloc](https://mcp.applesauceos.com/doc/api/c-alloc.md) — Allocate a zero-filled managed buffer. - [C.getInfo](https://mcp.applesauceos.com/doc/api/c-getinfo.md) — Inspect the target process/session. - [C.setTimeout](https://mcp.applesauceos.com/doc/api/c-settimeout.md) — Set the total remote-call wait. - [C.close](https://mcp.applesauceos.com/doc/api/c-close.md) — Release a native session and invalidate its references. - [C.reconnect](https://mcp.applesauceos.com/doc/api/c-reconnect.md) — Open a fresh session after a restart or close. - [RemoteC.closeAll](https://mcp.applesauceos.com/doc/api/remotec-closeall.md) — Close the script’s remote native sessions. - [CFunction.invoke](https://mcp.applesauceos.com/doc/api/cfunction-invoke.md) — Invoke a function returned by bind or bindAddress. - [CFunction.release](https://mcp.applesauceos.com/doc/api/cfunction-release.md) — Release a prepared native function handle. - [CPointer.byteLength](https://mcp.applesauceos.com/doc/api/cpointer-bytelength.md) — Read known managed buffer bounds. - [CPointer.readBytes](https://mcp.applesauceos.com/doc/api/cpointer-readbytes.md) — Copy a bounded managed-buffer range into JS. - [CPointer.writeBytes](https://mcp.applesauceos.com/doc/api/cpointer-writebytes.md) — Write bytes into managed storage. - [CPointer.release](https://mcp.applesauceos.com/doc/api/cpointer-release.md) — Release a pointer handle.