Skip to main content

REMI web GUI client for HiveMind — chat with a HiveMind-core server from the browser

Project description

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 verify 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 — it is 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.

Project details


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.0a1.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.0a1-py3-none-any.whl (26.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for hivemind_remi-1.0.0a1.tar.gz
Algorithm Hash digest
SHA256 2aab5dc7d0336ed79b765db934bad863393eb2255fb8b0f277e2cf5915e618f3
MD5 90ac4386479a8ef3786d4e780fab4488
BLAKE2b-256 b149bd93a654933770f6f819621f682ae16764578cb843ef009a91fa090ef7a6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for hivemind_remi-1.0.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 65fe4d9e8bb9d805af473999073432ccda1467d8594567b9c47369660f833457
MD5 5a3adad6d9f05693bba1f21b22998568
BLAKE2b-256 3865aed34fe88fb8dd3b2be76ef0ff43a9272b9cb34b38826356f3ea7fde21f7

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 Pingdom Monitoring Sentry Error logging StatusPage Status page