From b8e57cefec807d2eb15b8fd5d7bbfa12e5c3f583 Mon Sep 17 00:00:00 2001 From: miro Date: Tue, 21 May 2024 02:24:50 +0100 Subject: [PATCH] update pairing --- docs/02_create.md | 70 +++++++++++++++++++++++++++++++++++++++++++--- docs/03_pairing.md | 63 +---------------------------------------- 2 files changed, 67 insertions(+), 66 deletions(-) diff --git a/docs/02_create.md b/docs/02_create.md index 99e85d3..ec46ef4 100644 --- a/docs/02_create.md +++ b/docs/02_create.md @@ -1,6 +1,6 @@ -## Creating a Hive +# Creating a Hive -### Minds +## Minds When creating a Hive the first step is to add a Mind to it, this is "the brain" of the hive and is expected to handle natural language queries @@ -14,8 +14,68 @@ Once you have at least 1 Mind in your hive you can start connecting things to it ![imagem](https://github.com/JarbasHiveMind/HiveMind-community-docs/assets/33701864/fb241c4d-ca84-4b47-b917-b398b16f93bd) +### Managing Clients -### Terminals / Satellites +`hivemind-core` provides a command line interface to manage client permissions + +```bash +$ hivemind-core --help +Usage: hivemind-core [OPTIONS] COMMAND [ARGS]... + +Options: + --help Show this message and exit. + +Commands: + add-client add credentials for a client + allow-msg allow message types sent from a client + delete-client remove credentials for a client + list-clients list clients and credentials + listen start listening for HiveMind connections +``` + +```shell +$ hivemind-core add-client --help +Usage: hivemind-core add-client [OPTIONS] [NAME] [ACCESS_KEY] [PASSWORD] + [CRYPTO_KEY] + + add credentials for a client + +Options: + --help Show this message and exit. +``` + +```shell +$ hivemind-core delete-client --help +Usage: hivemind-core delete-client [OPTIONS] NODE_ID + + remove credentials for a client + +Options: + --help Show this message and exit. +``` + +```shell +$ hivemind-core list-clients --help +Usage: hivemind-core list-clients [OPTIONS] + + list clients and credentials + +Options: + --help Show this message and exit. + +``` + +```shell +$ hivemind-core allow-msg --help +Usage: hivemind-core allow-msg [OPTIONS] MSG_TYPE [NODE_ID] + + allow message types sent from a client + +Options: + --help Show this message and exit. +``` + +## Terminals / Satellites A terminal is something that allows you to interact with your hive, it connects to a Mind setup in the previous step @@ -24,8 +84,9 @@ A terminal is something that allows you to interact with your hive, it connects - [Flask Chatroom](https://github.com/JarbasHiveMind/HiveMind-flask-template) - reference implementation for a web application that connects to a mind backend side - [Remote Cli](https://github.com/OpenJarbas/HiveMind-cli) - a command line application to chat with a Mind +See the [pairing](https://jarbashivemind.github.io/HiveMind-community-docs/03_pairing/) documentation for further details -### Bridges +## Bridges A bridge connects some existing service to a Mind, it is like a terminal but depends on some intermediate service @@ -35,3 +96,4 @@ A bridge connects some existing service to a Mind, it is like a terminal but dep - [Twitch Bridge](https://github.com/OpenJarbas/HiveMind-twitch-bridge) - [DeltaChat Bridge](https://github.com/JarbasHiveMind/HiveMind-deltachat-bridge) + diff --git a/docs/03_pairing.md b/docs/03_pairing.md index c4548be..492dbd2 100644 --- a/docs/03_pairing.md +++ b/docs/03_pairing.md @@ -2,70 +2,9 @@ You can register clients in a Mind via command line or via audio -## Managing Clients - -hivemind-core provides a command line interface to manage client permissions - -```bash -$ hivemind-core --help -Usage: hivemind-core [OPTIONS] COMMAND [ARGS]... - -Options: - --help Show this message and exit. - -Commands: - add-client add credentials for a client - allow-msg allow message types sent from a client - delete-client remove credentials for a client - list-clients list clients and credentials - listen start listening for HiveMind connections -``` - -```shell -$ hivemind-core add-client --help -Usage: hivemind-core add-client [OPTIONS] [NAME] [ACCESS_KEY] [PASSWORD] - [CRYPTO_KEY] - - add credentials for a client - -Options: - --help Show this message and exit. -``` - -```shell -$ hivemind-core delete-client --help -Usage: hivemind-core delete-client [OPTIONS] NODE_ID - - remove credentials for a client - -Options: - --help Show this message and exit. -``` - -```shell -$ hivemind-core list-clients --help -Usage: hivemind-core list-clients [OPTIONS] - - list clients and credentials - -Options: - --help Show this message and exit. - -``` - -```shell -$ hivemind-core allow-msg --help -Usage: hivemind-core allow-msg [OPTIONS] MSG_TYPE [NODE_ID] - - allow message types sent from a client - -Options: - --help Show this message and exit. -``` - ## Command Line Pairing -You need to register the satellite devices in the HiveMind **server** as discussed above +First, you need to register the satellite devices in the HiveMind **server** ```bash $ hivemind-core add-client