Skip to main content

Quick Start

The fastest way to set up Memory Swarm is the interactive onboard wizard:
The wizard walks through 6 steps:
  1. Detect providers — scans your system for Obsidian vaults, markdown folders, GBrain repos, and OpenClaw wikis
  2. Select providers — checkbox UI shows what was detected; ByteRover is always enabled
  3. Configure each provider — prompts for provider-specific settings (paths, API keys, search modes)
  4. Set budget — monthly cost cap for cloud providers (GBrain vector mode uses OpenAI embeddings)
  5. Configure enrichment — choose chained (recommended) or parallel mode for provider coordination
  6. Confirm and write — shows a summary and saves to .brv/swarm/config.yaml
After onboarding, verify everything is working:
Output:

Configuration File

The wizard generates .brv/swarm/config.yaml. You can also edit it manually. Here is a complete example with all sections:

Provider Configuration

ByteRover (Always On)

ByteRover’s context tree is always available. No configuration needed beyond enabled: true.

Obsidian

Local Markdown

Supports multiple folders, each with independent read/write settings.

GBrain

keyword mode requires no API key. hybrid and vector modes use OpenAI embeddings (~$0.001 per query).

Memory Wiki (OpenClaw)

Enrichment Topology

Enrichment edges define how providers feed context to each other. When an edge from: A → to: B is configured, results from provider A are used to expand the query sent to provider B. Chained mode (recommended):
ByteRover searches first, then its top results are used as additional keywords when querying Obsidian and Local Markdown. Parallel mode (no enrichment):
All providers are queried independently with the original query. Faster, but may miss connections between sources.
Enrichment edges must form a DAG (directed acyclic graph). The onboard wizard prevents cycles automatically. If editing manually, brv swarm status will warn about invalid topologies.

Validation

Memory Swarm validates your configuration at runtime. Common issues: Run brv swarm status after any config change to verify all providers are healthy.