https://github.com/mykeels/cli-messenger

A cli tool for owning your chats
https://github.com/mykeels/cli-messenger

anonymous chat cli messenger node

Last synced: 6 months ago
JSON representation

A cli tool for owning your chats

• Host: GitHub
• URL: https://github.com/mykeels/cli-messenger
• Owner: mykeels
• License: mit
• Created: 2019-05-14T12:04:08.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-30T17:39:28.000Z (over 2 years ago)
• Last Synced: 2024-11-19T01:07:27.253Z (7 months ago)
• Topics: anonymous, chat, cli, messenger, node
• Language: JavaScript
• Homepage:
• Size: 872 KB
• Stars: 32
• Watchers: 3
• Forks: 5
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# CLI Messenger

A tool that provides an interface for owning your own chats.

![Cli Messenger Demo](https://repository-images.githubusercontent.com/186613581/bc52ed00-7660-11e9-8412-5ad53b31051a)

## Installation

- Run `npm i -g cli-messenger` or `yarn add global cli-messenger`

## Development

- Clone this repository

- Run `npm install` in this directory

- Run `npm run link`

## Usage

- To start a chat server on localhost, run `cli-messenger`

- To start a chat server with port forwarding to ngrok, run `NGROK=true cli-messenger`. Inspect the terminal for the ngrok address

- To connect with the chat server, run `cli-messenger connect` in a separate terminal.

- To specify a custom server address such as an ngrok address, run `cli-messenger connect `

## Environment Variables

- PORT (server): `PORT=4000 cli-messenger` will run the chat server on port `4000`

- NGROK (server): `NGROK=true cli-messenger` will port forward the chat server to [ngrok.io](https://ngrok.io)

- DISPLAY_NAME (client): `DISPLAY_NAME=Mykeels cli-messenger connect` will set my chat display name to `Mykeels`

- SILENT (client): `SILENT=true cli-messenger connect` will prevent playing notification sounds

- MESSAGE_SOUND_FILE (client): `MESSAGE_SOUND_FILE=/Users/mykeels/music/my-sound.mp3 cli-messenger connect` will play `my-sound.mp3` everytime a message is received

> For developers, you should copy the `.env.example` file to a `.env` file, so you can set the variables within it in bulk

## Chat Commands

In the chat client, there are commands to control the user's experience. Every command is prefixed with dot (.), so

- `.help` will show all available commands and their usage information

- `.list` will list all users available in the chat

- `.name ` will change your chat display name

- `.file` will open a file dialog window, so you can select a file to send