CLI version of the client

[drdoc-bot]

Overview

This PR adds a command-line interface (CLI) client for YSTP, allowing you to share files directly from the terminal without needing to use the web interface.

Features

Commands

• ystp send <file> - Sends a file and returns a shareable 5-word mnemonic code
• ystp receive <code> - Receives a file using the shareable code
• --output <filename> - Optional flag to specify output filename when receiving

Options

• --host <hostname> - Connect to a different host (default: localhost)
• --port <port> - Connect to a different port (default: 8787)

Protocol Implementation

The CLI follows the exact WebSocket protocol:

• 64KB chunk size for file transfers
• JSON metadata (filename and size)
• EOF marker to signal end of transfer
• LET_IT_RIP approval mechanism for receiver consent
• Progress display during transfers (percentage and MB transferred)

Usage Examples

Send a file:

node cli/ystp.js send myfile.txt

Or after running npm link:

ystp send myfile.txt

Output:

✓ Connected to server
✓ Sending file: myfile.txt (12345 bytes)
✓ Share this code with the receiver:
  kitchen-alpha-bravo-charlie-delta-echo

Waiting for receiver to approve...
✓ Receiver approved!
  Progress: [===========>] 95% (11.7 KB / 12.3 KB)
✓ File sent successfully!

Receive a file:

node cli/ystp.js receive kitchen-alpha-bravo-charlie-delta-echo

Or with a custom output filename:

ystp receive kitchen-alpha-bravo-charlie-delta-echo --output downloaded.txt

Output:

✓ Connected to server
✓ File ready: myfile.txt (12345 bytes)
✓ Transfer approved
  Progress: [===========>] 95% (11.7 KB / 12.3 KB)
✓ File received: myfile.txt

Connect to a different server:

ystp send myfile.txt --host myserver.com --port 3000

Changes Made

New Files

• cli/ystp.js - Full-featured CLI client implementation

Modified Files

• package.json - Added ws dependency and bin entry point

Installation

After merging, users can:

1. Install dependencies:

npm install

2. For global usage (optional):

npm link
ystp send myfile.txt

3. Or use directly with node:

node cli/ystp.js send myfile.txt

Technical Details

• Uses ws package for WebSocket client implementation in Node.js
• Supports both wss:// (secure) and ws:// (insecure) protocols
• Properly handles binary data chunks (ArrayBuffer) vs text messages (JSON/strings)
• Graceful error handling and connection management
• Works seamlessly without any additional setup

[deathbyknowledge]

@drdoc what if I wanted to do npx ystp, would this work as is?