cli-serial-hid-kvm

CLI tool for KVM control — thin client for serial-hid-kvm.

Architecture

┌──────────┐       TCP        ┌─────────────────┐     USB/HDMI     ┌───────────┐
│  shkvm   │ ──────────────── │ serial-hid-kvm  │ ──────────────── │ Target PC │
│  (CLI)   │    port 9329     │   (server)      │   CH9329 + Cap   │           │
└──────────┘                  └─────────────────┘                  └───────────┘

The CLI connects to a running serial-hid-kvm server over TCP. The server handles all hardware interaction (USB HID via CH9329 and HDMI capture). OCR is performed locally by the CLI using Tesseract.

Prerequisites

• serial-hid-kvm server running with --headless --api (or with GUI + API enabled)
• Tesseract OCR installed for ocr and exec commands
• Python 3.10+

Installation

pip install cli-serial-hid-kvm

Or for development:

git clone https://github.com/sunasaji/cli-serial-hid-kvm.git
cd cli-serial-hid-kvm
pip install -e .

Quick Start

# Start the KVM server (on the machine connected to target PC)
serial-hid-kvm --headless --api

# Use shkvm from any machine that can reach the server
shkvm info                          # check connection
shkvm type "ls -la{enter}"          # type on target PC
shkvm capture -o screen.jpg         # take screenshot
shkvm ocr                           # read screen text
shkvm exec "echo hello" -w 2        # run command and read output

Command Reference

Keyboard

Mouse

Screen

Device Management

Global Options

Configuration

All settings can be configured via environment variables:

License

MIT