TerminalOS | API Reference

Core Modules

Status, config, and menus

Status

Info, warning, error, success, and debug logging.

Config

Read and update app settings such as verbose mode, ADB, and OCR.

UI

Console banners, headers, and screen control helpers.

Libraries

Shared integrations

ADBController — device control, taps, swipes, app management, screenshots
OpenCVImageTools — grayscale, blur, edges, contours, matching
TesseractOCR — OCR extraction and preprocessing
FileTools — read, write, backup, copy, and list files
TextTools — formatting, validation, case conversion
CronScheduler — task scheduling and cron-style automation
LLMChat — local AI chat integration

Common Workflow

Screenshot → analyze → extract

adb = ADBController()
cv = OpenCVImageTools()
ocr = TesseractOCR()

adb.screenshot("screen.png")
image = cv.load_image("screen.png")
gray = cv.to_grayscale(image)
text = ocr.extract_text("screen.png")

TerminalOS is built to make this kind of multi-library workflow easy and repeatable.

Configuration Keys

Defaults in `app/config.json`

{
  "verbose": false,
  "adb": {
    "adb_executable": "adb",
    "device_serial": "",
    "timeout": 30
  },
  "ocr": {
    "tesseract_cmd": "tesseract",
    "language": "eng",
    "psm": 3,
    "oem": 3,
    "timeout": 30
  },
  "cron_tasks": []
}