Files
WHOOSH/README.md
Claude Code 827e332e16
Some checks failed
WHOOSH CI / speclint (push) Has been cancelled
WHOOSH CI / contracts (push) Has been cancelled
Refresh README and add roadmap
2025-09-20 13:21:56 +10:00

50 lines
2.4 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# WHOOSH Council & Team Orchestration (Beta)
WHOOSH assembles kickoff councils from Design Brief issues and is evolving toward autonomous team orchestration across the CHORUS stack. Council formation/deployment works today, but persistence, telemetry, and self-organising teams are still under construction.
## Current Capabilities
- ✅ Gitea Design Brief detection + council composition (`internal/monitor`, `internal/composer`).
- ✅ Docker Swarm agent deployment with role-specific env vars (`internal/orchestrator`).
- ✅ JWT authentication, rate limiting, OpenTelemetry hooks.
- 🚧 API persistence: REST handlers still return placeholder data while Postgres wiring is finished (`internal/server/server.go`).
- 🚧 Analysis ingestion: composer relies on heuristic classification; LLM/analysis ingestion is logged but unimplemented (`internal/composer/service.go`).
- 🚧 Deployment telemetry: results arent persisted yet; monitoring includes TODOs for task details (`internal/monitor/monitor.go`).
- 🚧 Autonomous teams: joining/role balancing planned but not live.
The full plan and sequencing live in:
- `docs/progress/WHOOSH-roadmap.md`
- `docs/DEVELOPMENT_PLAN.md`
## Quick Start
```bash
git clone https://gitea.chorus.services/tony/WHOOSH.git
cd WHOOSH
cp .env.example .env
# Update DB, JWT, Gitea tokens
make migrate
go run ./cmd/whoosh
```
By default the API runs on `:8080` and expects Postgres + Docker Swarm in the environment. Until persistence lands, project/council endpoints return mock payloads to keep the UI working.
## Roadmap Snapshot
1. **Data path hardening** replace mock handlers with real Postgres reads/writes.
2. **Telemetry** Persist deployment outcomes, emit KACHING events, build dashboards.
3. **Autonomous loop** Drive team formation/joining from composer outputs, tighten HMMM collaboration.
4. **UX & governance** Admin dashboards, compliance hooks, Decision Records.
Refer to the roadmap for sprint-by-sprint targets and exit criteria.
## Working With Councils
- Monitor issues via the API (`GET /api/v1/councils`).
- Inspect generated artifacts (`GET /api/v1/councils/{id}/artifacts`).
- Use Swarm to watch agent containers spin up/down during council execution.
## Contributing
Before landing features, align with roadmap tickets (`WSH-API`, `WSH-ANALYSIS`, `WSH-OBS`, `WSH-AUTO`, `WSH-UX`). Include Decision Records (UCXL addresses) for architectural/security changes so SLURP/BUBBLE can ingest them later.