https://github.com/enspirit/harpocrates
Sharing passwords made easy.
https://github.com/enspirit/harpocrates
Last synced: about 2 months ago
JSON representation
Sharing passwords made easy.
- Host: GitHub
- URL: https://github.com/enspirit/harpocrates
- Owner: enspirit
- Created: 2021-06-17T15:54:45.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-05-14T02:26:27.000Z (almost 3 years ago)
- Last Synced: 2025-02-15T08:05:08.906Z (2 months ago)
- Language: JavaScript
- Size: 318 KB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
harpocrates
===========
[](https://oclif.io)
[](https://npmjs.org/package/harpocrates)
[](https://npmjs.org/package/harpocrates)
[](https://github.com/enspirit/harpocrates/blob/master/package.json)
* [Usage](#usage)
* [Commands](#commands)
# Usage
```sh-session
$ 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-autocomplete-shell)
* [`harpocrates help [COMMAND]`](#harpocrates-help-command)
* [`harpocrates hub`](#harpocrates-hub)
* [`harpocrates invite`](#harpocrates-invite)
* [`harpocrates join`](#harpocrates-join)
* [`harpocrates list-users`](#harpocrates-list-users)
* [`harpocrates receive`](#harpocrates-receive)
* [`harpocrates repl`](#harpocrates-repl)
* [`harpocrates send TO`](#harpocrates-send-to)
* [`harpocrates setup`](#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](https://github.com/oclif/plugin-autocomplete/blob/v0.3.0/src/commands/autocomplete/index.ts)_
## `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](https://github.com/oclif/plugin-help/blob/v3.2.2/src/commands/help.ts)_
## `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](https://github.com/enspirit/harpocrates/blob/v0.0.11/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](https://github.com/enspirit/harpocrates/blob/v0.0.11/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](https://github.com/enspirit/harpocrates/blob/v0.0.11/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](https://github.com/enspirit/harpocrates/blob/v0.0.11/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](https://github.com/enspirit/harpocrates/blob/v0.0.11/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](https://github.com/enspirit/harpocrates/blob/v0.0.11/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](https://github.com/enspirit/harpocrates/blob/v0.0.11/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](https://github.com/enspirit/harpocrates/blob/v0.0.11/src/commands/setup.js)_