Termux-api 常用命令中文使用手册
Termux-api 常用命令中文使用手册
翻译如有不周欢迎指正，转载请注明出处。
termux-audio-info
获取有关音频功能的信息。
termux-battery-status
获取设备电池状态。
termux-brightness
用法：$SCRIPTNAME [brightness]
将屏幕亮度设置在0到255之间或自动。
termux-call-log
用法：$SCRIPTNAME [-l limit] [-o offset]
列出历史通话记录。
| 可选项 | 功能 |
|---|---|
-l limit |
设置输出通话记录列表的限制（默认$PARAM_LIMIT） |
-o offset |
设置输出通话记录列表的偏移量（默认$PARAM_OFFSET） |
termux-camera-info
获取有关设备相机的信息。
termux-camera-photo
用法：$SCRIPTNAME [-c camera-id] output-file
拍照并保存为JPEG格式的文件。
| 可选项 | 功能 |
|---|---|
-c camera-id |
要使用的相机的ID （参见 termux-camera-info）, 默认：0 |
termux-clipboard-get
获取系统剪贴板文字。
termux-clipboard-set
用法：$SCRIPTNAME [text]
设置系统剪贴板文字。文本支持从参数设置或在未提供参数时从标准输入读取。
termux-contact-list
列出所有联系人。
termux-download
用法：$SCRIPTNAME [-d description] [-t title] url-to-download
使用系统下载管理器下载资源。
| 可选项 | 功能 |
|---|---|
-d description |
下载请求通知的描述 |
-t title |
下载请求通知的标题 |
-p path |
文件被下载到的完整路径 |
termux-fingerprint
用法：$SCRIPTNAME [-t title] [-d description] [-s subtitle] [-c cancel]
使用设备上的指纹传感器进行身份验证。
注意：仅在安卓6.0及更高版本上可用。
termux-job-scheduler
用法：termux-job-scheduler [options]
计划脚本以指定的时间间隔后运行。
| 可选项 | 功能 |
|---|---|
-p/--pending |
列出待处理的任务并退出 |
--cancel-all |
取消所有待处理的任务并退出 |
--cancel |
取消指定ID的任务并退出 |
-s/--script path |
调用脚本的路径 |
--job-id int |
任务ID（会覆盖之前任何拥有相同ID的任务） |
--period-ms int |
设定任务大约每隔多少ms执行一次（默认为0，表示只执行一次）。注意：从Android N开始，最小时间为900,000ms （15分钟）。 |
--network text |
仅当所选网络可用时运行（默认为any）: ［any, unmetered, cellular, not_roaming, none］ |
--battery-not-low boolean |
仅当电池电量充足时运行，默认为true（Android O及以后） |
--storage-not-low boolean |
仅当存储空间充足时运行，默认为false（Android O及以后） |
--charging boolean |
仅当接通电源时运行，默认为false |
--persisted boolean |
重启后任务是否保留，默认为false |
--trigger-content-uri text |
（Android N及以后） |
--trigger-content-flag int |
默认为1（Android N及以后） |
termux-keystore
用法：$SCRIPTNAME command
支持以下命令：
list [-d]deletegenerate[-a alg] [-s size] [-u validity] signverify
| 可选项 | 功能 |
|---|---|
list [command] |
列出存储在密钥库中的密钥。 |
-d |
详细结果（包括关键参数） |
delete [command] |
从密钥库中永久删除给定密钥。 |
alias |
要删除的密钥的别名。 |
generate [command] |
在硬件密钥库中创建一个新密钥。 |
alias |
密钥的别名 |
-a alg |
使用的算法（RSA或EC）。 默认为RSA。 |
-s size |
要使用的密钥大小。 对于RSA，选项为2048、3072和4096。对于EC，选项为256、384和521。 |
-u validity |
用户有效期，以秒为单位。 忽略该选项以禁用。 启用后，该密钥只能在设备解锁后指定的时间内使用。 持续时间过后，用户需要重新锁定并再次解锁设备才能使用此密钥。 |
sign [command] |
使用给定的密钥签名，从标准输入读取数据，并将签名输出到标准输出。 |
alias |
用于签名的密钥的别名。 |
algorithm |
使用的算法，例如 ‘SHA256withRSA’，应该与密钥的算法匹配。 |
verify [command] |
验证签名。 从标准输入中读取数据（原始文件）。 |
alias |
用于验证的密钥的别名。 |
algorithm |
用于签署此数据的算法。 |
signature |
用于验证的签名文件。 |
termux-location
用法：$SCRIPTNAME [-p provider] [-r request]
获取设备定位。
| 可选项 | 功能 |
|---|---|
-p provider |
位置提供方式：[gps/network/passive]（默认：gps） |
-r request |
发出请求的种类[once/last/updates]（默认：once） |
termux-media-player
用法：$SCRIPTNAME cmd [args]
| 可选项 | 功能 |
|---|---|
help |
显示此帮助信息 |
info |
显示当前播放信息 |
play |
如果暂停则继续播放 |
play |
播放指定的媒体文件 |
pause |
暂停播放 |
stop |
停止播放 |
termux-media-scan
用法：$SCRIPTNAME [-v] [-r] file [file...]
扫描指定的文件，并将其添加到媒体内容提供程序。
| 可选项 | 功能 |
|---|---|
-r |
递归扫描目录 |
-v |
详细模式 |
termux-microphone-record
用法：$SCRIPTNAME [args]
使用设备上的麦克风进行录音。
| 可选项 | 功能 |
|---|---|
-h |
显示此帮助信息 |
-d |
使用默认选项开始录音 |
-f |
开始录音至指定文件 |
-l |
指定录音时长（以秒为单位，无限制为0） |
-e |
指定录音编码（aac, amr_wb, amr_nb） |
-b |
指定录音比特率（单位：kbps） |
-r |
指定录音采样率（单位：Hz） |
-c |
指定录音声道数（1, 2, …） |
-i |
获取有关当前录音的信息 |
-q |
结束录音 |
termux-notification
用法：termux-notification [options]
显示系统通知。内容文本使用 -c / -content 指定或从标准输入中读取。
阅读–help-actions以获取有关操作参数的帮助。
| 可选项 | 功能 |
|---|---|
--action action |
按下通知时执行的动作 |
--alert-once |
当通知被编辑时不发出警告 |
--button1 text |
通知上第一个按钮显示的文字 |
--button1-action action |
通知上第一个按钮执行的动作 |
--button2 text |
通知上第二个按钮显示的文字 |
--button2-action action |
通知上第二个按钮执行的动作 |
--button3 text |
通知上第三个按钮显示的文字 |
--button3-action action |
通知上第三个按钮执行的动作 |
-c/--content content |
通知中显示的内容。优先于标准输入。 |
--group group |
通知分组（相同分组的通知会被一同显示） |
-h/--help |
显示此帮助信息 |
--help-actions |
显示关于按钮行为的帮助 |
-i/--id id |
通知ID（会覆盖之前任何拥有相同ID的通知） |
--icon icon-name |
设置显示在状态栏的图标。到https://material.io/resources/icons/ 查看可用图标（默认图标：event_note） |
--image-path path |
将被显示在通知上的一张图片的绝对路径 |
--led-color rrggbb |
以RRGGBB表示的通知闪烁灯颜色（默认：无） |
--led-off milliseconds |
number of milliseconds for the LED to be off while it’s flashing （默认：800） |
--led-on milliseconds |
number of milliseconds for the LED to be on while it’s flashing （默认：800） |
--on-delete action |
当通知被清除时执行的动作 |
--ongoing |
将通知固定到任务栏 |
--priority prio |
通知优先级（high/low/max/min/default） |
--sound |
随通知播放声音 |
-t/--title title |
要显示的通知标题 |
--vibrate pattern |
vibrate pattern, comma separated as in 500,1000,200 |
--type type |
要使用的通知风格（default/media） |
媒体按键动作（available with --type \"media\）：
| 可选项 | 功能 |
|---|---|
--media-next |
媒体-下一曲按键执行的动作 |
--media-pause |
媒体-暂停键执行的动作 |
--media-play |
媒体播放键执行的动作 |
--media-previous |
媒体-上一曲按键执行的动作 |
termux-notification-list
显示当前所有通知的列表。
termux-notification-remove
用法：$SCRIPTNAME notification-id
移除之前通过termux-notification --id显示的通知。
termux-sensor
用法：$SCRIPTNAME
获取有关传感器类型以及实时数据的信息。
| 可选项 | 功能 |
|---|---|
-h, help |
显示此帮助信息 |
-a, all |
侦听所有传感器（警告！可能影响电池寿命） |
-c, cleanup |
执行清理（释放传感器资源） |
-l, list |
显示可用传感器列表 |
-s, sensors [...] |
要侦听的传感器（可以只包含部分名称） |
-d, delay [ms] |
接收传感器数据更新之前的延迟时间（以毫秒为单位） |
-n, limit [num] |
读取传感器的次数（默认：continuous） （min: 1） |
termux-share
用法：$SCRIPTNAME [-a action] [-c content-type] [-d] [-t title] [file]
共享指定作为参数提供的文件，如果没有提供文件名参数，则从标准输入读取文件名。
| 可选项 | 功能 |
|---|---|
-a action |
对共享内容执行何种操作：edit/send/view（默认：view） |
-c content-type |
共享的文件类型（默认：通过文件扩展名推断，也可来自标准输入获取的文本/纯文本） |
-d |
如果一个接收器已被设置为默认，则选择它而不是显示选择器 |
-t title |
共享内容使用的标题（默认：分享的文件名） |
termux-sms-list
用法：$SCRIPTNAME [-d] [-l limit] [-n] [-o offset] [-t type]
列出手机短信。
| 可选项 | 功能 |
|---|---|
-d |
显示信息创建时的日期 |
-l limit |
设置输出短信列表的限制（默认：$PARAM_LIMIT） |
-n |
显示电话号码 |
-o offset |
设置输出短信列表的偏移量（默认：$PARAM_OFFSET） |
-t type |
要列出的信息类型（默认：$PARAM_TYPE）：$SUPPORTED_TYPES |
termux-sms-send
用法：$SCRIPTNAME -n number[,number2,number3,...] [text]
将SMS消息发送到指定的收件人号码。 要发送的文本要么作为参数提供，要么在没有给出参数的情况下从标准输入读取。
| 可选项 | 功能 |
|---|---|
-n number（s） |
收件人号码 - 用英文逗号分隔多个号码 |
termux-speech-to-text
将语音转换为文本，将匹配部分发送到标准输出。
termux-storage-get
用法：$SCRIPTNAME output-file
向系统请求文件并将其输出到指定文件。
termux-telephony-call
用法：$SCRIPTNAME
拨打电话号码。
termux-telephony-cellinfo
从设备上获取有关所有侦听到的小区广播（包括主要和相邻小区）的信息。
termux-telephony-deviceinfo
获取有关电话设备的信息。
termux-toast
用法：termux-toast [-b bgcolor] [-c color] [-g gravity] [-s] [text]
在Toast通知（瞬时弹出窗口）中显示文本。 要显示的文本作为参数提供，或者如果未提供参数，则从标准输入读取。
| 可选项 | 功能 |
|---|---|
-h |
显示此帮助信息 |
-b |
设置背景色（默认：gray） |
-c |
设置文字颜色（默认：white） |
-g |
设置toast的显示位置：[top, middle, or bottom] （默认：middle） |
-s |
仅短时间显示Toast通知 |
**注意：**颜色可使用标准名称（例如：red） 或设置为以（AA）RRGGBB规定的6位和8位的16进制值（例如：#FF0000或#FFFF0000）。无效的颜色将恢复为默认值。
termux-torch
用法：$SCRIPTNAME [on | off]
切换设备上的LED手电筒。
termux-tts-engines
获取有关可用的文字转语音引擎（TTS）。可以使用-e选项将引擎的名称提供给termux-tts-speak命令。
termux-tts-speak
用法：$SCRIPTNAME [-e engine] [-l language] [-n region] [-v variant] [-p pitch] [-r rate] [-s stream] [text-to-speak]
使用系统文字转语音引擎（TTS）朗读文本。要朗读的文本作为参数提供，或者如果未提供参数，则从标准输入读取。
| 可选项 | 功能 |
|---|---|
-e engine |
所使用的TTS引擎（参考termux-tts-engines） |
-l language |
所使用的语言（可能不被引擎支持） |
-n region |
所用语言的区域 |
-v variant |
所用语言的变体 |
-p pitch |
用于语音的音调调节。正常音高为1.0，降低或加大该值会降低或升高成语音的音调。 |
-r rate |
所使用的语速。正常语速为1.0，降低或加大该值会加快或减慢合成语的语速。（0.5为正常语速的一半，2.0为二倍语速） |
-s stream |
所使用的音频流（默认：NOTIFICATION），可选：ALARM, MUSIC,NOTIFICATION, RING, SYSTEM, VOICE_CALL |
termux-usb
用法：$SCRIPTNAME [-l | [-r] [-e command] device]
列出或访问USB设备。仅使用 $SCRIPTNAME 无法直接访问设备。
| 可选项 | 功能 |
|---|---|
-l |
列出可用设备 |
-r |
如有必要，显示权限请求对话框 |
-e command |
利用文件描述符来运行指定命令，引用设备作为其参数 |
termux-vibrate
用法：$SCRIPTNAME [-d duration] [-f]
震动设备。
| 可选项 | 功能 |
|---|---|
-d duration |
震动持续时间（默认：1000），单位ms |
-f |
强制震动，即使设备处于静音模式下 |
termux-volume
用法：$SCRIPTNAME stream volume
更改音频流的音量。有效的音频流有: alarm, music, notification, ring, system, call。不带参数调用以显示有关每个音频流的信息。
termux-wallpaper
用法：$SCRIPTNAME [options]
更改设备的壁纸。
| 可选项 | 功能 |
|---|---|
-h |
显示此帮助信息 |
-f |
从文件设置壁纸 |
-u |
从网址资源设置壁纸 |
-l |
设置锁定屏幕壁纸（安卓6.0及以后） |
termux-wifi-connectioninfo
获取有关当前wifi连接的信息。
termux-wifi-enable
用法：$SCRIPTNAME [true | false]
开启/关闭Wi-Fi
termux-wifi-scaninfo
获取有关上一次wifi扫描的信息。