https://github.com/sakiib/chat-server
Simple Chat Server CLI on Top of TCP
https://github.com/sakiib/chat-server
chat cli tcp-client tcp-server
Last synced: 4 months ago
JSON representation
Simple Chat Server CLI on Top of TCP
- Host: GitHub
- URL: https://github.com/sakiib/chat-server
- Owner: sakiib
- License: apache-2.0
- Created: 2022-10-16T10:57:01.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-10-17T10:05:07.000Z (over 2 years ago)
- Last Synced: 2025-01-02T05:16:44.545Z (5 months ago)
- Topics: chat, cli, tcp-client, tcp-server
- Language: Go
- Homepage:
- Size: 2.58 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Demo Chat Server using Cobra CLI on Top of TCP
## Build
```bash
$ go build -o chat .
```
## Available commands for the CLI
```bash
$ ./chat --help
Usage:
chat [flags]
chat [command]
Available Commands:
client connects the client to the chat server
completion Generate the autocompletion script for the specified shell
help Help about any command
server starts the chat server
Flags:
-h, --help help for chat
```
## Start the chat server
```bash
$ ./chat server
```
## Join the chat server as a client (an Unique ID will be assigned to the client on joining)
```bash
# open several windown & run this command
$ ./chat client
# each client will be assigned a randomly generated ID within range of int64
10 joined the chat
successfully joined the chat server
10 joined the chat
51 joined the chat
successfully joined the chat server
10 joined the chat
51 joined the chat
21 joined the chat
successfully joined the chat server
```
## Available commands for the connected client
```bash
# Join & run help
$ help
help
Available Commands:
whoAmI - sends the client's self identity
userList - lists the connected clients(ID)
sendMessage - sends messages to all the clients
sendToUsers - sends messages to the client with provided IDs
help - lists all the available commands
```
## Expected output for the client commands
```bash
# for the client with ID 21
$ whoAmI
whoAmI? My ID 21
# list the users
$ userList
10, 51, 21
# send messages to all the users
# all the connected users will receive this message
$ sendMessage hello world!
# send message to users providing their IDs along with message
# only the connected users from the usersList will receive the message
# IDs must be enclosed by [] separated by commas
$ sendToUsers hello world [21,51]
```
## Static Demo
### whoAmI command demo
### sendMessage {message} command demo
### sendToUsers {message} []userList command demo
