Skip to content

Codebase intelligence for AI and humans: code health scores, auto-generated docs, git analytics, dead code detection, and architectural decisions via MCP.

docs(vscode): add hero gif and screenshots to extension README and docs (#696)

Raghav Chamadiya31bd5fde81c6
diff --git a/docs/VSCODE.md b/docs/VSCODE.md
index bf4956163..fefabc0b7 100644
--- a/docs/VSCODE.md
+++ b/docs/VSCODE.md
@@ -6,6 +6,10 @@ same index serves both you and your AI coding agent. It is a thin client over
the local `repowise` CLI and server: everything is computed on your machine and
nothing about your code leaves it through the extension.
+<p align="center">
+ <img src="https://raw.githubusercontent.com/repowise-dev/repowise/main/packages/vscode/media/gifs/hero.gif" alt="Repowise for VS Code: the knowledge graph and health dashboard in an editor tab, gutter heat and a refactoring plan copied to your agent, and a change-risk read before you push, all from one local index" width="100%" />
+</p>
+
## Install
1. Install the CLI: `pip install repowise` (or `uv tool install repowise`).
@@ -42,6 +46,10 @@ you have not opened. It is dismissible per change set, never a popup, and
tunable or off in settings (`repowise.changeIntel.*`). Plenty of edits
legitimately touch only part of a cluster, so it informs without nagging.
+<p align="center">
+ <img src="https://raw.githubusercontent.com/repowise-dev/repowise/main/packages/vscode/media/screenshots/change-risk-panel.png" alt="The Change Risk panel: an 8.8/10 score, downstream and missing-test chips, and the riskiest files in the change ranked by hotspot" width="90%" />
+</p>
+
## Editor-native signals
- **Gutter heat**: a severity-tiered strip next to lines with findings in the
@@ -60,6 +68,13 @@ legitimately touch only part of a cluster, so it informs without nagging.
the Problems panel (`repowise.diagnostics.enabled`). The quieter surfaces
above carry the full detail either way.
+<table>
+ <tr>
+ <td width="50%"><img src="https://raw.githubusercontent.com/repowise-dev/repowise/main/packages/vscode/media/screenshots/gutter-and-score.png" width="100%" alt="Gutter heat strip and the file's health score in the status bar" /><br><sub><b>Gutter heat + status-bar score</b></sub></td>
+ <td width="50%"><img src="https://raw.githubusercontent.com/repowise-dev/repowise/main/packages/vscode/media/screenshots/refactoring-codelens.png" width="100%" alt="A refactoring plan shown as a CodeLens above the class it targets, with a copy-for-agent action" /><br><sub><b>Refactoring plan as a CodeLens, copy-for-agent</b></sub></td>
+ </tr>
+</table>
+
## Tree views
A single Repowise activity-bar container with a **Home** overview, a
@@ -76,6 +91,14 @@ app uses (no duplicated components): **health overview**, **architecture map**,
switcher in the Home view keeps them matched to your editor or pinned light or
dark.
+<table>
+ <tr>
+ <td width="33%"><img src="https://raw.githubusercontent.com/repowise-dev/repowise/main/packages/vscode/media/screenshots/health-dashboard.png" width="100%" alt="The code-health dashboard with defect, maintainability, and performance signals and a health map" /><br><sub><b>Health overview</b></sub></td>
+ <td width="33%"><img src="https://raw.githubusercontent.com/repowise-dev/repowise/main/packages/vscode/media/screenshots/knowledge-graph.png" width="100%" alt="The interactive knowledge graph of files and their dependencies" /><br><sub><b>Knowledge graph</b></sub></td>
+ <td width="33%"><img src="https://raw.githubusercontent.com/repowise-dev/repowise/main/packages/vscode/media/screenshots/docs-browser.png" width="100%" alt="The docs browser rendering the generated wiki for the repository" /><br><sub><b>Docs browser</b></sub></td>
+ </tr>
+</table>
+
## MCP for your AI agent
One install registers the Repowise MCP server with VS Code, so agent-mode
diff --git a/packages/vscode/README.md b/packages/vscode/README.md
index 6adf3ce58..4729d7e71 100644
--- a/packages/vscode/README.md
+++ b/packages/vscode/README.md
@@ -8,6 +8,10 @@ And because modern code is written by two of you, one install also wires the sam
Everything runs on your machine. Everything is free.
+<p align="center">
+ <img src="https://raw.githubusercontent.com/repowise-dev/repowise/main/packages/vscode/media/gifs/hero.gif" alt="Repowise for VS Code: the knowledge graph and health dashboard in an editor tab, gutter heat and a refactoring plan copied to your agent, and a change-risk read before you push, all from one local index" width="100%" />
+</p>
+
## Know before you push
Click **Analyze Change Risk** in the Source Control view and get the full picture of your uncommitted work in seconds:
@@ -20,6 +24,10 @@ Click **Analyze Change Risk** in the Source Control view and get the full pictur
While you edit, a quiet status-bar hint appears if you are missing a file that usually travels with your change. It never pops up, never interrupts, and is one click to dismiss or turn off.
+<p align="center">
+ <img src="https://raw.githubusercontent.com/repowise-dev/repowise/main/packages/vscode/media/screenshots/change-risk-panel.png" alt="The Change Risk panel: an 8.8/10 score, downstream and missing-test chips, and the riskiest files in the change ranked by hotspot" width="90%" />
+</p>
+
## See health as you work
- **Gutter heat** marks the lines with findings in the file you have open. Glanceable, not shouty.
@@ -29,6 +37,13 @@ While you edit, a quiet status-bar hint appears if you are missing a file that u
- **Refactoring plans appear as a CodeLens** right above the code they target. Open the full plan, or copy it as a ready-to-paste prompt for your agent.
- Prefer the Problems panel? Turn it on in settings. It stays off by default because your problems list belongs to you.
+<table>
+ <tr>
+ <td width="50%"><img src="https://raw.githubusercontent.com/repowise-dev/repowise/main/packages/vscode/media/screenshots/gutter-and-score.png" width="100%" alt="Gutter heat strip and the file's health score in the status bar" /><br><sub><b>Gutter heat + status-bar score.</b> Every finding, right where the line is.</sub></td>
+ <td width="50%"><img src="https://raw.githubusercontent.com/repowise-dev/repowise/main/packages/vscode/media/screenshots/refactoring-codelens.png" width="100%" alt="A refactoring plan shown as a CodeLens above the class it targets, with a copy-for-agent action" /><br><sub><b>Refactoring plan as a CodeLens.</b> One click copies it as a prompt for your agent.</sub></td>
+ </tr>
+</table>
+
## Explore the big picture
Full dashboards open right in an editor tab, no browser needed:
@@ -40,6 +55,14 @@ Full dashboards open right in an editor tab, no browser needed:
- **Decision timeline**: the "why" behind your codebase, mined from its history.
- **Docs browser**: always-current documentation for the file you are in.
+<table>
+ <tr>
+ <td width="33%"><img src="https://raw.githubusercontent.com/repowise-dev/repowise/main/packages/vscode/media/screenshots/health-dashboard.png" width="100%" alt="The code-health dashboard with defect, maintainability, and performance signals and a health map" /><br><sub><b>Health overview</b></sub></td>
+ <td width="33%"><img src="https://raw.githubusercontent.com/repowise-dev/repowise/main/packages/vscode/media/screenshots/knowledge-graph.png" width="100%" alt="The interactive knowledge graph of files and their dependencies" /><br><sub><b>Knowledge graph</b></sub></td>
+ <td width="33%"><img src="https://raw.githubusercontent.com/repowise-dev/repowise/main/packages/vscode/media/screenshots/docs-browser.png" width="100%" alt="The docs browser rendering the generated wiki for the repository" /><br><sub><b>Docs browser</b></sub></td>
+ </tr>
+</table>
+
## One install, two brains
VS Code agent mode sees the Repowise tools automatically after install: no config, no copy-pasting JSON. For other editors and MCP clients, one command writes the config for your workspace. The signal you see in the gutter and the context your agent reasons with come from the same index, so you are never debugging two different opinions about your code.
@@ -48,8 +71,6 @@ VS Code agent mode sees the Repowise tools automatically after install: no confi
Nothing polls, nothing scans in the background, and nothing interrupts you. Data loads when you look at it and is cached until your index changes. Activation adds zero measurable startup time. Every surface is individually toggleable, either in VS Code settings or in the built-in Repowise settings panel.
-<!-- Screenshots / GIFs: drop captures under media/screenshots and link them here before the stable Marketplace release. -->
-
## Getting started
1. Install the CLI: `pip install repowise` (or `uv tool install repowise`).
diff --git a/packages/vscode/media/gifs/hero.gif b/packages/vscode/media/gifs/hero.gif
new file mode 100644
index 000000000..32fb5dba9
Binary files /dev/null and b/packages/vscode/media/gifs/hero.gif differ
diff --git a/packages/vscode/media/screenshots/change-risk-panel.png b/packages/vscode/media/screenshots/change-risk-panel.png
new file mode 100644
index 000000000..141a7e005
Binary files /dev/null and b/packages/vscode/media/screenshots/change-risk-panel.png differ
diff --git a/packages/vscode/media/screenshots/docs-browser.png b/packages/vscode/media/screenshots/docs-browser.png
new file mode 100644
index 000000000..2526e6fa1
Binary files /dev/null and b/packages/vscode/media/screenshots/docs-browser.png differ
diff --git a/packages/vscode/media/screenshots/gutter-and-score.png b/packages/vscode/media/screenshots/gutter-and-score.png
new file mode 100644
index 000000000..08abc1553
Binary files /dev/null and b/packages/vscode/media/screenshots/gutter-and-score.png differ
diff --git a/packages/vscode/media/screenshots/health-dashboard.png b/packages/vscode/media/screenshots/health-dashboard.png
new file mode 100644
index 000000000..a857fd67a
Binary files /dev/null and b/packages/vscode/media/screenshots/health-dashboard.png differ
diff --git a/packages/vscode/media/screenshots/knowledge-graph.png b/packages/vscode/media/screenshots/knowledge-graph.png
new file mode 100644
index 000000000..9099b3235
Binary files /dev/null and b/packages/vscode/media/screenshots/knowledge-graph.png differ
diff --git a/packages/vscode/media/screenshots/refactoring-codelens.png b/packages/vscode/media/screenshots/refactoring-codelens.png
new file mode 100644
index 000000000..2ba423de9
Binary files /dev/null and b/packages/vscode/media/screenshots/refactoring-codelens.png differ