code-tour

Creates CodeTour .tour files with persona-targeted walkthroughs anchored to real files and lines.

Updated Jul 16, 2026
One-click install
npx skills add https://github.com/pjherron/hypoc --skill code-tour-pjherron
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: code-tour
Source: https://github.com/pjherron/hypoc/tree/main/hypoc/skills/code-tour
Command: npx skills add https://github.com/pjherron/hypoc --skill code-tour-pjherron

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Explaining how a codebase works to a new engineer, reviewer, or investigator usually produces a one-off chat answer that is lost immediately. This Skill turns that explanation into a reusable CodeTour .tour artifact with verified file and line anchors that opens directly in the editor. ## Core Features & Use Cases - Persona-targeted tours: Infers the reader (new-joiner, architect, PR reviewer, RCA investigator, security reviewer) and adjusts step count and depth accordingly. - Verified anchors: Every file path, line number, selection, or pattern is confirmed against the actual repository before the tour is written. - Narrative structure: Follows an orientation-to-execution-path arc with SMIG descriptions (Situation, Mechanism, Implication, Gotcha) instead of flat file listings. - Use Case: A maintainer asks for an onboarding tour of the payments service; the Skill explores the repo, verifies anchors, and writes .tours/new-joiner-payments.tour with 10 steps tracing the request path end to end. ## Quick Start Ask the agent to create an onboarding code tour of the payments service for a new engineer, saved as a .tour file.

Frequently Asked Questions about code-tour

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

FAQPage Schema
How do I create a CodeTour .tour file for my repository?▼

Explore the repository first to understand its structure, then write a JSON file in the .tours/ directory following the CodeTour schema. Each step anchors to a real file, line, selection, directory, or pattern, with a title and description.

How do I write an onboarding tour for new engineers?▼

Target the new-joiner persona with 9-13 steps. Start with a directory step for orientation, walk the core execution path with file and line anchors, cover one edge case, and close with what the reader can now do.

What step types does the CodeTour format support?▼

CodeTour supports content-only, directory, file-plus-line, selection, pattern, and URI steps. File-plus-line is the default; pattern steps are preferred when line numbers may drift as the code changes.

When should I not create a code tour?▼

Skip the tour when a one-off chat explanation suffices, when the user wants prose documentation instead of a .tour artifact, or when the task is implementation work. Broad codebase onboarding without a tour artifact fits a different skill.

Why do code tour anchors break after code changes?▼

Anchors break because they reference fixed line numbers in volatile files. Use pattern-based anchors, such as matching a function signature string, for files that change frequently so the step still resolves correctly.