code-tour

Plan and execute interactive tmux-based code tours with nvim panes.

8|5|Updated Jan 20, 2025
One-click install
npx skills add https://github.com/Perseus/pko-tools --skill code-tour-perseus
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: code-tour
Source: https://github.com/Perseus/pko-tools/tree/main/.claude/skills/code-tour
Command: npx skills add https://github.com/Perseus/pko-tools --skill code-tour-perseus

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Provides an interactive, guided code-tour experience that presents source files in a live tmux+nvim pane while the assistant explains code structure, architecture, and flow without requiring manual exploration.

Core Features & Use Cases

  • Live, tmux-based code tour with an embedded nvim pane for real-time code walkthroughs.
  • Step-by-step plan generation and pre-reading to ensure low-latency, high-context explanations.
  • Guided navigation through entry points, dependencies, core logic, and integration points with user confirmation between stops.

Quick Start

Start the tour by invoking the code tour command, and I will guide you step-by-step through the codebase in a tmux pane with nvim.

Frequently Asked Questions about code-tour

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

FAQPage Schema
How do I do an interactive code walkthrough of a large codebase in tmux?

An interactive code tour automates codebase walkthroughs by displaying source files in a live tmux+nvim pane while generating step-by-step explanations. It pre-reads files to provide low-latency, high-context navigation through entry points, dependencies, and core logic.

Can I get a guided architecture tour that opens source files in nvim automatically?

Yes, a guided code tour coordinates file navigation via a preloaded tour plan, automatically opening source files in an nvim pane. It provides step-by-step explanations of code structure, architecture, and service flows with user confirmation between stops.

How do I explore entry points and integration points in an unfamiliar repository?

To explore entry points and integration points, an interactive code tour generates a structured plan covering core logic and dependencies. It walks through each stop in a live nvim pane, explaining the architecture and flow while waiting for user confirmation before proceeding.

Do I need a running tmux session and nvim installed to start a code tour?

Yes, this interactive code tour requires a running tmux session and nvim installed in your environment. The tool coordinates file navigation and displays source files directly within the embedded nvim pane to execute the live walkthrough.

What is the best way to visualize service flows and code structure without manual exploration?

The best way to visualize service flows without manual exploration is using a tmux-based code tour. It presents source files in a live nvim pane and provides step-by-step explanations of architecture, eliminating the need to manually open and trace files.

Why does the code tour pause between stops during the walkthrough?

The interactive code tour pauses between stops to request user confirmation, ensuring you can absorb the step-by-step explanations of code structure and architecture before navigating to the next entry point, dependency, or integration point in the live nvim pane.