@boranseckin/bridge NPM

Bridge - Simple Chat Service

Bridge is a basic CLI chat application using Socket.io.

Install the bridge package by running npm install -g boranseckin/bridge.

Run npx bridge to start the client.
When prompted Server:, enter the server URL in the form of <domain>:<port>/<channel>.
- If you do not specify channel, it will be assumed /.
- If you do not specify port, it will be assumed 3636.
- If you do not specify domain, it will be assumed localhost.
When prompted Username:, enter the desired username.

Run npx bridge-server to start the server.
- If you want to change the default port (3636), use -p <port> argument.
- If you want to open multiple channels, use -c <channel> argument. You can use this argument as many times as you want. The server will open one channel for each -c tag. The default channel (/) will be always open regardless the additional channels.
Example: npx bridge-server -p 1111 -c super -c server
You will see the log of connections on your terminal.

Everything starting with a forward slash (/) is assumed to be a command.

/me <message> is used to send emotes. If sent without a message, acts as a indicator.
/w <to> <message> is used to whisper to a specific user. <to> has to be an online user in the server.
/username <username> is used to change the username.
/room <room> is used to change the room. If the room name is empty, user will be assigned to the #default room.
/ch <channel> is used to change the channel. If the channel name is empty, user will be assigned to the / channel.
/clear is used to clear the chat for the user.
/users is used to list all online users with their room names and IDs.
/id is used to print user's ID.
/server is used to print server's address.
/status is used to print the connection status.
/help is used to print all the usable commands.
/exit is used to exit the program.

This project is licensed under the MIT License - see the LICENSE.md file for details.

3 years ago

6 years ago

6 years ago