Skip to content

armgit / ruflo

Public Imported from GitHub
0

🌊 The original agent harness. Deploy intelligent multi-player swarms, coordinate autonomous workflows, and build conversational AI systems. Features adaptive memory, self-learning intelligence, federation, vector RAG integration, and native Claude Code / Codex / Hermes and many more Integrated

docs: README walkthrough GIF recorded from the narrow cockpit so it reads on mobile and desktop; a wide one linked

ruve372bb79548e
diff --git a/README.md b/README.md
index e0362ce2b0..2c06bc9a58 100644
--- a/README.md
+++ b/README.md
@@ -50,9 +50,9 @@ User --> Ruflo (CLI/MCP) --> Router --> Swarm --> Agents --> Memory --> LLM Prov
---
-<p align="center"><img src="docs/assets/ruflo-console-tour-9x11.gif" alt="The ruflo console inside Claude Code: the dial-up boot bringing every area online, then all 26 pages in order, each as bordered cards under a grouped nav, with Start here steps where a page has an order" width="480"></p>
+<p align="center"><img src="docs/assets/ruflo-console-walkthrough.gif" alt="A walkthrough of the ruflo console inside Claude Code, in its narrow layout so it reads on a phone: the boot checking every area, the main menu entering and its cards folding, the nav, pages, the command palette, ruHelp, settings and refresh" width="420"></p>
-<sub>The <code>/ruflo</code> console running in Claude Code, full screen in a 9:11 frame (the cockpit docked beside Claude, cropped to the cockpit): the dial-up boot that brings every area online, then all 26 pages in order (a mission goal typed and planned along the way): each page is bordered cards under a grouped nav, a Start here card leads the pages that have an order, and each page can launch its plugin commands in Claude or ask Claude about what you see. A <a href="docs/assets/ruflo-console-tour.gif">wide-terminal tour</a> with Claude beside it is also kept. <code>npx ruflo init</code>, restart Claude Code, then <code>/ruflo</code>.</sub>
+<sub>The <code>/ruflo</code> console running in Claude Code, shown in its narrow layout (the cockpit docked beside Claude, cropped to the cockpit) with large text so it reads on a phone as well as a desktop: the boot that checks every area, the main menu entering and its cards folding, the grouped nav, a few pages, the command palette (a tag on every entry for what it does), <b>ruHelp</b> (built-in help: ask a question, get steps with buttons; a guide for every capability), settings and refresh. A <a href="docs/assets/ruflo-console-walkthrough-wide.gif">wide-display walkthrough</a> shows the same console with room for every label. <code>npx ruflo init</code>, restart Claude Code, then <code>/ruflo</code>.</sub>
**Install the mods from the ruflo marketplace** (Claude Code 2.1.287 or later; mods run with your account's permissions and are not sandboxed, so read the code first):
diff --git a/docs/assets/ruflo-console-walkthrough-wide.gif b/docs/assets/ruflo-console-walkthrough-wide.gif
new file mode 100644
index 0000000000..6fd9df0cee
Binary files /dev/null and b/docs/assets/ruflo-console-walkthrough-wide.gif differ
diff --git a/docs/assets/ruflo-console-walkthrough.gif b/docs/assets/ruflo-console-walkthrough.gif
new file mode 100644
index 0000000000..27e751251b
Binary files /dev/null and b/docs/assets/ruflo-console-walkthrough.gif differ
diff --git a/v3/docs/adr/ADR-420-console-tool-coverage-audit-and-live-smoke.md b/v3/docs/adr/ADR-420-console-tool-coverage-audit-and-live-smoke.md
index b1dfa615f6..e9d1669fa4 100644
--- a/v3/docs/adr/ADR-420-console-tool-coverage-audit-and-live-smoke.md
+++ b/v3/docs/adr/ADR-420-console-tool-coverage-audit-and-live-smoke.md
@@ -51,3 +51,7 @@ The smoke and the recording copy the person's Claude login (`~/.claude/.credenti
## 6. Tests
`RUFLO_E2E_LIVE=1 bash plugins/ruflo-console/scripts/e2e-smoke.sh` (28 views, plus the debug-log check): 0 failures after the fixes. Without `RUFLO_E2E_LIVE=1` it still prints SKIP and exits 0, which `smoke.sh` step 15 checks.
+
+## Amendment (2026 10 03): the README walkthrough is the narrow cockpit
+
+GitHub shrinks the README GIF to the reader's screen width, so a 126-column cockpit is unreadable on a phone. The README now leads with `docs/assets/ruflo-console-walkthrough.gif`, recorded from the narrow cockpit (60 columns, a 40-row pane, 22 px type, short captions, cropped to the cockpit and to above Claude's own prompt lines, 776 x 1018), and links `ruflo-console-walkthrough-wide.gif` (the wide cockpit, where each icon spells its word). Both are recorded from a live pane with an isolated config and a trimmed read-only copy of the marketplace (so Plugins and the Catalog have content; nothing is installed), running the committed code of the release; no model turn is made. Watching them found defects no spec had: see the last amendments of ADR-430.