Mercury CLI
A command-line interface for managing and automating Broadworks provisioning operations.
Installation
Prerequisites
- Python 3.12 or higher
- Access to a Broadworks provisioning server
Getting Started
Launch the CLI by running:
mercury-cli
On first launch, you will be prompted to authenticate with your Mercury server credentials:
- Username
- Password
- Server URL (e.g., https://mercury.example.com/webservice/services/ProvisioningService)
- TLS option (defaults to yes)
Skip Authentication (Development)
For testing purposes, you can skip the login prompt via the --no-login flag:
mercury-cli --no-login
Available Commands
General Commands
| Command | Description |
|---|---|
help [command] |
Display available commands or get help for a specific command |
sysver |
Display the current system software version |
clear |
Clear the terminal screen |
exit |
Exit the CLI |
Bulk Operations
The CLI supports bulk creation and modification operations using CSV files.
Bulk Create
| Command | Description |
|---|---|
bulk create hunt_group <file_path> |
Create hunt groups from CSV |
bulk create call_pickup <file_path> |
Create call pickup groups from CSV |
bulk create call_center <file_path> |
Create call centers from CSV |
bulk create auto_attendant <file_path> |
Create auto attendants from CSV |
Bulk Modify
| Command | Description |
|---|---|
bulk modify call_center agent_list <file_path> |
Modify call center agent lists from CSV |
Plugin Commands
Mercury CLI supports a plugin system for extending functionality.
| Command | Description |
|---|---|
plugin list |
List all available plugins |
Loaded plugins automatically register their own commands and subcommands.
Features
- Tab completion for commands and file paths
- Command history with auto-suggest
- Input validation
- Progress indicators for long-running operations
- Detailed error reporting for bulk operations
Metadata
Release files for mercury-cli 1.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mercury_cli-1.1.0.tar.gz | 19.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mercury_cli-1.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 44.4 kB
Release files / mercury_cli-1.1.0.tar.gz
| Download URL | mercury_cli-1.1.0.tar.gz |
|---|---|
| Size | 19.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3ad367d82799a4b5575028027bad4208b4c5df7fa6a4aa16dfb0b884dfdbb94e
|
|
BLAKE2b-256 checksum How to use checksums |
2c0ed15310e6be042c402e56fdcdf2cb3dc3f8397dca92fd66d03a73314e8c17
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.9.28 {"installer":{"name":"uv","version":"0.9.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / mercury_cli-1.1.0-py3-none-any.whl
| Download URL | mercury_cli-1.1.0-py3-none-any.whl |
|---|---|
| Size | 24.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
df3b6643afd005af90f7bd16ae07db79213092996ce0062c085475220a04ebc3
|
|
BLAKE2b-256 checksum How to use checksums |
ba5200cf6b09672fe48184296561adf477310fb7933ac2c58d790aaa0dcb6cc9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.9.28 {"installer":{"name":"uv","version":"0.9.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
