@calltelemetry/cli

On-premise appliance management CLI for CallTelemetry. Manage updates, databases, networking, certificates, Docker services, and Cisco JTAPI integration from a single tool.

   ______      ____   ______     __                    __
  / ____/___ _/ / /  /_  __/__  / /__  ____ ___  ___  / /________  __
 / /   / __ `/ / /    / / / _ \/ / _ \/ __ `__ \/ _ \/ __/ ___/ / / /
/ /___/ /_/ / / /    / / /  __/ /  __/ / / / / /  __/ /_/ /  / /_/ /
\____/\__,_/_/_/    /_/  \___/_/\___/_/ /_/ /_/\___/\__/_/   \__, /
                                                            /____/

Install

npm install -g @calltelemetry/cli

Requires Node.js 20+.

Usage

Run ct with no arguments to launch the interactive TUI menu, or use commands directly:

ct                  # Interactive menu
ct status           # Show system health
ct health report    # Managed health report with JSON export
ct update           # Update to latest stable version
ct db status        # Database overview

Documentation

Full in-repo documentation lives under docs/:

• docs/cli-reference.md covers every direct CLI command group, subcommand, and option implemented under src/commands.
• docs/health-report.md covers ct health report, JSON export, disk benchmark defaults, and ct diag showtech correlation.
• docs/tui-and-shell.md covers the full-screen TUI and IOS-style text shell.
• docs/testing-and-coverage.md covers the test and coverage workflow.

Commands

Status

ct status                           # System health dashboard
ct health report                    # Managed health report TUI
ct health report --json ./health.json  # Export support-ready JSON
ct health report --skip-disk-benchmark --json ./health.json

Update

ct update                           # Update to latest stable
ct update 0.8.6                     # Update to specific version
ct update --latest                  # Include pre-releases
ct update --force-upgrade           # Skip RAM/disk checks
ct update --no-cleanup              # Skip Docker cleanup after update
ct update --ipv6                    # Enable IPv6 support
ct rollback                         # Roll back to previous version

Performs pre-flight checks (RAM >= 7.2 GB, disk >= 10% free, Docker 26+), backs up the current compose file, pulls images, and restarts services.

Database

ct db                               # Show status (default)
ct db status                        # Connection and version info
ct db backup                        # Create a backup
ct db restore <file>                # Restore from backup
ct db list                          # List available backups
ct db compact                       # Vacuum and optimize
ct db tables [name]                 # Table sizes (optional filter)
ct db purge <table> <days>          # Purge records older than N days
ct db size                          # Database size on disk
ct db performance                   # WAL timing, IO timing, and pgmetrics latency

Migrations

ct migrate                          # Show migration status (default)
ct migrate status                   # Pending and applied migrations
ct migrate run                      # Run pending migrations
ct migrate rollback [steps]         # Roll back N migrations (default: 1)
ct migrate history                  # Last 10 applied migrations
ct migrate watch --interval 5       # Poll migration progress

Secrets

ct secrets                          # Show secrets status (default)
ct secrets setup                    # Interactive configuration wizard
ct secrets reset                    # Revert to defaults
ct secrets reset-password           # Reset service password (PostgreSQL/Minio)
ct secrets reset-password --service postgres --env-only

Manages credentials for PostgreSQL, NATS, and Minio. Values load with three-tier priority: defaults, .env file, then environment variables. The .env file is written with 0600 permissions and a Docker Compose overlay is generated automatically.

Users

ct users reset-password             # Reset a user account password (interactive)
ct users reset-password --org 1     # Pre-select organization
ct users reset-password --org 1 --user 1  # Pre-select org and user

Queries the running application via RPC to list organizations and users, then resets the selected user's password. Useful for admin account recovery when locked out of the web UI.

Config

ct logging                          # Show current log level
ct logging info                     # Set level (debug|info|warning|error)

ct ipv6                             # Show IPv6 status
ct ipv6 enable                      # Enable IPv6
ct ipv6 disable                     # Disable IPv6

ct postgres status                  # Show PostgreSQL version, profile, and timing status
ct postgres set 17                  # Set version for next update
ct postgres upgrade 17              # Full upgrade with backup/restore

ct certs status                     # Show certificate details
ct certs generate                   # Generate self-signed certificates
ct certs reset                      # Remove and regenerate

PostgreSQL upgrade performs a full backup, swaps the container version, and restores data. Supported versions: 14, 15, 16, 17, 18.

