Skip to content

explainer.md

Latest commit

 

History

History
46 lines (34 loc) · 2.28 KB

explainer.md

File metadata and controls

46 lines (34 loc) · 2.28 KB

Claw Explainer

What this project is

This repo builds a local multi-agent workflow on top of OpenClaw:

  • gateway container runs OpenClaw and mounts shared state.
  • searxng container provides local web search.
  • cli/claw is a Bash CLI that manages a JSON task board (data/shared/dashboard.json).
  • Four workspaces are prepared (lead, dev, designer, marketer) and all share data/product/.

In short: it is a lightweight task orchestration layer (JSON + shell) around an OpenClaw gateway.

Main flow

  1. scripts/setup.sh prepares .env, data folders, token, and initial dashboard.
  2. docker compose up -d starts OpenClaw + SearXNG.
  3. docker/gateway/entrypoint.sh copies committed config, initializes workspaces, installs the SearXNG skill, then launches openclaw gateway run.
  4. Agents are expected to run heartbeat loops and coordinate through claw commands and WORKING.md.

Key files

  • docker-compose.yml: service wiring, ports, mounts.
  • config/config.json: OpenClaw gateway/agent configuration.
  • config/dashboard.json: dashboard seed.
  • workspaces/: workspace definitions copied into /data/workspace-*.
  • docker/gateway/entrypoint.sh: bootstraps runtime state.
  • cli/claw: dashboard/task CLI.
  • scripts/setup.sh: host-side first-run setup.
  • agent-management.md: step-by-step process for adding/removing agents safely.

Behavior guarantees (current)

  • Task IDs and setup token generation are safe under set -euo pipefail.
  • Task/subtask/deliverable mutations now validate IDs and fail clearly on invalid inputs.
  • Status handling supports todo as an alias and stores normalized pending.
  • claw tasks supports --agent, and claw deliverables supports optional task ID (all when omitted).
  • claw check supports:
    • claw check for dashboard + gateway health
    • claw check <agent> for agent check-in workflow
  • OpenClaw is WS-first; if claw check reports unreachable, validate via docker exec claw-gateway openclaw agents list.
  • OpenClaw config defines explicit agents.list entries for lead, dev, designer, marketer.

Practical takeaway

This is a file-first multi-agent orchestration system: Docker runs OpenClaw, Bash CLI manages workflow state in JSON, and agents coordinate through shared workspace files plus heartbeat routines.