Skip to content

cli.md

Latest commit

 

History

History
55 lines (34 loc) · 1.24 KB

cli.md

File metadata and controls

55 lines (34 loc) · 1.24 KB
Raw

CLI Reference

The sharklocal CLI is invoked as a Python module and provides discovery, testing, monitoring, and direct command capabilities.

python -m sharklocal <IP_ADDRESS> [OPTIONS]

Discovery Probe

Identify which mapping configuration works for your vacuum model. This is the recommended first step for new hardware:

python -m sharklocal <IP_ADDRESS> --probe

Compatibility Testing

Run non-destructive tests (Status, Events, Info) to verify support for local REST and MQTT features:

python -m sharklocal <IP_ADDRESS> --test

Run all tests, including destructive commands (Start, Stop, Dock), and automatically generate a compatibility matrix for contributing back to the project:

python -m sharklocal <IP_ADDRESS> --test-all --save-report

Real-Time Monitoring

Stream real-time status updates via MQTT. This is the best way to verify that a vacuum is correctly publishing its state:

python -m sharklocal <IP_ADDRESS> --monitor

Direct Commands

Send a specific command via a chosen transport (defaults to mqtt):

python -m sharklocal <IP_ADDRESS> --cmd dock --transport mqtt

Available commands: start, stop, dock, status, events, info.