diff --git a/README.md b/README.md index ffd05fb..df3845e 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Change less. Break less. Know the blast radius of any file before you touch it. # or try it without installing anything: npx @alimaandev/ripple analyze src/your-file.ts - Terminal output of `ripple analyze` — risk, affected files, routes, components, tests, and confidence score + Animated terminal demo of `ripple analyze` — command types in, then the report builds up: risk score with gauge, affected files, routes, components, tests, and confidence @@ -388,6 +388,8 @@ A typical agent loop: `impact src/auth/session.ts` before refactoring, the gate still passes. Tool results are JSON text; failures return `isError` results instead of crashing the session. + Flow diagram — an AI agent calls impact on src/auth/session.ts through ripple mcp and gets the blast radius back: 7 affected files, 4 routes, MEDIUM risk + ## Configuration Ripple discovers `ripple.config.ts`, `.js`, `.cjs`, `.mjs`, or `.json` in the diff --git a/assets/hero-animated.svg b/assets/hero-animated.svg new file mode 100644 index 0000000..112460e --- /dev/null +++ b/assets/hero-animated.svg @@ -0,0 +1,147 @@ + + ripple analyze src/authentication/login.ts — animated demo + Animated terminal demo of Ripple impact analysis: the command types in, then the report builds up — MEDIUM risk 34.7/100, 4 routes, 2 components, 1 test, 7 affected files, 100% confidence. + + + + + + + + + + + + + + + + + + + + + + + + ripple analyze src/authentication/login.ts + + + + $ + ripple analyze src/authentication/login.ts + + + + + + + + ripple · impact analysis + · v0.7.0 + + + + + File + src/authentication/login.ts + + + + + Risk + MEDIUM + · 34.7/100 + + + + + + + + Impact + 4 routes + · + 2 components + · + 1 test + + + + + Affected + 7 files + + + + + Max depth + 2 + + + + + Confidence + 100% + + + + + › Top impact + + + + + ● + Dashboard + (2) + + + + + ● + Admin + (1) + + + + + ● + Index TS + (1) + + + + + › Circular dependencies + + + + + ◯ + src/circular/a.ts + → + src/circular/c.ts + → + src/circular/b.ts + → + src/circular/a.ts + + + + + › Affected files (7) + + + + + ├─ src/dashboard/page.tsx + · depth 1 + + + + + └─ src/main.ts + · depth 2 + + diff --git a/assets/mcp-demo.svg b/assets/mcp-demo.svg new file mode 100644 index 0000000..70e3086 --- /dev/null +++ b/assets/mcp-demo.svg @@ -0,0 +1,61 @@ + + Ripple MCP — AI agents risk-check files before touching them + Flow diagram: an MCP client calls ripple mcp with the impact tool for src/auth/session.ts; ripple answers with the blast radius — 7 affected files, 4 routes, MEDIUM risk. + + + + + + + + + + + + + + + + + + + + ripple mcp — risk-checking before the change + + + AI agent + "can I safely touch + session.ts?" + + + + + tools/call + impact + file: src/auth/ + session.ts + maxDepth: 3 + + + + + ripple mcp + runs the real analysis + on your local codebase + (impact · dependents · risk · gate_status) + + + + Blast radius + 7 affected files + 4 routes · 2 components · 1 test + MEDIUM risk · 34.7/100 + + + + + + + + +