Termux:API for Android

Overview and purpose

Termux:API is an extension for the Termux Android environment, created by Fredrik Fornwall, that exposes many device capabilities to the command line. It allows scripts and shell sessions to interact with phone features so you can automate tasks or integrate device data into terminal workflows.

Main capabilities

• Trigger the phone vibrator and other simple hardware actions from scripts.
• Query the device’s GPS to obtain location coordinates and related sensor data.
• Retrieve entries from the system contacts database for use in scripts or tools.
• Read from and write to the system clipboard within shell sessions.
• Send and read SMS messages programmatically from the command line.

Installation and requirements

To use this add-on you must have the primary Termux application installed on your Android device. After installing Termux, add the API package (commonly installed via the Termux package manager) so the command-line utilities become available.

Finding the command reference

A comprehensive list of the available commands and their usage is included in the add-on’s documentation. Consult the packaged help or the Termux:API documentation inside the app to see exact command names, options, and examples.

Typical uses and benefits

Termux:API is useful for automating device interactions, building CLI tools that need hardware access, or integrating phone data into scripts and workflows. It’s a practical way to control or monitor Android features without leaving the terminal.