run-applescript

run-applescript

Run AppleScript and get the result

Install

npm install run-applescript

Usage

import {runAppleScript} from 'run-applescript';

const result = await runAppleScript('return "unicorn"');

console.log(result);
//=> 'unicorn'

API

runAppleScript(script, options?)

Returns a Promise<string> with the script result.

script

Type: string

The script to run.

options

Type: object

humanReadableOutput

Type: boolean
Default: true

Change the output style.

When false, returns the value in a recompilable source form.

signal

Type: AbortSignal

An AbortSignal that can be used to cancel the AppleScript execution.

runAppleScriptSync(script, options?)

Returns a string with the script result.

script

Type: string

The script to run.

options

Type: object

humanReadableOutput

Type: boolean
Default: true

Change the output style.

When false, returns the value in a recompilable source form.

Related

• run-jxa - Run JXA code and get the result

Similar packages

Other packages similar to run-applescript

osascript

Similar to run-applescript, the osascript package allows for the execution of AppleScript and JavaScript for Automation (JXA) scripts from Node.js. It provides a similar interface but also supports executing JXA scripts, offering a broader range of scripting capabilities on macOS.

node-osascript

This package also enables the execution of AppleScript from Node.js applications. It is similar to run-applescript but differs in its API and the way it handles script execution and output. node-osascript might offer alternative approaches or additional options for script execution that run-applescript does not.