Command Reference

UI-CLI provides four interfaces:

Cloud API - Commands via api.ui.com for multi-site management
Local Controller - Direct connection to your controller for real-time operations
Client Groups - Create named groups for bulk actions (parental controls, IoT management)
Claude Desktop - Natural language control via MCP integration

Command Tree

./ui
├── status              # Check API connection
├── version             # Show CLI version
├── speedtest           # Run speedtest on gateway
├── hosts               # Cloud: manage controllers
├── sites               # Cloud: manage sites
├── devices             # Cloud: manage devices
├── isp                 # Cloud: ISP metrics
├── sdwan               # Cloud: SD-WAN configs
├── groups              # Client groups for bulk actions
├── local (lo)          # Local controller commands
└── mcp                 # Claude Desktop integration

Quick Reference

Cloud API

Command	Description
`./ui status`	Check API connection
`./ui hosts list`	List all controllers
`./ui sites list`	List all sites
`./ui devices list`	List all devices
`./ui devices count --by model`	Count devices by model
`./ui isp metrics`	ISP performance metrics
`./ui sdwan list`	List SD-WAN configs

Local Controller

Command	Description
`./ui lo health`	Site health summary
`./ui lo clients list`	List connected clients
`./ui lo clients status <name>`	Detailed client status
`./ui lo devices list`	List network devices
`./ui lo devices restart <name>`	Restart a device
`./ui lo networks list`	List networks/VLANs
`./ui lo firewall list`	List firewall rules
`./ui lo vouchers create`	Create guest voucher
`./ui lo dpi stats`	DPI statistics
`./ui lo stats daily`	Daily traffic stats
`./ui lo config show`	Export running config

Client Groups

Command	Description
`./ui groups list`	List all groups
`./ui groups create "Name"`	Create static group
`./ui groups auto "Name" --vendor "Apple"`	Create auto group
`./ui groups add <group> <MAC>`	Add member to group
`./ui groups show <group>`	Show group details
`./ui lo clients list -g <group>`	List clients in group
`./ui lo clients block -g <group>`	Block all in group
`./ui lo clients unblock -g <group>`	Unblock all in group

See Client Groups for full documentation.

Claude Desktop (MCP)

Tool	Description
`network_health`	Network health summary
`client_count`	Count connected clients
`find_client`	Find client by name
`block_client`	Block a client
`block_group`	Block all clients in a group
`restart_device`	Restart a device
`create_voucher`	Create guest WiFi code

See Claude Desktop for full tool list and setup instructions.

Output Formats

All commands support multiple output formats:

./ui devices list              # Table (default)
./ui devices list -o json      # JSON
./ui devices list -o csv       # CSV
./ui lo config show -o yaml    # YAML (config only)

Common Options

Option	Short	Description
`--output`	`-o`	Output format: table/json/csv/yaml
`--verbose`	`-v`	Show additional details
`--yes`	`-y`	Skip confirmation prompts
`--help`		Show command help

Getting Help

./ui --help                    # All commands
./ui devices --help            # Device commands
./ui lo --help                 # Local commands
./ui lo clients --help         # Client commands