@enspirit/harpocrates

harpocrates

• Usage
• Commands

Usage

$ npm install -g @enspirit/harpocrates
$ harpocrates COMMAND
running command...
$ harpocrates (-v|--version|version)
@enspirit/harpocrates/0.0.11 darwin-x64 node-v12.18.4
$ harpocrates --help [COMMAND]
USAGE
  $ harpocrates COMMAND
...

Commands

• harpocrates autocomplete [SHELL]
• harpocrates help [COMMAND]
• harpocrates hub
• harpocrates invite
• harpocrates join
• harpocrates list-users
• harpocrates receive
• harpocrates repl
• harpocrates send TO
• harpocrates setup

harpocrates autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ harpocrates autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

OPTIONS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

EXAMPLES
  $ harpocrates autocomplete
  $ harpocrates autocomplete bash
  $ harpocrates autocomplete zsh
  $ harpocrates autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

harpocrates help [COMMAND]

display help for harpocrates

USAGE
  $ harpocrates help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

harpocrates hub

Starts a harprocrates hub

USAGE
  $ harpocrates hub

OPTIONS
  -p, --port=port  [default: 3000] port to use for the server

DESCRIPTION
  ...
  This command starts a hub used by users to communicate with each other

See code: src/commands/hub.js

harpocrates invite

Invites a user to join a harprocrates hub

USAGE
  $ harpocrates invite

DESCRIPTION
  ...
  This command connects to a harpocrates hub and generates an invitation token that you can give to another user for 
  them to use with 'harpocrates join'.

See code: src/commands/invite.js

harpocrates join

Join a harpocrates hub for the first time

USAGE
  $ harpocrates join

DESCRIPTION
  ...
  This command allows you to join the harpocrates hub for the first time as a non authenticated member.
  In order to join a hub you need an invitation token.
  Invitation tokens can be generated by users that are already on a hub by using the command: harpocrates invite

See code: src/commands/join.js

harpocrates list-users

List the users connected to the hub

USAGE
  $ harpocrates list-users

See code: src/commands/list-users.js

harpocrates receive

Connect to the hub and wait for messages...

USAGE
  $ harpocrates receive

DESCRIPTION
  This command connects to the harpocrates hub and waits for incoming messages from users

See code: src/commands/receive.js

harpocrates repl

Connect to the hub and wait for messages...

USAGE
  $ harpocrates repl

DESCRIPTION
  This command connects to the harpocrates hub and waits for incoming messages from users

See code: src/commands/repl/index.js

harpocrates send TO

Send a password to another user

USAGE
  $ harpocrates send TO

ARGUMENTS
  TO  the recipient of your message

DESCRIPTION
  ...
  This command connects to the harpocrates hub, waits for the user to connect and then prompts the user for the password 
  that needs to be shared

See code: src/commands/send.js

harpocrates setup

Sets up harprocrates

USAGE
  $ harpocrates setup

OPTIONS
  -f, --force              forces the setup
  -h, --hub=hub            (required) the address of the harpocates hub
  -u, --username=username  (required) [default: llambeau] your username

DESCRIPTION
  ...
  This command initializes harpocrates, creating a new rsa pair for authentication and encryption of messages

See code: src/commands/setup.js