Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

HiveMind Remi

A small web GUI for testing connections to a hivemind-core server. It is built with the Remi framework, so the interface is a local web page driven entirely by Python. Fill in your server credentials, connect, and chat with your assistant from the browser.

demo

Where it sits

HiveMind is a mesh. Satellite devices connect to a central hivemind-core server over an authenticated, encrypted protocol. Remi is a throwaway test satellite. It wraps the Python hivemind-bus-client in a GUI so you can check that a server and access key work, and watch utterances and spoken replies flow, without writing any code.

Remi web GUI (hivemind-bus-client)  ──encrypted──►  hivemind-core  ──►  OVOS / agent

Install

pip install hivemind-remi

Or from source:

git clone https://github.com/JarbasHiveMind/HiveMind-remi
cd HiveMind-remi
pip install .

Runtime dependencies (remi, hivemind-bus-client, ovos-bus-client, ovos-utils) are declared in pyproject.toml, the single source of truth for packaging. See docs/dependencies.md for the version policy.

Quickstart

1. Run a server and issue an access key

On the machine hosting the assistant, install and run hivemind-core:

hivemind-core add-client      # prints an access key + crypto/password key
hivemind-core listen --port 5678

2. Launch Remi

HiveMind-remi

Remi serves its GUI as a local web page and opens it in your browser.

3. Connect and chat

On the Connect tab, fill in:

Field Value
Host the server address, e.g. ws://127.0.0.1 (use wss:// for TLS)
Port the server's HiveMind port (default 5678)
Access Key the key from hivemind-core add-client
Password / Crypto Key the password / crypto key for that client
Language the utterance language tag (default en-us)
Accept self signed tick if the server uses a self-signed TLS cert

Click Connect. When the status reads Connected to HiveMind!, switch to the Chat tab, type a message, and press Send. The assistant's spoken responses appear in the chat log.

Documentation

Full docs live in docs/:

License

Apache 2.0. See LICENSE.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hivemind_remi-1.0.0a3.tar.gz (31.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hivemind_remi-1.0.0a3-py3-none-any.whl (26.8 kB view details)

Uploaded Python 3

File details

Details for the file hivemind_remi-1.0.0a3.tar.gz.

File metadata

  • Download URL: hivemind_remi-1.0.0a3.tar.gz
  • Upload date:
  • Size: 31.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for hivemind_remi-1.0.0a3.tar.gz
Algorithm Hash digest
SHA256 cf11558d4e424bc33442ff07c9cfc68806a0a49a44fc1695759ad1e48ad66ae5
MD5 b55aff3df809ff907e990b7f9b7371c0
BLAKE2b-256 86e3c3c14a92d609366065f4e6116423f5ca08f095b3e28c0dff937dc9438664

See more details on using hashes here.

File details

Details for the file hivemind_remi-1.0.0a3-py3-none-any.whl.

File metadata

File hashes

Hashes for hivemind_remi-1.0.0a3-py3-none-any.whl
Algorithm Hash digest
SHA256 28d39ff7effa7a70ed805a8e809065ec4c86f89cbb4bc6a1553f4bdc5402c606
MD5 be4987a7daeb554d7b60cbe821a7ab5e
BLAKE2b-256 f15218843d4b78b6b6087d243c6e21c3223ad44a4ec3fc94d896a16e4c9534b4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page