Every Cambrionix CLI command, grouped by what it works on.
Add --help to any command for its full options, for example cambrionix-cli ports dfu --help.
Commands marked premium need a licensed hub feature; see
Sign-in and premium actions. Hub, port and device commands use the
local Hub API unless you add --cloud or --computer <id or name>.
This computer
Command
What it does
enroll [--code <code>]
Add this computer to an organisation (--token, --name, --replace, --no-browser)
Diagnostic checks with suggested fixes; --fix applies safe fixes
Doctor checks
ID
Check
CBX001
Each local service responds
CBX002
Connect is reachable (reports the proxy in use)
CBX003
The computer is enrolled, and Connect lists it when you are signed in
CBX004
The clock is within 60 seconds of Connect's
CBX005
The services report no errors
CBX006
USB host controllers' endpoint use
CBX007
The log directory's disk has free space
CBX008
The services' ports belong to Cambrionix services
CBX009
CLI sign-in status
CBX010
Hub commands can use this computer's enrollment instead of your sign-in
doctor --fix restarts services that don't respond. It exits with code 6 when a check fails.
Services
The local services are relay (port 43420), hub (43424), recorder (43426) and device
(43430).
Command
What it does
services list
Each service's status, version and uptime
services show <service>
A service's details: version, directories, capabilities
services config get <service> [key]
A service's configuration, or one key
services config set <service> <key> <value>
Change one configuration key
services errors [<service>]
Errors the services report
services restart <service>… | --all
Restart, then wait until the service answers again
services shutdown <service>… | --all
Stop through the OS service manager (alias stop)
services start <service>… | --all
Start through the OS service manager
services update check|apply|status
Check for, install and follow Hub API updates
restart uses the service's own restart endpoint when it has one, otherwise systemd, launchd or
the Windows service manager (--os always uses the service manager). shutdown and start need
administrator rights. If the CLI can't find a service's name in the service manager, set
CAMBRIONIX_SERVICE_HUB (or _RELAY, _RECORDER, _DEVICE) to it.
Hubs
Command
What it does
hubs list [--watch]
Hubs on this computer; with --cloud, the organisation's hubs
hubs show <hub>
One hub's state and ports
hubs reboot <hub>
Reboot a hub
hubs settings get|set|reset <hub>
Hub settings
hubs power show|save|revert <hub>
Power limits and power setup (premium)
hubs firmware status <hub>
Firmware version
hubs firmware update <hub>
Install the latest firmware, through Connect
Ports
<port> is a port number or all.
Command
What it does
ports list <hub>
Mode, attached device, battery, current and schedule per port
ports mode <hub> <port> on|off|detect|charge
Set port mode (on is charge and data)
ports led <hub> <port> <colour> [--pattern p]
LED colour and flash pattern
ports lock|unlock <hub> <port>
Lock a port
ports power-limit <hub> <port> <watts>
Power delivery limit, 4.5–60 W (premium)
ports charge <hub> <percent> [--then off|trickle]
Charge every port to a target level (premium)
ports dfu <hub> <port>
Put Apple devices into DFU mode (premium)
ports reboot-device <hub> <port>
Reboot Apple devices (premium)
ports schedule show|set|clear|options …
Port mode schedules (premium to change)
A schedule is a JSON array, inline or from a file with @schedule.json:
cambrionix-cliportsscheduleset HUB-1234 all \'[{"time":"08:00","days":["mon","tue","wed","thu","fri"],"action":{"mode":"on"}}, {"time":"18:00","days":["mon","tue","wed","thu","fri"],"action":{"mode":"target","target":80}}]'
Devices and USB
Command
What it does
devices list [--hub <hub>]
Attached devices, optionally on one hub (--watch)
devices show <id>
One device
devices lock|unlock <id>
Lock a device
usb endpoints
Endpoint and memory use per USB host controller
Logs and support
Command
What it does
logs list [-s <service>]
Log files per service
logs show [-s …] [--level] [--grep] [--since]
Recent lines, merged across services in time order