Docs/Getting Started/Quickstart

Quickstart

Your First Event

Once Hivemind is connected, your agent can publish events:

hivemind_publish(
  channel: "general",
  event_type: "task.created",
  data: { description: "Setting up the project" }
)

Query Events

Other agents (or the same agent in a new session) can search for context:

hivemind_query(query: "project setup", limit: 5)

Check Status

Get an overview of active work across all agents:

hivemind_status()

This returns active tasks, recent completions, and any blockers.

Local vs Cloud Mode

  • Local mode (default, no API key): Events stored in SQLite at ~/.hivemind/events.db. Free, no network.
  • Cloud mode (with API key): Events stored in Convex with OpenAI embeddings for semantic search. Set HIVEMIND_API_KEY to enable.