Skip to content

Commit b114edd

Browse files
committed
docs: Quick Navigation + /fswarmmax showcase + statusline prereqs
- Add <a id="top"></a> anchor + Quick Navigation table matching morgen-mcp / cli-maxxing convention. - Add "back to top" chips after Built on Ruflo, What's different, Install, /f* skill family, Cues quick reference, and Usage examples. - Extend Status-line indicators with a prerequisites [!NOTE] block explaining the cli-maxxing + Ghostty requirement and the file-probe paths any other terminal can watch to render equivalent indicators. - Add "### The /fswarmmax showcase" under Usage examples — a 15-agent-ultrathink calendar-scheduling demo paired with morgen-mcp, framed as scheduling the week against the lunar cycle. - Fix "Nathan's layer" -> "Nate's layer" in What's different section.
1 parent d852c96 commit b114edd

1 file changed

Lines changed: 79 additions & 1 deletion

File tree

README.md

Lines changed: 79 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
<a id="top"></a>
2+
13
<div align="center">
24

35
# FidgetFlo — Multi-agent AI orchestration for Claude Code
@@ -28,6 +30,21 @@ If you want the real thing, use Ruflo: **https://github.com/ruvnet/ruflo**. If y
2830

2931
---
3032

33+
## Quick Navigation
34+
35+
| Link | Section | What it does | Time |
36+
|---|---|---|---|
37+
| [Built on Ruflo](#built-on-ruflo) | Attribution | What this fork inherits from ruvnet/ruflo | ~1 min |
38+
| [What's different from Ruflo](#whats-different-from-ruflo) | Overview | The thin layer on top: skills, defaults, branding | ~1 min |
39+
| [Install](#install) | Setup | Claude Code + source install paths | ~2 min |
40+
| [The `/f*` skill family](#the-f-skill-family-effort-tier-system) | Reference | 10 slash commands × 5 thinking tiers | ~3 min |
41+
| [Cues & commands quick reference](#cues--commands-quick-reference) | Reference | Terse cheatsheet | ~1 min |
42+
| [Usage examples](#usage-examples) | Reference | Real prompts for `/f*` + `/fhive` + `/fswarmmax` showcase | ~2 min |
43+
| [License](#license) | Meta | MIT, dual copyright ||
44+
| [Links](#links) | Meta | Upstream + related repos ||
45+
46+
---
47+
3148
## Built on Ruflo
3249

3350
All of the actual engineering that makes this useful is Ruflo. Specifically:
@@ -52,14 +69,16 @@ See [`CREDITS.md`](./CREDITS.md) and [`ATTRIBUTION.md`](./ATTRIBUTION.md) for th
5269

5370
## What's different from Ruflo
5471

55-
Nathan's layer on top of ruv's engine:
72+
Nate's layer on top of ruv's engine:
5673

5774
1. **The `/f*` skill family** — 10 slash commands that bind Ruflo's swarm/mini modes to Claude Code's extended-thinking tiers. See [The `/f*` skill family](#the-f-skill-family-effort-tier-system) below. These are 1:1 reimplementations of the existing `r*` skills (`/rswarm`, `/rmini`, etc.) with the `f` prefix and the FIDGETCODING status-line emojis.
5875
2. **Opinionated defaults** — topology is hierarchical-mesh at 15 agents, raft consensus for hive-mind, hybrid memory. Nothing ruv doesn't already offer — just the combo I run daily.
5976
3. **Branding only** — command names, status-line indicators, and docs. No changes to the MCP server, no forked tool semantics, no upstream divergence in logic. If Ruflo ships a fix tomorrow, FidgetFlo can rebase cleanly.
6077

6178
**Assumption flag:** this README assumes FidgetFlo stays a thin rebrand + skill layer. If the fork ever diverges in engine behavior, this section needs a "Divergences" sub-section with the honest list.
6279

80+
<p align="right"><sub><a href="#top">↑ back to top</a></sub></p>
81+
6382
---
6483

6584
## Install
@@ -102,6 +121,8 @@ npx fidgetflo@latest memory search --query "authentication patterns"
102121

103122
Everything under `npx fidgetflo …` is the same CLI surface as the upstream `ruflo` tool. If you already know Ruflo, you already know FidgetFlo.
104123

124+
<p align="right"><sub><a href="#top">↑ back to top</a></sub></p>
125+
105126
---
106127

107128
## The `/f*` skill family (effort tier system)
@@ -150,6 +171,19 @@ While a swarm is active, the Claude Code status line shows a little signal:
150171
- **🍯**`/fmini*` is running (5-agent compact swarm)
151172
- **👑**`/fhive` is running (queen-led hive-mind)
152173

174+
> [!NOTE]
175+
> **Prerequisites for the indicators.** The status-line signals shown
176+
> above render out-of-the-box only if you have
177+
> [cli-maxxing](https://github.com/lorecraft-io/cli-maxxing) installed and
178+
> up to date (it ships the shell integration) AND you're using
179+
> [Ghostty](https://ghostty.org) as your terminal. If you use a different
180+
> terminal (iTerm2, kitty, Alacritty, Warp, etc.), you can wire up an
181+
> equivalent — the indicators are just file probes
182+
> (`/tmp/fidgetflo-mini-active`, `/tmp/fidgetflo-swarm-active`,
183+
> `/tmp/fidgetflo-hive-active`) that any status-line plugin or prompt
184+
> hook can watch. Reference implementation: see cli-maxxing's statusline
185+
> scripts.
186+
153187
### Concrete use cases
154188

155189
- **`/fminimax`** — architecture reasoning, hard debugging, cross-cutting refactors. Five agents, every one of them ultrathinking. Expensive but decisive.
@@ -158,6 +192,8 @@ While a swarm is active, the Claude Code status line shows a little signal:
158192
- **`/fmini`** — one-shot transforms, scaffolding, rename-this-variable-across-the-repo. Tier 0, no thinking, fast and cheap.
159193
- **`/fhive`** — "take this multi-day objective and go." Queen decomposes, workers execute, raft keeps state consistent. Check back later.
160194

195+
<p align="right"><sub><a href="#top">↑ back to top</a></sub></p>
196+
161197
---
162198

163199
## Cues & commands quick reference
@@ -191,6 +227,8 @@ While a swarm is active, the Claude Code status line shows a little signal:
191227
👑 /fhive active
192228
```
193229

230+
<p align="right"><sub><a href="#top">↑ back to top</a></sub></p>
231+
194232
---
195233

196234
## Usage examples
@@ -217,6 +255,46 @@ spin up a swarm ultra on the auth refactor
217255
let a hive take the README
218256
```
219257

258+
### The `/fswarmmax` showcase
259+
260+
When you want maximum overkill — 15 agents, each ultrathinking — paired with a real MCP, here's a calendar scheduling example. Assuming you have [morgen-mcp](https://github.com/lorecraft-io/morgen-mcp) installed:
261+
262+
*Natural language:*
263+
> "Plan next week against the lunar cycle: anchor deep-work to the 4 days around the new moon (peak focus), creative/ideation blocks on the waxing crescent, execution on the first quarter through gibbous, admin-dumps on the full moon, review/edit on the waning gibbous, and rest on the last quarter. Cross-reference NOAA civil-twilight windows at 40.67°N and carve out 3 'stargazing' blocks at peak darkness. Preserve any event whose title contains `[fixed]`. Dry-run the reflow, report the phase-alignment score vs my current week, and apply only on my go-ahead."
264+
265+
*Command-style (same task, explicit invocation):*
266+
267+
```text
268+
/fswarmmax Schedule next week against the lunar cycle:
269+
270+
phase map (synodic month):
271+
new moon ±2d → deep-work clusters (≥120min contiguous)
272+
waxing crescent → creative / ideation
273+
first quarter→gibbous → execution + meetings
274+
full moon → admin + inbox-zero
275+
waning gibbous → review + edit
276+
last quarter→dark → rest (light load only)
277+
278+
pipeline:
279+
- list_events next 7 days; lock any whose title contains "[fixed]"
280+
- resolve moon phase per day (target latitude 40.67°N)
281+
- reflow_day eligible solo blocks into contiguous ≥90min runs
282+
aligned to the phase map (dry_run=true first; dry_run=false
283+
after approval)
284+
- create_event 3x "stargazing" (privacy=private, free_busy=busy,
285+
location="Brooklyn rooftop") at peak-darkness windows per NOAA
286+
civil-twilight tables
287+
- bonus: if a meteor shower peaks this week per the IMO calendar,
288+
place one block at peak hour
289+
290+
Report phase-alignment score (current → proposed). Apply only on
291+
approval.
292+
```
293+
294+
The 15 agents decompose the task across architect (objective formulation), researcher (NOAA/IMO lookups), coder (morgen tool chaining), reviewer (constraint validation), and tester (dry-run verification). You see the full plan before a single event moves.
295+
296+
<p align="right"><sub><a href="#top">↑ back to top</a></sub></p>
297+
220298
---
221299

222300
## License

0 commit comments

Comments
 (0)