Metadata-Version: 2.4
Name: mercury-cli
Version: 0.2.1b0
Summary: A CLI wrapper for Mercury-OCIP
Author-email: Jordan Prescott <devteam@fourteenip.com>, Michael Clarke <devteam@fourteenip.com>, Billy Kelly <devteam@fourteenip.com>
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: prompt-toolkit>=3.0.52
Requires-Dist: argparse>=1.4.0
Requires-Dist: asciimatics>=1.15.0
Requires-Dist: fourteen-prompt-toolkit-action-completer>=1.2.2
Requires-Dist: rich>=14.2.0
Requires-Dist: mercury-ocip>=1.0.1b0
Dynamic: license-file

# 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:

```bash
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:

```bash
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  

---
