Skip to content

HiveMind CLI

No microphone, no speaker, no models — just a cursor blinking in a terminal. You type a question, hit enter, and the answer prints back. That's the whole satellite. It's the thinnest possible way to reach your hive: the device does nothing but shuttle text, and hivemind-core carries every bit of the thinking. Which makes it perfect for the moments audio would only get in the way — poking at a new server over SSH, scripting a question into a cron job, or wiring up a headless box that has a network cable and nothing else.

In a nutshell

  • On the device: a terminal, and not one ounce of audio processing.
  • On hivemind-core: everything — STT, TTS, skills, intents. Replies come back as text.
  • Installs as the hivemind-cli console script (pip install HiveMind-cli).
  • The natural choice for testing servers and skills, scripting, and audio-less IoT boxes.

When to use it

  • Testing and debugging a hivemind-core instance or a skill
  • Scripting and automation from a server
  • IoT devices with network connectivity but no audio hardware
  • Any scenario where you want to interact via keyboard or piped input

Install

pip install HiveMind-cli

This provides the hivemind-cli console script — a terminal client with no subcommands, just flags.

Usage

Interactive mode — type utterances and see responses:

hivemind-cli --access-key <key> --password <password> --host wss://192.168.1.10 --port 5678

The host must include the protocol prefix (ws:// or wss://). If --host is omitted, the CLI scans the local network for a HiveMind node via UDP broadcast and asks before connecting.

Plain output (no curses UI) for scripting or SSH sessions:

hivemind-cli --access-key <key> --password <password> --host wss://192.168.1.10 --no-curses

CLI flags

Flag Default Description
--access-key (required) Client access key issued by hivemind-core add-client.
--password None Optional client password.
--host (scan) HiveMind host URI, including protocol: ws://… or wss://….
--port 5678 WebSocket port.
--no-curses off Disable the curses UI; use plain stdout/stdin instead.
--self-signed off Accept self-signed SSL certificates.

See also

For scriptable, non-interactive use, the hivemind-client command from the hivemind-bus-client package offers subcommands such as set-identity, terminal, send-mycroft, escalate, propagate, and ping. That is a separate package from HiveMind-cli.

Next

New to HiveMind? Start with the Quick Start, or learn how the pieces fit in Core Concepts.

Source

Validated against the HiveMind source:

  • hivemind_cli_terminal/__main__.py — flags (--access-key --password --host --port --no-curses --self-signed), the ws:///wss:// host requirement, and the UDP-scan fallback when --host is omitted
  • docs/usage.md — usage walkthrough