Skip to content
Back to search

code-walkthrough

MarketplaceWorks with Claude CodeGitHub

Agent skill: interactive walkthroughs that follow one request through real code pinned at a commit, to understand an issue before implementing it

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/liyangtseng--code-walkthrough/badge.svg)](/listings/liyangtseng--code-walkthrough)

HTML

<a href="/listings/liyangtseng--code-walkthrough"><img src="/api/listings/liyangtseng--code-walkthrough/badge.svg" alt="findsafeskills safety rating" /></a>

Install

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

Claude Code, as a plugin:

/plugin marketplace add LiyangTseng/code-walkthrough
/plugin install code-walkthrough@code-walkthrough

Or clone and link the skill into your personal skills:

git clone https://github.com/LiyangTseng/code-walkthrough.git
ln -s "$PWD/code-walkthrough/skills/code-walkthrough" ~/.claude/skills/code-walkthrough

Other agents that read `SKILL.md` files can use `skills/code-walkthrough/` directly. The build needs `git` and Node.js 18 or later.

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

.claude-plugin/marketplace.json · Manifest · 15 lines
  1. {
  2. "name": "code-walkthrough",
  3. "owner": { "name": "LiyangTseng" },
  4. "metadata": { "description": "Code-trace walkthrough skill", "version": "0.1.0" },
  5. "plugins": [
  6. {
  7. "name": "code-walkthrough",
  8. "source": "./",
  9. "description": "Interactive walkthrough pages that follow one request through real code pinned at a commit, to understand an issue before implementing it.",
  10. "version": "0.1.0",
  11. "author": { "name": "LiyangTseng" },
  12. "category": "development"
  13. }
  14. ]
  15. }
README.md · README · 73 lines
  1. English | [繁體中文](README.zh-TW.md)
  2. # code-walkthrough
  3. An agent skill that builds an interactive walkthrough of a codebase before you change it. Point it at a GitHub issue (or a PR, a bug report, a question) and it follows one concrete traveler, such as a request, a token or a batch, through the real code pinned at a commit, until you can see why the task exists and where it lands.
  4. **[Try the live example](https://liyangtseng.github.io/code-walkthrough/examples/sglang-decompression-queue.html)**: step through it with ← →.
  5. ![A walkthrough: pinned source on the left with the explained lines highlighted, an animated map and the narration on the right](docs/screenshot.png)
  6. Each page has:
  7. - **A thesis**: one sentence naming the mechanism that makes the task necessary.
  8. - **Pinned source**: every step highlights the lines it explains, at a fixed commit, with a link to them on GitHub.
  9. - **A map**: the traveler moves across the components it crosses, so the thesis is something you watch happen.
  10. - **Evidence tags** on every step: verified, inference, to measure, draft, schematic. You know what you can build on.
  11. - **Concepts taught in passing**: the language or framework idea each step needs, at the moment it needs it.
  12. - **The way forward**: design options, a measurement plan, who else is working on it, and the road to a PR.
  13. ## Install
  14. Claude Code, as a plugin:
  15. ```
  16. /plugin marketplace add LiyangTseng/code-walkthrough
  17. /plugin install code-walkthrough@code-walkthrough
  18. ```
  19. Or clone and link the skill into your personal skills:
  20. ```bash
  21. git clone https://github.com/LiyangTseng/code-walkthrough.git
  22. ln -s "$PWD/code-walkthrough/skills/code-walkthrough" ~/.claude/skills/code-walkthrough
  23. ```
  24. Other agents that read `SKILL.md` files can use `skills/code-walkthrough/` directly. The build needs `git` and Node.js 18 or later.
  25. ## Use
  26. Ask in your own words, in the repository you will work in:
  27. - "Walk me through https://github.com/owner/repo/issues/123 before I implement it."
  28. - "I'm taking this bug next. Build a walkthrough of where it happens."
  29. - "How does a request get from the HTTP layer to the scheduler? Walk me through it."
  30. The agent reads the issue and its discussion, writes the thesis, traces the code at the pinned commit, scripts the steps, draws the map, and builds the page. The build pulls every source file from git at that commit, rejects line ranges and map ids that do not exist, and prints a fact-check list: every step tagged "verified" with the lines it cites, which the agent re-reads before publishing. In Claude's apps the page is published as an artifact; elsewhere you get an HTML file to open in a browser.
  31. Pages come in English or Traditional Chinese labels out of the box, and the narration follows your language.
  32. ## Example
  33. [`examples/sglang-decompression-queue`](examples/sglang-decompression-queue) walks through an [sglang](https://github.com/sgl-project/sglang) issue: why queued request decompressions still hold their whole body in memory. [Open it live](https://liyangtseng.github.io/code-walkthrough/examples/sglang-decompression-queue.html), or rebuild it from an sglang checkout:
  34. ```bash
  35. node skills/code-walkthrough/scripts/build.mjs examples/sglang-decompression-queue/walk.js --repo ~/path/to/sglang --out docs/examples/sglang-decompression-queue.html
  36. ```
  37. GitHub Pages serves `docs/`, so the rebuilt page goes live when it is pushed.
  38. ## Layout
  39. ```
  40. skills/code-walkthrough/
  41. SKILL.md the workflow and the evidence tags
  42. references/ walk.js format, map design, writing the scenes
  43. assets/player.html the player every page is built on
  44. scripts/build.mjs pulls pinned sources, checks the walk, writes the page
  45. examples/ walkthroughs to read and copy
  46. ```
  47. ## License
  48. MIT. The example quotes sglang source, which is Apache-2.0.

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.