/odrix-cli

A simple CLI for ODIN@[matrix]

Primary LanguageJavaScript

odrix-cli

A simple CLI for ODRIX (ODIN@matrix)

Usage

$ npm install -g odrix-cli
$ odrix-cli COMMAND
running command...
$ odrix-cli (-v|--version|version)
odrix-cli/1.0.0 darwin-x64 node-v16.13.1
$ odrix-cli --help [COMMAND]
USAGE
  $ odrix-cli COMMAND
...

Known Bug

Das matrix-js-sdk hat einen Bug. Nach dem Aufruf von stopClient() bleibt für beinahe 2 Minuten ein Callback Timer hängen, der das Beenden des NodeJS Prozesses verhindert. Das kann durch Control-C forciert werden.

Commands

Allen Commands können Parameter übergeben werden. Falls das nicht gemacht wird, startet der interaktive Modus und die fehlenden Parameter werden abgefragt.

odrix-cli help [COMMAND]

display help for odrix-cli

USAGE
  $ odrix-cli help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

odrix-cli invitations

List all project we have been invited to join

USAGE
  $ odrix-cli invitations

DESCRIPTION
  List all project we have been invited to join

See code: src/commands/invitations.js

odrix-cli invite [PROJECTID] [USERID]

Invite a user to an existing project.

USAGE
  $ odrix-cli invite [PROJECTID] [USERID]

DESCRIPTION
  Invite a user to an existing project.

See code: src/commands/invite.js

odrix-cli join [PROJECTID]

Join a shared project.

USAGE
  $ odrix-cli join [PROJECTID]

DESCRIPTION
  Join a shared project.

See code: src/commands/join.js

odrix-cli listen

Listen for messages on any joined project layer.

USAGE
  $ odrix-cli listen

DESCRIPTION
  Listen for messages on any joined project layer.

See code: src/commands/listen.js

odrix-cli login

Will login to [Matrix] homeserver using username/password

USAGE
  $ odrix-cli login

DESCRIPTION
  Will login to [Matrix] homeserver using username/password

  On success the resulting data will be stored in a ".env" file in the current folder.

See code: src/commands/login.js

odrix-cli post [LAYERID] [MESSAGE]

Post a message to a joined project layer.

USAGE
  $ odrix-cli post [LAYERID] [MESSAGE]

ARGUMENTS
  LAYERID
  MESSAGE  Must be a JSON formatted message

DESCRIPTION
  Post a message to a joined project layer.

See code: src/commands/post.js

odrix-cli projects

List all project we have joined or shared

USAGE
  $ odrix-cli projects

DESCRIPTION
  List all project we have joined or shared

See code: src/commands/projects.js

odrix-cli share [PROJECTNAME]

Creates a new project and shares it on the [matrix] server

USAGE
  $ odrix-cli share [PROJECTNAME]

DESCRIPTION
  Creates a new project and shares it on the [matrix] server

See code: src/commands/share.js

odrix-cli users

List all users we know (?)

USAGE
  $ odrix-cli users

DESCRIPTION
  List all users we know (?)

See code: src/commands/users.js