Ratel Client (Node.js)

A Node.js client for connecting to Ratel online platform, ported from the original Go implementation.

Installation

Install globally to use the ratel command:

npm install -g ratel-client

Usage

Basic Usage

Connect to local server (default: 127.0.0.1:9999):

ratel

Connect to remote server:

ratel -h 192.252.182.94

Specify custom port:

ratel -h 127.0.0.1 -p 8080

Specify username:

ratel -n nico

Command Options

• -h, --host <host>: Server host address (default: 127.0.0.1)
• -p, --port <port>: Server port (default: 9999)
• -n, --name <name>: Username (default: random Chinese name)
• --help: Show help information
• --version: Show version number

Network Protocols

• TCP: Used for ports ending with 9 (default)
• WebSocket: Used for ports ending with 8

Features

• ✅ TCP and WebSocket connection support
• ✅ Chinese random name generation
• ✅ Shell-like interactive interface
• ✅ Real-time message communication
• ✅ Cross-platform compatibility

Development

Local development:

# Clone repository
git clone <repository-url>
cd ratel-client

# Install dependencies
npm install

# Run locally
node src/index.js --help

License

MIT