@bnjkhr/cli-chat-client
v1.2.4
Published
Terminal chat client (TUI)
Downloads
1,788
Readme
CLI-Chat Client
A beautiful terminal-based chat application with real-time messaging, multiple chat rooms, and admin controls.
Features
- 🚀 Real-time messaging with Socket.io
- 💬 Multiple chat rooms
- 👥 User presence tracking
- 🔒 Secure authentication with Supabase
- 🎨 Beautiful terminal UI with blessed
- 📱 Direct messages (DMs)
- 👑 Admin commands (ban, kick, room management)
- ⌨️ Intuitive keyboard shortcuts
Installation
Install globally using npm:
npm install -g @bnjkhr/cli-chat-clientUsage
Simply run the command:
cli-chatOn first launch, you'll see the login screen where you can register a new account or log in with existing credentials.
Registration
- Press
Tabto switch to registration mode - Enter your email, username, and password
- Confirm your email (check your inbox)
- Log in with your credentials
Logging In
- Enter your email and password
- Press
Enterto submit
Commands
Once logged in, you can use the following commands:
General Commands
/help- Show all available commands/join #room- Join a chat room/rooms- List all available rooms/users- List users in current room/msg @username message- Send a private message/quitor/exit- Exit the chat
Admin Commands
(Only available for admin users)
/admin create-room <name> [description]- Create a new chat room/admin ban <username> [reason]- Ban a user/admin unban <username>- Unban a user/admin kick <username> [reason]- Kick a user (temporary)/admin delete-room- Delete the current room
Keyboard Shortcuts
Ctrl+C- Exit the applicationEnter- Send message / Submit formTab- Switch between login and registration modeUp/Down- Navigate through chat history
Requirements
- Node.js 16 or higher
- Active internet connection
- Valid email address for registration
Technology Stack
- blessed - Terminal UI framework
- Socket.io - Real-time communication
- Supabase - Authentication and database
- Axios - HTTP client
Support
Found a bug or have a feature request? Please open an issue on GitHub.
License
MIT © bnjkhr
