How to Use the Command 'osascript' (with Examples)

osascript is a powerful command-line tool that allows macOS users to run AppleScripts and JavaScript for Automation (JXA). AppleScripts are used to automate tasks on macOS, while JXA opens up automation capabilities using JavaScript syntax. osascript can execute not only inline scripts but also scripts stored in files, making it indispensable for developers and power users who want to automate repetitive tasks or integrate macOS applications in a seamless workflow.

Use Case 1: Run an AppleScript Command

Code:

osascript -e "say 'Hello world'"

Motivation:

This simple example shows how to use osascript to utilize macOS’s built-in text-to-speech capability. You might use this to verify that your scripting environment is set up correctly or to automate announcements in a shared office space or during presentations.

Explanation:

• osascript: The command itself, which executes scripts.
• -e: This flag specifies that an inline script follows. Each -e is followed by an AppleScript command.
• "say 'Hello world'": The actual AppleScript command that instructs the computer to speak the text “Hello world.”

Example Output:

The computer’s speakers will audibly say: “Hello world.”

Use Case 2: Run Multiple AppleScript Commands

Code:

osascript -e "say 'Hello'" -e "say 'world'"

Motivation:

Using multiple -e options allows you to execute several AppleScript commands sequentially. This can be helpful when you want to automate a sequence of tasks. This example can be used in scenarios where multiple announcements need to be queued and voiced out in order.

Explanation:

• osascript: The command used for execution.
• Two -e flags: These indicate that the following items are AppleScript commands to be executed sequentially.
• "say 'Hello'" and "say 'world'": Two separate AppleScript commands that tell the computer to sequentially say “Hello” and “world.”

Example Output:

The computer will audibly say: “Hello” followed by “world.”

Use Case 3: Run a Compiled, Bundled, or Plaintext AppleScript File

Code:

osascript path/to/apple.scpt

Motivation:

Storing scripts in files is beneficial for complex or lengthy automation tasks. It allows the script to be reused, edited, and maintained outside the command line. This particular approach is crucial for developers who frequently update scripts or share them across different systems.

Explanation:

• osascript: Utility for executing scripts.
• path/to/apple.scpt: This is the file path to the AppleScript file. The script could be in a .scpt (compiled script), .scptd (bundled script), or .applescript (plaintext) format. The file extension depends on how the script was saved and compiled.

Example Output:

Results vary depending on the content of the script, potentially triggering a sequence of automated actions defined within the file.

Use Case 4: Get the Bundle Identifier of an Application

Code:

osascript -e 'id of app "Application"'

Motivation:

Identifying the bundle ID is essential when scripting application-specific tasks, especially for launching or controlling applications directly from scripts. It provides a reliable way to distinguish applications, as two applications can have the same name but not the same bundle ID.

Explanation:

• osascript: Executes a given script using AppleScript.
• -e: Indicates an inline AppleScript command.
• 'id of app "Application"': An AppleScript command that retrieves the bundle identifier of the specified application.

Example Output:

Returns a string that represents the application’s bundle identifier, e.g., com.apple.TextEdit for TextEdit.

Use Case 5: Run a JavaScript Command

Code:

osascript -l JavaScript -e "console.log('Hello world');"

Motivation:

For users familiar with JavaScript, JXA (JavaScript for Automation) offers a more accessible syntax to script macOS automation tasks. This example is a simple demonstration of logging output, useful for debugging and verifying script execution.

Explanation:

• osascript: Invokes the script.
• -l JavaScript: Specifies the language as JavaScript instead of the default AppleScript.
• -e: Introduces the inline JavaScript command.
• "console.log('Hello world');": A JavaScript statement that logs “Hello world” to the console.

Example Output:

Displays “Hello world” in the terminal console where the command was executed.

Use Case 6: Run a JavaScript File

Code:

osascript -l JavaScript path/to/script.js

Motivation:

This use case makes it possible to maintain, share, and execute extensive JavaScript automation scripts. JavaScript files are a substantial way to automate tasks across different systems without rewriting code repeatedly.

Explanation:

• osascript: The executor of scripting commands.
• -l JavaScript: Specifies the scripting language.
• path/to/script.js: The path to the file containing JavaScript code. The file is read and executed by osascript.

Example Output:

The results depend on the script’s content, executing the automated tasks coded within.

Conclusion:

The osascript utility is an indispensable tool for macOS automation, whether you’re using AppleScript or JavaScript. It allows for quick, easy scripting and can handle inline commands or full scripts stored in files. From simple text-to-speech commands to complex automation sequences, osascript provides users with a powerful means to control their macOS environment efficiently.