A command-line tool for querying and managing Cisco Unity Connection (CUC) voicemail servers via CUPI REST, PAWS, AST, and DIME APIs.
macOS / Linux
curl -fsSL https://raw.githubusercontent.com/Cloverhound/cupi-cli/main/install.sh | bashWindows (PowerShell)
irm https://raw.githubusercontent.com/Cloverhound/cupi-cli/main/install.ps1 | iexFrom source
git clone https://github.com/Cloverhound/cupi-cli.git
cd cupi-cli
go build -o cupi .Releases for macOS, Linux, and Windows (amd64 and arm64) are published on the Releases page.
# Authenticate — saves credentials to OS keystore
cupi auth login --host cuc.example.com --username admin --server prod --default
# List mailbox users
cupi users list
# Get a specific user
cupi users get jsmith
# Add a user
cupi users add --alias jsmith --dtmf 1001 --first-name John --last-name Smith
# Use a different server for one command
cupi users list --server lab| Resource Group | Commands |
|---|---|
| auth | login, set-credentials, status, logout, list, switch |
| users (mailboxes) | list, get, add, update, remove |
| distlists (distribution lists) | list, get, add, update, remove, members list/add/remove |
| handlers (call handlers) | list, get, add, update, remove |
| cos (class of service) | list, get, update |
| templates (user templates) | list, get |
| schedules | list, get |
| system | system info |
| ast | disk, heartbeat, tftp, alerts, perfmon |
| paws | cluster status/replication, drs backup/status |
| dime | get-file (log download) |
cupi auth login tests connectivity and saves credentials:
- GET
/vmrest/users?rowsPerPage=0with Basic Auth - Validates credentials against the CUC server
- Saves server config to
~/.cupi/config.json - Stores password in the OS keystore
Three credential types are supported per server:
| Type | Used For |
|---|---|
cupi | CUPI REST provisioning (default) |
application | Application-level APIs |
platform | OS admin / platform-level access (PAWS) |
# Login (CUPI credentials)
cupi auth login --host cuc.example.com --username admin --server prod --default
# Add additional credential types
cupi auth set-credentials --type application --username app-user --server prod
cupi auth set-credentials --type platform --username os-admin --server prod
# Show credential status
cupi auth status [--server prod]
# Output:# server=prod (default) host=cuc.example.com version=15.0# cupi : admin [set]# application: app-user [set]# platform : os-admin [set]# Logout one type or all
cupi auth logout --server prod --type application
cupi auth logout --server prod --type all| Format | Flag | Notes |
|---|---|---|
| Table | --output table | Default — auto-width ASCII table |
| JSON | --output json | Pretty-printed; pipe to jq for filtering |
| CSV | --output csv | Pipe to file for spreadsheet import |
| Raw | --output raw | Raw API response |
cupi users list --output json | jq '.[].Alias'
cupi users list --output csv > users.csv| Flag | Description |
|---|---|
--server <name> | Override the default server for this command |
--output json|table|csv|raw | Output format (default: table) |
--debug | Print raw API request/response to stderr |
--max <n> | Limit results to N items, 0 = no limit (default) |
--dry-run | Print what would be sent without making any changes |
Preview write operations without applying them:
cupi --dry-run users add --alias jsmith --dtmf 1001 --first-name John --last-name Smith
cupi --dry-run users remove jsmith
cupi --dry-run distlists add --alias mylist --display-name "My List"Server configuration is stored in ~/.cupi/config.json:
{
"defaultServer": "prod",
"servers": {
"prod": {
"host": "cuc.example.com",
"port": 443,
"version": "15.0",
"credentials": {
"cupi": { "username": "admin" },
"application": { "username": "app-user" },
"platform": { "username": "os-admin" }
}
},
"lab": {
"host": "cuc-lab.example.com",
"port": 443,
"version": "12.5",
"credentials": {
"cupi": { "username": "admin" }
}
}
}
}Passwords are stored in the OS keystore (macOS Keychain, Windows Credential Manager, Linux Secret Service) — never in the config file.
cupi ast disk # Disk partition usage
cupi ast heartbeat # Heartbeat rates
cupi ast tftp # TFTP server statistics
cupi ast alerts # All system alerts
cupi ast alerts --triggered # Only currently triggered alerts
cupi ast perfmon # Perfmon object catalogRequires platform credentials (cupi auth set-credentials --type platform).
cupi paws cluster status # OS-level cluster node info
cupi paws cluster replication # Replication health check
cupi paws drs status # DRS backup/restore status
cupi paws drs backup --sftp-server 10.0.0.5 --sftp-user backup --sftp-password secret --sftp-dir /backupscupi dime get-file /var/log/active/syslog/CiscoSyslog > syslog.txt
cupi dime get-file /var/log/active/tomcat/catalina.out --output /tmp/catalina.out
cupi dime get-file syslog/CiscoSyslog --node 10.0.0.5See skill/SKILL.md for the Claude Code skill definition.
See CLAUDE.md for the full development guide including project layout, build instructions, and key file reference.
# Build
go build -o cupi .# Run integration tests (requires live CUC server)
CUPI_TEST_HOST=cuc.example.com CUPI_TEST_USER=admin CUPI_TEST_PASS=secret \
go test ./tests/ -v -timeout 120s- 12.5 — Supported
- 14.x — Supported
- 15.x — Supported
MIT — see LICENSE