Skip to content

Releases: vedanta/ui-cli

v1.0.0 "Glazed" 🍩

04 Dec 03:57

Choose a tag to compare

First Stable Release

UI-CLI is now production-ready! Manage your UniFi infrastructure from the command line.

Features

Cloud API Commands

  • sites list - List all sites with health status
  • devices list - List UniFi devices across sites
  • clients list - List connected clients
  • hosts list - List UniFi hosts (consoles)
  • isp metrics - ISP performance metrics and uptime
  • sdwan list - SD-WAN configuration and status

Local Controller Commands

  • lo health - Controller health dashboard
  • lo clients - Client management (list, block, unblock, kick)
  • lo devices - Device management (list, restart)
  • lo networks - Network/VLAN listing
  • lo vouchers - Guest WiFi voucher management
  • lo speedtest - Run and view speed tests

Client Groups

  • Static groups with manual MAC membership
  • Auto groups with pattern rules (vendor, hostname, network, IP)
  • Bulk actions: block/unblock/kick entire groups

MCP Server (Claude Desktop Integration)

  • 21 AI-optimized tools for natural language control
  • Easy installation: ./ui mcp install

Developer Experience

  • Multiple output formats: table, JSON, CSV, TSV
  • Shell completions (bash, zsh, fish)
  • Docker support
  • 119 unit tests

Installation

git clone https://github.com/vedanta/ui-cli.git
cd ui-cli
pip install -e .

Documentation

πŸ“– Online Docs | πŸ“˜ README


🍩 Glazed - The classic, essential release that everything else builds on.

v0.3.0 - Claude Desktop Integration

03 Dec 22:07

Choose a tag to compare

πŸ€– Claude Desktop Integration (MCP Server)

Manage your UniFi network using natural language through Claude Desktop!

Setup

./ui mcp install    # Add to Claude Desktop
./ui mcp check      # Verify installation
# Restart Claude Desktop

Available Tools (16 total)

Category Tools
Status & Health network_status, network_health, internet_speed, run_speedtest, isp_performance
Counts & Lists client_count, device_list, network_list
Lookups find_client, find_device, client_status
Actions block_client, unblock_client, kick_client, restart_device, create_voucher

Example Prompts

  • "How many devices are on my network?"
  • "What's my internet speed?"
  • "Block the kids iPad"
  • "Create a guest WiFi voucher"

⚑ Quick Timeout & Spinners

Better UX for local commands with progress indicators and faster failure detection.

Usage

./ui lo -q health              # Quick mode (5s timeout)
./ui lo --timeout 60 health    # Custom timeout

Changes

  • Default timeout reduced from 30s β†’ 15s
  • Spinners on all local commands
  • UNIFI_NO_SPINNER env var for CI/CD
  • Auto-disable spinners when CI=true or NO_COLOR is set

Full Changelog: v0.2.0...v0.3.0

v0.2.0 - Local Controller API

01 Dec 18:40

Choose a tag to compare

What's New

This release introduces Local Controller API support, allowing direct connection to your UniFi Controller (UDM, Cloud Key, or self-hosted) for real-time network management.

Highlights

  • Direct Controller Access - Connect directly to your UDM, Cloud Key, or self-hosted controller
  • Client Management - List, block, unblock, and monitor network clients with detailed status
  • Device Control - Restart, upgrade, locate, and adopt UniFi devices
  • Traffic Analytics - DPI statistics and daily/hourly bandwidth reports
  • Guest Vouchers - Create and manage hotspot vouchers
  • Config Export - Backup your running configuration to YAML/JSON

New Commands

Local Controller (./ui lo)

Command Description
lo health Site health summary
lo clients list/get/status/block/unblock/kick Client management
lo devices list/get/restart/upgrade/locate/adopt Device control
lo networks list View networks and VLANs
lo firewall list/groups Inspect firewall rules
lo portfwd list View port forwarding
lo vouchers list/create/delete Guest voucher management
lo dpi stats/client DPI traffic analysis
lo stats daily/hourly Traffic statistics
lo events list View recent events
lo config show Export running config

Configuration

Add these to your .env file for local controller access:

UNIFI_CONTROLLER_URL=https://192.168.1.1
UNIFI_CONTROLLER_USERNAME=admin
UNIFI_CONTROLLER_PASSWORD=yourpassword
UNIFI_CONTROLLER_SITE=default
UNIFI_CONTROLLER_VERIFY_SSL=false

Breaking Changes

None. This release is fully backward compatible with v0.1.0.

Upgrade Instructions

cd ui-cli
git pull origin main
pip install -e .

Quality

  • 87 tests (71 unit, 16 integration)
  • All tests passing

Full Changelog: v0.1.0...v0.2.0