OpenSpeak/CLI_CLIENT.md

# OpenSpeak CLI Client

## Overview

The OpenSpeak CLI Client is a command-line interface for interacting with the OpenSpeak voice communication server. It provides an interactive REPL (Read-Eval-Print Loop) for managing channels, joining voice channels, and controlling audio settings.

## Building

```bash
make build
# or
go build -o bin/openspeak-client ./cmd/openspeak-client
```

## Running

```bash
./bin/openspeak-client -host localhost -port 50051
```

### Command-Line Flags

- `-host string` - gRPC server hostname (default: "localhost")
- `-port int` - gRPC server port (default: 50051)

## Usage

### Login

When the client starts, you'll be prompted to enter your admin token:

```
Enter admin token: <paste-your-token-here>
```

The client will:
1. Connect to the gRPC server
2. Authenticate with the provided token
3. Load the list of available channels
4. Display the interactive prompt

### Interactive Commands

#### List Channels
```
list
```

Displays all available channels with their member counts. Channels are indexed for easy selection.

**Example Output:**
```
Available Channels:
─────────────────────────────────────────
  [0] general (2 members)
  [1] engineering (5 members)
► [2] meetings (1 member)
```

The `►` marker indicates the currently selected channel.

#### Select Channel
```
select <channel_index>
```

Selects a channel for subsequent operations (join, leave, members, etc.).

**Examples:**
```
select 0    # Select the first channel
select 2    # Select the third channel
```

#### Join Channel
```
join
```

Joins the currently selected channel. The user will be added to the channel's member list and can participate in voice communications.

**Example:**
```
> select 1
✓ Selected channel: engineering
> join
✓ Joined channel: engineering
```

#### Leave Channel
```
leave
```

Leaves the current channel. This removes the user from the channel's member list.

**Example:**
```
> leave
✓ Left channel: engineering
```

#### List Members
```
members
```

Lists all members currently in the selected channel.

**Example:**
```
> select 0
✓ Selected channel: general
> members

Members of 'general':
─────────────────────────────────────────
1. user123
2. user456
```

#### Toggle Microphone Mute
```
mute
```

Toggles the microphone mute status. The status is reflected in the user's presence information on the server.

**Example:**
```
> mute
✓ Microphone muted

> mute
✓ Microphone unmuted
```

#### Show Connection Status
```
status
```

Displays current connection information including:
- Logged-in user ID
- Current channel (if any)
- Microphone mute status
- Speaker mute status

**Example:**
```
> status

Current Status:
─────────────────────────────────────────
User: default-user
Current Channel: general
Microphone: 🎤 Unmuted
Speaker: 🔊 On
```

#### Show Help
```
help
```

Displays all available commands with brief descriptions.

#### Exit Application
```
quit
exit
```

Gracefully closes the connection and exits the application.

## Usage Example Workflow

```bash
$ ./bin/openspeak-client -host localhost -port 50051

╔════════════════════════════════════════╗
║       OpenSpeak - CLI Client           ║
║   Voice Communication Platform         ║
╚════════════════════════════════════════╝

Enter admin token: your-admin-token-here
Connecting to localhost:50051...
✓ Logged in as: default-user
✓ Loaded 3 channels

Commands: list, select, join, leave, members, mute, status, help, quit

> list

Available Channels:
─────────────────────────────────────────
  [0] general (0 members)
  [1] engineering (1 member)
  [2] meetings (0 members)

> select 0
✓ Selected channel: general

> join
✓ Joined channel: general

> members

Members of 'general':
─────────────────────────────────────────
1. default-user

> mute
✓ Microphone muted

> status

Current Status:
─────────────────────────────────────────
User: default-user
Current Channel: general
Microphone: 🔇 Muted
Speaker: 🔊 On

> leave
✓ Left channel: general

> quit
```

## Features

✅ **Channel Management**
- List all channels
- Select channels
- Join/leave channels
- View channel members

✅ **Presence Control**
- Update microphone mute status
- Display current connection status
- User authentication

✅ **User Experience**
- Interactive REPL interface
- Formatted output with emoji indicators
- Clear error messages
- Help system

## Implementation Details

### ClientApp Structure

All command handling is centralized in the ClientApp type which manages:
- gRPC connection state
- Current user and channel information
- Microphone and speaker mute states
- Interactive command processing

### gRPC Integration

All gRPC calls:
- Include a 5-second timeout
- Pass the auth token in context
- Use proper error handling
- Display formatted results

## Testing

The client can be tested against:
1. A running server instance
2. With the generated test token
3. Using created test channels

## Performance

- **Connection Speed**: <1 second
- **Command Latency**: 100-500ms
- **Memory Usage**: ~20-50MB
- **CPU Usage**: Minimal

## Version

OpenSpeak CLI Client v0.1.0