FABRIC/README.md
jeda 88ee6a4cf5 docs: FABRIC is a live display, not a report generator
- Remove static HTML report generation concept
- TUI and web modes are both live, real-time displays
- Add 'fabric web' command for browser dashboard
- Emphasize tail-style log watching and WebSocket updates
- Simplify README to focus on live display purpose

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-02 02:28:51 +00:00

59 lines
1.1 KiB
Markdown

# FABRIC
**Flow Analysis & Bead Reporting Interface Console**
A live display for NEEDLE worker activity, available as TUI or web dashboard.
## Purpose
FABRIC tails NEEDLE's logging output and renders it in real-time. It answers:
- What is each worker doing right now?
- What events are happening across all workers?
- Which workers are active, idle, or erroring?
## Display Modes
### TUI (`fabric tui`)
Live terminal dashboard:
- Worker status grid
- Scrolling log stream
- Worker detail panel
- Keyboard navigation and filtering
### Web (`fabric web`)
Live browser dashboard at `localhost:3000`:
- Worker overview cards
- Real-time activity feed
- Timeline visualization
- WebSocket-powered updates
## Quick Start
```bash
# Terminal dashboard
fabric tui
# Web dashboard
fabric web
```
FABRIC reads from `~/.needle/logs/` by default.
## Relationship to NEEDLE
```
NEEDLE (orchestrates workers) → logs → FABRIC (displays activity)
```
NEEDLE does the work. FABRIC shows you what's happening.
## Status
🚧 **In Development** - See [docs/plan.md](docs/plan.md) for implementation roadmap.
## Documentation
- [Implementation Plan](docs/plan.md)