Skip to content

Latest commit

 

History

History
81 lines (57 loc) · 2.45 KB

README.md

File metadata and controls

81 lines (57 loc) · 2.45 KB

👏🏻 😎 🚀 😻

whir.io

 

Alpha ES7 codebeat badge Codacy Badge Downloads Dependency status

As a developer, I use my command line a lot so why not integrate chat directly into it?
whir aims to close this gap by providing a simple, flexible, extend-able and blazing fast chat environment, without having to install additional applications.

whir does not store messages in any form.

Installation

whir is written in JavaScript and you should have installed the latest version of Nodejs.

$> npm i -g whir.io

Options

  • --user || -u: Your username (per channel) Required
  • --channel || -c: Channel you are joining (or creating) Default: [random]
  • --host || -h: Whir's host Default: chat.whir.io
  • --pass || -p: Password, for private channels
  • --mute || -m: Mute this conversation

Chat

$> whir.io --user=stefan --channel=friends

or

$> whir.io -u stefan -c friends

or

// Random channel and muted conversation.
$> whir.io -u stefan -m

or

// Running whir on your own server/domain.
$> whir.io -u stefan -c friends -h myawesomedomain.chat

Help

Once connected, type /help for a list of basic commands.
Type /exit to leave at any time.

Notes

You can also setup and run your own whir server.
Here's how to do that: https://github.com/WhirIO/Server

Contribute

fork https://github.com/WhirIO/Client

License

MIT