# Repo Tour Guide

> Paste a public GitHub repository link, or upload a zip or folder, and get an onboarding doc for it: what the project is, an architecture map, how one request or command flows through the code, how to install, run and test it, the files to read first and in what order, key concepts and gotchas. Then ask follow-up questions about the same repository. No API key needed: reading the repository and its facts is free, and each tour or follow-up is paid per run with SkillSafe credits.

URL: https://repo-tour-guide.skillsafe.ai/
API: https://repo-tour-guide.skillsafe.ai/api.html

## What it does

- Step 1: a public GitHub repository is listed through the app's own server function (GitHub REST API for the file tree, the raw file host for file text; free, needs sign-in). A zip or a folder is read entirely in the browser and needs no sign-in to look at.
- Step 2, free: facts computed from the whole file list - languages by bytes, file count, manifests, likely entry points, tests, CI pipelines, the stack named in manifest text (each with the file it came from), and how many vendored, generated, binary and lock files are never sent. A folder outline of the whole repository.
- The page ranks the files a newcomer would open first (README, manifests, architecture and contributing docs, entry points, configs, core source), loads them, and shows every file it will send with its size. You untick or add files and pick a budget (quick, standard or deep). Long files are clipped on line boundaries with a visible marker, never cut blindly, and anything left out for the budget is named.
- Step 3, paid: the model (SkillSafe gpt-terra tier) writes the onboarding doc from those files only, for a new contributor, someone using it, or someone evaluating it. Commands it could not find in the files are marked "(inferred)".
- Every repository path the doc cites is checked against the real file list and shown as read, present but not sent, or not in the repository. Click a path to open the file.
- Follow-up questions add the files the question names or points at, and reuse the doc and the recent answers.
- Export: copy the whole tour as Markdown or download it as .md. Signed-in tours are saved to the account.

## Price

Free to open, to read a repository's facts and file list, and to try the built-in example (a saved tour and follow-up of a small sample repository replay at no cost). A tour or follow-up is one metered run: the page shows the most it can cost before you run and the actual charge after.

## Limits

- Public GitHub repositories only by link; private code works by uploading a zip or folder.
- Very large repositories list up to 12,000 files; files over 400 KB and binary files are never sent.
- The doc covers only what the sent files show; the "Not shown in the files sent" section says what is missing and which file would answer it.

## Data

File text is read from GitHub's public raw file host at the time you run. Uploaded zips and folders stay in your browser until you run; only the files you keep ticked are sent.