Docker

ct docker                           # Container status (default)
ct docker status                    # Containers, images, and networks
ct docker prune                     # Clean up unused resources
ct docker network                   # Network configuration

Services

ct services                         # Interactive service dashboard
ct services logs <service>          # Service logs
ct services start <service>         # Start a service
ct services stop <service>          # Stop a service
ct services restart <service>       # Restart a service

Diagnostics

ct diag network                     # Interfaces, DNS, gateway, connectivity
ct diag service                     # Systemd and container logs
ct diag database                    # PostgreSQL diagnostics
ct diag showtech                    # Support bundle with embedded health report
ct diag showtech --skip-disk-benchmark
ct diag tesla <ipv4|ipv6> <url>     # Test HTTP connectivity to endpoint
ct diag db-watch --interval 2       # Live database activity monitor
ct diag capture <seconds> [filter]  # Packet capture via tcpdump

JTAPI (Cisco Phone Control)

ct jtapi                            # Show status (default)
ct jtapi status                     # Sidecar connection status
ct jtapi enable                     # Enable the JTAPI sidecar
ct jtapi disable                    # Disable the JTAPI sidecar
ct jtapi troubleshoot               # Run 9-point diagnostic check

Offline / Air-Gapped Deployment

ct offline fetch <version>          # Download config bundle (fast, no images)
ct offline download <version>       # Full bundle with Docker images
ct offline apply <bundle>           # Install bundle on target machine
ct offline list                     # List images in current compose file

fetch downloads configs only. download builds a full offline archive including all Docker images for air-gapped installation.

OS Updates

ct os-updates                       # Automatic OS update status
ct os-updates enable weekly         # Enable daily, weekly, or monthly updates
ct os-updates disable               # Disable automatic updates
ct os-updates run                   # Run OS update now
ct os-updates log                   # Recent OS update history

Observability and Storage

ct otel status                      # Observability profile status
ct otel enable                      # Enable Prometheus/Grafana/Loki/Tempo/exporters
ct otel disable                     # Disable observability stack

ct storage status                   # SeaweedFS profile status
ct storage enable                   # Enable S3-compatible object storage
ct storage disable                  # Disable object storage

Network

ct network                          # Show interfaces, gateway, DNS
ct network address eth0 192.168.10.50/24 192.168.10.1
ct network dns-servers 8.8.8.8 1.1.1.1
ct network domain corp.local
ct network dhcp eth0

Kubernetes

ct k8s status                       # Node, pod, app health, and Helm overview
ct k8s pods                         # List pods
ct k8s nodes                        # List nodes
ct k8s logs <pod> --lines 100       # Pod logs
ct k8s restart <deployment>         # Rollout restart
ct k8s scale <deployment> 2         # Scale deployment replicas
ct k8s diff                         # Helmfile diff
ct k8s sync                         # Helmfile sync
ct k8s runbook                      # Deployment validation checklist

Appliance

ct appliance status                 # Appliance migration summary
ct appliance migrations             # Migration table
ct appliance migrate                # Run pending appliance migrations
ct appliance history                # Completed migration history
ct appliance hardware-check disk    # fio disk hardware benchmark

Load Testing

ct loadtest                         # CURRI policy load tester
ct loadtest xcc                     # Stateful Cisco CUBE XCC load tester
ct loadtest xcc --plain --target-url http://cube.example/xcc

Seed Data

ct seed list                        # Supported seed presets
ct seed run <preset> --org-id 1     # Seed demo/load-test data
ct seed status --org-id 1           # Seed counts and recent runs
ct seed cleanup --org-id 1 --all    # Remove seeded data

Interactive TUI

When run without arguments on a TTY, ct launches an interactive menu built with Ink. Navigate with arrow keys, select with Enter, quit with q.

Categories: Status, Update, Services, Database, Migrations, Security, OS Updates, Diagnostics, Settings, Offline Mode, Tools, Appliance, Shell, Power, and Kubernetes when k3s mode is enabled.

Use ct shell --cli for the IOS-style text shell.

Development

git clone https://github.com/calltelemetry/ct-cli.git
cd ct-cli
yarn install
yarn dev                # Run from source via tsx
yarn build              # Compile TypeScript
yarn test               # Run tests
yarn test:watch         # Watch mode

License

UNLICENSED - Proprietary software of CallTelemetry.