Giter Club home page Giter Club logo

cli-messenger's Introduction

CLI Messenger

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

Cli Messenger Demo

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 <server-address>

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
  • 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 <name> will change your chat display name
  • .file will open a file dialog window, so you can select a file to send

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.