Skip to content

Latest commit

 

History

History
93 lines (62 loc) · 1.55 KB

readme.md

File metadata and controls

93 lines (62 loc) · 1.55 KB

Usage

$ npm install -g msgcli
$ msgcli COMMAND
running command...
$ msgcli (--version)
msgcli/0.0.0 linux-x64 node-v20.5.0
$ msgcli --help [COMMAND]
USAGE
  $ msgcli COMMAND
...

Commands

msgcli help [COMMANDS]

Display help for msgcli.

USAGE
  $ msgcli help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for msgcli.

See code: @oclif/plugin-help

msgcli join

Join a room

USAGE
  $ msgcli join [-u <value>] [-r <value>]

FLAGS
  -r, --room=<value>      Room name
  -u, --username=<value>  Username in chat

DESCRIPTION
  Join a room

EXAMPLES
  $ msgcli join

  $ msgcli join --username=Con --room=Room12

  $ msgcli join -u Con -r Room12

See code: dist/commands/join/index.ts

Local Setup

Requirements

  • Node.js (tested on Node v20.5.0)
  • npm (tested on npm v9.8.0)

Steps

  • Run npm install in both cli and server folders.
  • In server, use node index.js for starting backend.
  • In cli, use npm run transpile or npm run build to compile.
  • Use ./bin/run or ./bin/dev in cli for testing.