https://github.com/flyte/claude-code-guided-tour
Interactive guided tour that teaches you an unfamiliar codebase. Partner to claude-code-quiz-master.
https://github.com/flyte/claude-code-guided-tour
Last synced: 10 days ago
JSON representation
Interactive guided tour that teaches you an unfamiliar codebase. Partner to claude-code-quiz-master.
- Host: GitHub
- URL: https://github.com/flyte/claude-code-guided-tour
- Owner: flyte
- License: mit
- Created: 2026-06-15T21:25:37.000Z (13 days ago)
- Default Branch: master
- Last Pushed: 2026-06-15T21:42:47.000Z (13 days ago)
- Last Synced: 2026-06-15T23:22:49.873Z (13 days ago)
- Size: 29.3 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# claude-code-guided-tour
An interactive guided tour that **teaches** you (or an agent) an unfamiliar
codebase. Claude explores the repo with a recon subagent, fans out parallel
subagents to study each subsystem, then walks you through a sequenced lesson
one stop at a time — high-level first, grounded in real code.
It is the teaching partner to
[`claude-code-quiz-master`](https://github.com/flyte/claude-code-quiz-master):
the **tour teaches**, the **quiz tests**.
## Install
```
/plugin marketplace add flyte/claude-plugins
/plugin install claude-code-guided-tour@flyte
```
## Use
- `/tour` — take the overall guided tour of the whole codebase.
- `/tour-dive ` — deep dive into one subsystem (e.g. `/tour-dive auth`).
During the overall tour you drive the pace: `next`, `dig in`, `skip`,
`jump `, `stop`.
### Options
- `--level ` — depth for this session.
- `--set-level ` — set and remember your level.
- `--refresh` — re-explore the codebase from scratch.
- `--model ` — override the model used by the exploration
subagents for this run.
- `--smoke` — run a self-check that the plugin is installed correctly (no tour).
## How it works
The first run explores the codebase and caches a **curriculum** at
`.claude/tour-map.json` (an ordered set of teaching "stops"). Later runs reuse
it and only re-explore when the codebase has changed meaningfully, so they're
fast. The cache is git-ignored.
## Models & cost
Exploration is the dominant token cost (one subagent per subsystem, run in
parallel), so the subagents default to cheaper models rather than inheriting
your main session model:
| Phase | Default model |
|-------|---------------|
| Recon | Haiku |
| Deep-dive fan-out | Sonnet |
| Deep-dive re-drill (`/tour-dive`) | Sonnet |
| Synthesis (curriculum assembly) | your session model |
Override per run with `--model `. If your environment sets
`CLAUDE_CODE_SUBAGENT_MODEL`, that takes precedence over both the defaults and
`--model`.
## Requirements
`git` and `jq` on PATH. Staleness tracking needs a git repo; outside one the
tour still works but won't auto-refresh.
## License
MIT