From ea5862d15bf201f6179049832301ce0dceeae181 Mon Sep 17 00:00:00 2001 From: Diego Rodrigues de Sa e Souza <8016841+diegosouzapw@users.noreply.github.com> Date: Fri, 17 Jul 2026 16:58:59 -0300 Subject: [PATCH] docs(readme): animate CLI command list + compression flow as SMIL SVGs (#7637) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs(readme): animate CLI command list + compression flow as SMIL SVGs Two more README ASCII/text blocks become hand-authored animated SVGs (SMIL only, GitHub -sandbox safe, DESIGN_SYSTEM.md palette), following the tier-cascade / pool / combo pattern: - cli-terminal.svg — compact terminal window (640x500) cycling three real CLI screens (providers list / combo list / health) with character-by-character typing, output formats copied from the actual bin/cli printers (headings, column layout, status colors, circuit breaker block), plus a scrolling ticker carrying the full 30-subcommand list the image replaces (also preserved in the img alt). - compression-pipeline.svg — the 'Client -> 10 engines -> Provider' flow line as an animated funnel: 10,000 tok in, ~1,080 tok out, token dots evaporating engine by engine behind the cells, RTK -> Caveman default stack highlighted, a code token passing through untouched (always preserved byte-perfect) and the stacked savings math badge. Registered both in docs/diagrams/README.md (hand-authored table). * docs(changelog): add fragment for #7637 (CLI terminal + compression SVGs) * docs(readme): enlarge CLI terminal diagram (full-width, 1200x700) Per review: the mini 640x500 terminal read too small. Rebuild it as a full-width widescreen terminal (viewBox 1200x700, embedded at width=100%) with larger type, wider aligned columns, 6 provider rows and 4 combo rows so each screen fills the frame. Same 3 real CLI screens, same SMIL, same DESIGN_SYSTEM.md palette, same command-ticker footer. --- README.md | 6 +- .../7637-readme-cli-compression-svg.md | 1 + docs/diagrams/README.md | 2 + docs/diagrams/cli-terminal.svg | 120 +++++++++++ docs/diagrams/compression-pipeline.svg | 198 ++++++++++++++++++ 5 files changed, 323 insertions(+), 4 deletions(-) create mode 100644 changelog.d/maintenance/7637-readme-cli-compression-svg.md create mode 100644 docs/diagrams/cli-terminal.svg create mode 100644 docs/diagrams/compression-pipeline.svg diff --git a/README.md b/README.md index 450865fcf3..bcdb6ef202 100644 --- a/README.md +++ b/README.md @@ -502,7 +502,7 @@ Tokens are scoped `read` / `write` / `admin`; process-spawning routes stay loopb
-`providers` · `oauth` · `keys` · `combo` · `nodes` · `models` · `cache` · `compression` · `cost` · `usage` · `quota` · `health` · `resilience` · `telemetry` · `logs` · `audit` · `mcp` · `a2a` · `cloud` · `memory` · `skills` · `eval` · `tunnel` · `backup` · `sync` · `webhooks` · `policy` · `pricing` · `translator` · `simulate` … +Animated terminal demoing the OmniRoute CLI — omniroute providers list, omniroute combo list, omniroute health — cycling over the 80+ command surface: providers · oauth · keys · combo · nodes · models · cache · compression · cost · usage · quota · health · resilience · telemetry · logs · audit · mcp · a2a · cloud · memory · skills · eval · tunnel · backup · sync · webhooks · policy · pricing · translator · simulate …
@@ -582,9 +582,7 @@ Code blocks, URLs and structured data are **always preserved** byte-perfect. **O ### 📖 How it works — pipeline, architecture & savings math -``` -Client (10,000 tok) ──▶ OmniRoute Compression (10 engines) ──▶ Provider (~1,080 tok, up to 95% saved) -``` +OmniRoute compression pipeline: a client request of 10,000 tokens passes through 10 stacked engines — Session-Dedup, CCR, RTK, Headroom, Relevance, Caveman, LLMLingua-2, Lite, Aggressive, Ultra — and reaches the provider at about 1,080 tokens, up to 95% saved. Code, URLs and JSON are always preserved byte-perfect. Default stacked combo runs `RTK → Caveman`. When both act on the same tool/context payload, savings compound: diff --git a/changelog.d/maintenance/7637-readme-cli-compression-svg.md b/changelog.d/maintenance/7637-readme-cli-compression-svg.md new file mode 100644 index 0000000000..e71439fcc6 --- /dev/null +++ b/changelog.d/maintenance/7637-readme-cli-compression-svg.md @@ -0,0 +1 @@ +- **README animated diagrams, round 3** (`docs/diagrams/cli-terminal.svg`, `docs/diagrams/compression-pipeline.svg`): the CLI subcommand list becomes a mini animated terminal (3 real commands typed and answered with formats copied from the actual `bin/cli` printers + a scrolling 30-subcommand ticker), and the compression flow line becomes an animated 10-engine funnel (10,000→~1,080 tok, RTK → Caveman stack highlighted, code token always preserved). SMIL-only, DESIGN_SYSTEM.md palette, GitHub ``-sandbox safe — completing the set from #7615/#7626. Both registered in `docs/diagrams/README.md`. diff --git a/docs/diagrams/README.md b/docs/diagrams/README.md index 18543d6959..196f6a5853 100644 --- a/docs/diagrams/README.md +++ b/docs/diagrams/README.md @@ -32,6 +32,8 @@ inside GitHub's `` sandbox: | [tier-cascade.svg](./tier-cascade.svg) | README.md (root) | Animated 4-tier auto-fallback cascade (16s loop, 4 acts). Edit the SVG directly — there is no `.mmd` source. | | [pool-fair-share.svg](./pool-fair-share.svg) | README.md (root) | Animated key-pool fair-share quota (generous → strict, 16s loop). Edit the SVG directly — there is no `.mmd` source. | | [combo-always-on.svg](./combo-always-on.svg) | README.md (root) | Animated priority-combo fallback (4 layers, 16s loop). Edit the SVG directly — there is no `.mmd` source. | +| [cli-terminal.svg](./cli-terminal.svg) | README.md (root) | Animated terminal cycling 3 CLI commands (providers/combo/health) + subcommand ticker (18s loop). Edit the SVG directly — there is no `.mmd` source. | +| [compression-pipeline.svg](./compression-pipeline.svg) | README.md (root) | Animated 10-engine compression funnel (8s loop). Edit the SVG directly — there is no `.mmd` source. | ## How to update diff --git a/docs/diagrams/cli-terminal.svg b/docs/diagrams/cli-terminal.svg new file mode 100644 index 0000000000..4a853aca10 --- /dev/null +++ b/docs/diagrams/cli-terminal.svg @@ -0,0 +1,120 @@ + + + + + + + + + + + + + + + + + + + + + + omniroute — 80+ commands + + + + + $ + + omniroute providers list + + + + + + + + OmniRoute Providers + + 1f3a9c2e  anthropic   Claude Max 20x    active + + 8c2d5b1a  codex       Codex Pro (team)  active + + f4e0a97b  glm         GLM Coding Plan   active + + 03bd6e5f  kimi        Kimi K2 free      active + + 9d4e1a08  gemini-cli  Gemini 2.5 Pro    active + + b7c3f26d  copilot     GPT-5 (Copilot)   active + + … 253 more connections + + + + + + + $ + + omniroute combo list + + + + + + + + OmniRoute Combos + +   ● always-on     [priority      ] enabled + +   ○ cost-saver    [cost-optimized] enabled + +   ○ fusion-panel  [fusion        ] enabled + +   ○ context-relay [context-relay ] enabled + + + + + + + $ + + omniroute health + + + + + + + + OmniRoute Health + +   Status: healthy + +   Uptime: 4d 12h 33m + +   Requests (24h): 18,412 + +   Circuit Breakers + +     ● closed     24 + +     ○ half-open  1 + +     ○ open       0 + + + + + + + + + providers · oauth · keys · combo · nodes · models · cache · compression · cost · usage · quota · health · resilience · telemetry · logs · audit · mcp · a2a · cloud · memory · skills · eval · tunnel · backup · sync · webhooks · policy · pricing · translator · simulate … + providers · oauth · keys · combo · nodes · models · cache · compression · cost · usage · quota · health · resilience · telemetry · logs · audit · mcp · a2a · cloud · memory · skills · eval · tunnel · backup · sync · webhooks · policy · pricing · translator · simulate … + + + diff --git a/docs/diagrams/compression-pipeline.svg b/docs/diagrams/compression-pipeline.svg new file mode 100644 index 0000000000..e03d5293a5 --- /dev/null +++ b/docs/diagrams/compression-pipeline.svg @@ -0,0 +1,198 @@ + + + + + + + + + + + + + + + + + + + + + + + + CLIENT + 10,000 tok + prompt · tools · history + + + + + + + OMNIROUTE COMPRESSION — 10 ENGINES + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + {} + + + + + + + + + + + + 1 + Session + Dedup + + + + + + + + 2 + CCR + + + + + + + + 3 + RTK + + + + + + + + 4 + Headroom + + + + + + + + 5 + Relevance + + + + + + + + 6 + Caveman + + + + + + + + 7 + LLM + Lingua-2 + + + + + + + + 8 + Lite + + + + + + + + 9 + Aggressive + + + + + + + + 10 + Ultra + + + + + + default stack: RTK → Caveman + + + { } code · URLs · JSON — always preserved byte-perfect + + + + PROVIDER + ~1,080 tok + + + + up to 95% saved + + + + + + combined = 1 − (1−RTK)×(1−Caveman) → avg 89.2% · range 78.4–94.6% + +