code-walkthrough

Guides verified code walkthroughs in Neovim using Terminal Control and Navi tours.

Updated Sep 5, 2023
One-click install
npx skills add https://github.com/eyenalxai/dotfiles --skill code-walkthrough-eyenalxai
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: code-walkthrough
Source: https://github.com/eyenalxai/dotfiles/tree/main/.agents/skills/code-walkthrough
Command: npx skills add https://github.com/eyenalxai/dotfiles --skill code-walkthrough-eyenalxai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Explaining code live is error-prone when the presenter relies on memory or unverified output. This Skill establishes a verified, visible code tour in Neovim so the agent and viewer see the same real code and output, with optional recording for later sharing. ## Core Features & Use Cases - Verified Tour Authoring: Run the narrowest command that proves current behavior, then build one immutable Navi JSON tour whose stops match the verified code and output. - Terminal-Driven Presentation: Drive a visible Neovim session through Terminal Control (termctrl) so the agent can inspect, send keys, and confirm what the viewer actually sees. - Recording Options: Capture the presentation with OBS for human-facing video, or retain terminal-native evidence with termctrl screenshots, markers, and recordings. - Use Case: A maintainer needs to walk a new teammate through how a subscription update propagates through the codebase, verifying behavior first and recording the session as an onboarding artifact. ## Quick Start Ask the agent to give a verified walkthrough of how a specific feature works in this repository, presented in Neovim and recorded for later viewing.

Frequently Asked Questions about code-walkthrough

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a guided code walkthrough in Neovim?

Start Neovim as a visible foreground session with termctrl run, verify the code's actual behavior by running it, then author a Navi JSON tour with file patterns and notes and load it with :NaviLoad. The viewer navigates stops with ]n and [n or :NaviNext and :NaviPrev.

How do I record a terminal code presentation?

Use OBS with a Window Capture source on the terminal when you want a human-facing video with narration and pacing. For terminal-native replay, start the session with termctrl run --record, add markers during the tour, and export with termctrl video.

What tools are required for a Navi code tour?

You need termctrl (Terminal Control), Neovim 0.10 or newer, and the navi.nvim plugin. Terminal Control is used to inspect and drive the visible session, while Navi renders the tour stops and notes inside Neovim.

Can I add recording to an already running terminal session?

No, recording must be enabled when the session starts and cannot be added to an already-running foreground session. Restart deliberately with termctrl run walkthrough --record before presenting if you need a terminal-native recording.

What should I do if the code behavior contradicts my tour notes?

Stop and say so immediately rather than presenting unverified claims. Do not rewrite the active tour in the same response; clear or replace it only in the next response after re-verifying the actual code and output.