Documentation & CLI Reference
Bootscry is a Python prototype. Its public repository is planned; these notes describe the current private Comet implementation and its command-line interface.
Installation & Setup (Planned Release)
The Bootscry public repository is planned. The Comet prototype is being validated on one physical test bench before release.
Requires Python >=3.11. Once public, installation in editable mode will proceed as:
# For approved pilots with access to the private source:
cd bootscry
python3 -m pip install -e .Set your hardware KVM password in your local environment without recording it in your shell history:
read -r -s -p "KVM password: " KVM1_PASSWORD
echo
export KVM1_PASSWORDCheck hardware status. The first connection pins the certificate fingerprint to ~/.config/glkvm/pins.json:
python3 scripts/kvm/kvm_tool.py statusCLI Reference (kvm_tool.py)
| Command | Description | Example |
|---|---|---|
status | Prints KVM firmware version, video resolution, and target USB status. | python3 scripts/kvm/kvm_tool.py status |
snapshot | Captures the current frame to disk. Wakes a sleeping video streamer if idle. | python3 scripts/kvm/kvm_tool.py snapshot -o screen.jpg |
ocr | Runs local OCR pipeline on the current frame and prints detected text. | python3 scripts/kvm/kvm_tool.py ocr |
wait-text | Blocks until regular expression appears on screen, with a configurable timeout. | python3 scripts/kvm/kvm_tool.py wait-text 'login:' --timeout 60 |
find-text | Searches for string or regex; outputs bounding box coordinates and confidence. | python3 scripts/kvm/kvm_tool.py find-text 'Save & Exit' |
click-text | Locates text via OCR bounding box and double-clicks the center pixel. | python3 scripts/kvm/kvm_tool.py click-text 'Options' --double |
type | Sends keystrokes with CRLF protection and base64 payload chunking. | python3 scripts/kvm/kvm_tool.py type 'systemctl restart ssh' --enter |
cad | Sends Ctrl+Alt+Del chord to reboot the target host. | python3 scripts/kvm/kvm_tool.py cad |
reboot-to | Issues reboot and taps specified hotkey through the POST window. | python3 scripts/kvm/kvm_tool.py reboot-to Delete --duration 25 |
Offline Mock Testing
Pilots with source access can run the mock tests without physical hardware:
python3 -m pytest tests/test_glkvm_mock.py tests/test_glkvm_client.py -vThe mock checks API behavior and client handling. Several Comet behaviors are known only from source or reports and require separate live checks.