Skip to content

commandDocumentation

Repository Code Tour

Gives a new developer a guided tour of the repository: layout, entry points, request flow, how to run it and where the risky parts are.

npx workspacetemplates add code-tour --tool claude-code

Writes 1 file to .claude/commands/

.claude/commands/code-tour.md14 lines · 1.2 KBFile
---
description: "Gives a new developer a guided tour of the repository: layout, entry points, request flow, how to run it and where the risky parts are."
argument-hint: "[area to focus on, optional]"
---

Give me a guided tour of this repository. Focus: $ARGUMENTS (the whole project if empty).

1. Read the README, the manifest files, CI config and the top two levels of the tree. Identify languages, frameworks, build tool and deployment target.
2. Find the entry points: main files, route tables, job runners, CLI commands.
3. Trace one real request or command from entry to the database or output. Name every file on the path with `file:line`.
4. Find how to run it: install, configure (list required environment variables, never print their values), start, and test. Run the safe ones and note what actually worked.
5. Mark the risk zones: files with high churn (`git log --since=6.months --name-only`), large or untested modules, and anything marked as pending or deprecated.

Output a tour with the headings **What it is**, **Map**, **One request end to end**, **Run it**, **Danger zones**, **First tasks for a newcomer**. Keep it under 600 words. Do not modify files; offer to save it as docs/TOUR.md.

What it does

A new teammate loses days finding the front door of a codebase. This command explores the repository like a careful newcomer and writes a tour in the order you would want to learn it.

It follows one real path through the system, from entry point to data store, instead of listing folders. It also records commands it actually ran, so the setup steps are tested.

Example

you › /code-tour api

agent › What it is: a Fastify API for invoicing backed by Postgres.
One request end to end: POST /invoices -> src/routes/invoices.ts:24 -> InvoiceService.create (services/invoice.ts:61) -> insert in db/invoices.ts:12.
Run it: cp .env.example .env, docker compose up db, npm run dev (worked, port 3000).
Danger zones: services/tax.ts changed 31 times in 6 months and has no tests.

Questions

Does it write documentation into my repository?
Only if you ask. By default the tour is printed in the chat.
Will it run my project?
It runs install and test style commands it judges safe and tells you what it ran.
  • Document Function

    CommandDocumentation

    Free
  • Explain Error

    CommandDocumentation

    Free
  • Generate API Docs

    CommandDocumentation

    Free
  • Update README

    CommandDocumentation

    Free