code-tour

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

Updated Mar 18, 2026
One-click install
npx skills add https://github.com/freedom909/real-estate-saas --skill code-tour-freedom909
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: code-tour
Source: https://github.com/freedom909/real-estate-saas/tree/main/.trae/skills/code-tour
Command: npx skills add https://github.com/freedom909/real-estate-saas --skill code-tour-freedom909

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? New engineers, reviewers, and investigators often struggle to navigate an unfamiliar codebase, and flat explanations in chat are not reusable. This Skill produces structured CodeTour .tour files that open directly to real files and line ranges, giving each reader a guided, verifiable path through the code. ## Core Features & Use Cases - Persona-Targeted Tours: Infers the reader (new-joiner, architect, pr-reviewer, rca-investigator, security-reviewer, and more) and adjusts step count and depth accordingly. - Verified Anchors: Requires every file path, line number, selection, or pattern anchor to be confirmed against the actual repository before writing. - Narrative Structure: Enforces a story arc (orientation, module map, core execution path, gotcha, next steps) using the SMIG writing rule for each step description. - Use Case: A maintainer asks for an onboarding tour of a payments service; the Skill explores the repo, verifies anchors, and writes .tours/new-joiner-payments.tour with steps anchored to the entry point, routes, and service logic. ## Quick Start Ask the AI to create an onboarding code tour of the authentication module as a CodeTour .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 file for codebase onboarding?▼

Explore the repository first, infer the reader persona, verify every file and line anchor, then write a .tour JSON file to the .tours/ directory. Steps use file, directory, selection, pattern, or URI anchors following the CodeTour schema.

What step types does a CodeTour .tour file support?▼

CodeTour steps support content-only text, directory orientation, file plus line anchors, selection ranges with start and end positions, pattern-based anchors for volatile code, and URI links for PRs or docs.

How many steps should a code tour have?▼

Step count depends on persona: quick tours use 5-8 steps, onboarding and PR tours use 7-13, and architecture tours use 14-18. Keep the count proportional to repository size and cut aggressively for short tours.

When should I use pattern anchors instead of line numbers?▼

Use pattern anchors when the target file is volatile and exact line numbers may drift between edits. A pattern anchor matches a code string such as a class declaration, keeping the step valid as the file changes.

When is a CodeTour file the wrong choice?▼

Skip the .tour artifact when a one-off chat explanation suffices, when the user wants prose documentation, or when the task is implementation or refactoring. Tours are for reusable guided walkthroughs, not code changes.