repo-walkthrough

Installation
SKILL.md

Repo Walkthrough Skill

Turn any repository (local directory, public GitHub repo, private GitHub repo, or git diff) into an interactive architecture graph website and an optional voice-narrated MP4 walkthrough video.

Output Options

Support two modes (ask the user which they want if not specified, or default to Website first and offer Website + Video):

  1. Option 1: Website (--mode website)
    • Generates a standalone interactive architecture viewer (index.html + data.js) where users can explore the layered graph, click any file or connection to inspect its role and code, and play a step-by-step voice-narrated walkthrough.
    • Synthesizes Gemini TTS audio (audio/step-*.wav) when GEMINI_API_KEY is available, or falls back to browser speech synthesis with --no-tts.
  2. Option 2: Website + Video (--mode video)
    • Builds the interactive website first, synthesizes Gemini TTS narration, and renders an animated MP4 walkthrough video (<slug>-walkthrough.mp4) that steps through each layer and highlights files as they are discussed.

Prerequisites

Run node ~/projects/repo-walkthrough/scripts/build_walkthrough.mjs --check-prereqs to check the environment.

Installs
1
GitHub Stars
380
First Seen
14 days ago
Security Audits