Repo Bootcamp

╦═╗╔═╗╔═╗╔═╗  ╔╗ ╔═╗╔═╗╔╦╗╔═╗╔═╗╔╦╗╔═╗
╠╦╝║╣ ╠═╝║ ║  ╠╩╗║ ║║ ║ ║ ║  ╠═╣║║║╠═╝
╩╚═╚═╝╩  ╚═╝  ╚═╝╚═╝╚═╝ ╩ ╚═╝╩ ╩╩ ╩╩  

Turn any GitHub, GitLab, or Bitbucket repository into a Day 1 onboarding kit

🏆 One of the Winners of the GitHub Copilot SDK Contest

Features • Quick Start • How It Uses Copilot SDK • Examples

Table of contents

• The Problem · The Solution · Why This Tool Wins
• How It Uses the GitHub Copilot SDK · Features
• Example Output · Generated Documentation
• Quick Start · Usage · CLI Options · Commands
• Programmatic API · Architecture · How It Works
• Configuration · Development · Requirements
• Model Configuration · Tech Stack · Contributing · License

The Problem

New developers joining a project waste days or weeks trying to understand: - How do I set up my environment? - What's the architecture? Where do I start reading? - What are safe first contributions? - Who do I ask when I'm stuck?

Most READMEs are outdated. Most wikis are incomplete. Most senior devs are too busy.

The Solution

Repo Bootcamp uses agentic AI to analyze repositories from GitHub, GitLab, or Bitbucket and generate comprehensive, actionable onboarding documentation in under 60 seconds.

npx repo-bootcamp https://github.com/facebook/react

That's it. You get 14+ interconnected markdown files covering everything a new contributor needs.

https://github.com/Arthur742Ramos/repo-bootcamp/raw/main/media/demo-sonnet.mp4

Generate comprehensive onboarding docs in under 60 seconds

See CLI in action

  ╦═╗╔═╗╔═╗╔═╗  ╔╗ ╔═╗╔═╗╔╦╗╔═╗╔═╗╔╦╗╔═╗
  ╠╦╝║╣ ╠═╝║ ║  ╠╩╗║ ║║ ║ ║ ║  ╠═╣║║║╠═╝
  ╩╚═╚═╝╩  ╚═╝  ╚═╝╚═╝╚═╝ ╩ ╚═╝╩ ╩╩ ╩╩  

  Turn any repo into a Day 1 onboarding kit

──────────────────────────────────────────────────
  Repository:  https://github.com/sindresorhus/ky
  Branch:      default
  Focus:       all
  Audience:    backend
  Style:       OSS (Community-friendly)
──────────────────────────────────────────────────

✔ Cloned sindresorhus/ky (branch: main)
✔ Scanned 45 files (12 key files read)

Detected Stack:
  Languages:  TypeScript
  Frameworks: None
  Build:      npm
  CI:         Yes
  Docker:     No

✔ Analysis complete

Security Score: 85/100 (B)
Onboarding Risk: 18/100 (A) 🟢

  ╔══════════════════════════════════════════════════════╗
  ║        ✓ Bootcamp Generated Successfully!            ║
  ╚══════════════════════════════════════════════════════╝

  📁 Output: ./bootcamp-ky/

  Generated files:
  ├── BOOTCAMP.md      → 1-page overview (start here!)
  ├── ONBOARDING.md    → Full setup guide
  ├── ARCHITECTURE.md  → System design & diagrams
  ├── CODEMAP.md       → Directory tour
  ├── FIRST_TASKS.md   → Starter issues
  ├── RUNBOOK.md       → Operations guide
  ├── DEPENDENCIES.md  → Dependency graph
  ├── SECURITY.md      → Security findings
  ├── RADAR.md         → Tech radar & risk score
  ├── IMPACT.md        → Change impact analysis
  ├── METRICS.md       → Codebase metrics & hotspots
  ├── HEALTH.md        → Onboarding-readiness health check
  ├── diagrams.mmd     → Mermaid diagrams
  └── repo_facts.json  → Structured data

  🚀 Next step: open ./bootcamp-ky/BOOTCAMP.md

Why This Tool Wins

What Makes It Different

1. Powered by GitHub Copilot SDK - Leverages the official SDK for agentic AI with tool-calling
2. Truly Agentic - Claude autonomously explores codebases, not just template filling
3. Schema Validated - All output is validated with Zod schemas and auto-retried on failures
4. Production Ready - 1,270+ tests, TypeScript, proper error handling
5. Full Feature Set - A 20-command CLI: interactive Q&A, a combined scan dashboard, health/metrics/security scoring, coupling & impact graphs, machine preflight, ownership maps, docs-drift analysis, and a web UI
6. Beautiful Output - Mermaid diagrams, structured markdown, professional formatting

By the Numbers

How It Uses the GitHub Copilot SDK

Repo Bootcamp is a showcase of the GitHub Copilot SDK's agentic capabilities. Here's how we leverage the SDK:

Agentic Tool Calling

The SDK enables Claude to autonomously explore repositories using custom tools:

import { CopilotClient } from "@github/copilot-sdk";

const client = new CopilotClient();

// Define tools the agent can use
const tools = [
  {
    name: "read_file",
    description: "Read contents of a file in the repository",
    parameters: { path: { type: "string" } }
  },
  {
    name: "list_files", 
    description: "List files matching a glob pattern",
    parameters: { pattern: { type: "string" } }
  },
  {
    name: "search",
    description: "Search for text across the codebase",
    parameters: { query: { type: "string" } }
  }
];

// Agent autonomously decides which files to read
const session = await client.createSession({
  model: "claude-opus-4-5",
  systemMessage: { content: systemPrompt },
  tools,
  streaming: true,
});

await session.sendAndWait({ prompt: analysisPrompt });

Why This Matters

Key SDK Features Used

1. Multi-turn Conversations - Agent iterates until it has enough information
2. Tool Calling - Custom tools for file reading, searching, and metadata
3. Model Selection - Automatic fallback through claude-opus-4-5 → claude-sonnet-4-5
4. Streaming - Real-time progress updates during analysis
5. Schema Validation - Zod schemas validate output, with auto-retry on failures

Architecture Integration

┌─────────────────────────────────────────────────────────────┐
│                   GitHub Copilot SDK                         │
│  ┌─────────────┐  ┌─────────────┐  ┌─────────────────────┐  │
│  │   Claude    │  │   Tools     │  │   Streaming         │  │
│  │   Models    │  │   System    │  │   Responses         │  │
│  └──────┬──────┘  └──────┬──────┘  └──────────┬──────────┘  │
└─────────┼────────────────┼─────────────────────┼────────────┘
          │                │                     │
          ▼                ▼                     ▼
┌─────────────────────────────────────────────────────────────┐
│                    Repo Bootcamp Agent                       │
│                                                              │
│  "Read package.json" → "Search for test files" →            │
│  "Read src/index.ts" → "Find CI workflow" →                  │
│  "Generate structured onboarding JSON"                       │
└─────────────────────────────────────────────────────────────┘

The Copilot SDK transforms what would be a simple template-filler into an intelligent agent that understands code structure, identifies patterns, and produces genuinely useful onboarding documentation.

Features

• GitHub Copilot SDK Integration - Built on the official SDK for agentic AI capabilities
• Agentic Analysis - Claude autonomously reads files, searches code, and understands architecture
• Streaming LLM Output - Streams assistant deltas live to terminal output (verbose) or progress callbacks
• Multi-host Repository Support - Works with GitHub, GitLab, and Bitbucket repository URLs
• Complete Documentation Suite - Generates 14+ interconnected markdown files
• Smart Prioritization - Intelligently samples files based on importance and byte budget
• Fast File Walking - Uses concurrent fast-glob traversal while honoring skip directories and file limits
• Schema Validation - Validates LLM output with auto-retry on failures
• Model-aware Fast Mode Budgets - Adjusts inline key-file/entrypoint budgets by selected model context window
• Multi-language Support - Works with TypeScript, Python, Go, Rust, Java, and more
• Interactive Q&A Mode - Chat with the codebase using natural language
• Docs Drift Analyzer - Detect stale/mismatched docs with bootcamp docs --check, and auto-fix with --fix
• Phase-level Cache Management - Reuses deps/security/impact analysis phases and supports bootcamp cache list|prune|clear (with --json listing for scripts)
• Tech Radar - Identify modern, stable, legacy, and risky technologies
• Change Impact Analysis - Understand how file changes affect the codebase
• Codebase Metrics & Hotspots - Deterministic METRICS.md with language breakdown, largest-file hotspots, test-to-source ratio, and an Approachability score (0-100 + grade)
• Repo Health Check - Deterministic HEALTH.md scoring onboarding-readiness across documentation, community, quality, and automation signals (0-100 + grade) with prioritized, actionable recommendations
• Environment Doctor - Diagnose Node, git, GitHub CLI/auth, mermaid-cli, and cache health with bootcamp doctor (--json for CI)
• Combined Scan Dashboard - bootcamp scan reports health, metrics, security, and onboarding risk from a single clone, with a --check CI gate on the lowest score
• Module Coupling Map - bootcamp coupling ranks modules by import coupling to reveal the load-bearing core, orchestrator hubs, and possibly-orphaned dead code
• Circular Dependency Detection - bootcamp cycles finds circular import groups (Tarjan SCC) on the import graph, with a --check CI gate
• Machine Preflight - bootcamp preflight checks your machine against the target repo's declared toolchain (Node, package manager, Python, Go) with a per-row remedy
• Ownership Map - bootcamp owners parses CODEOWNERS to answer "who do I ask?" with default owners, per-area maintainers, and top committers
• Style Pack Explorer - bootcamp styles lists the built-in style packs and the doc sections each one enables
• Version & PR Comparison - Compare refs with --compare or analyze pull requests with bootcamp diff
• Auto-Issue Creator - Generate GitHub issues from starter tasks
• Web Demo Server - Beautiful browser UI for analyzing repositories
• Template Packs - Customize output style for different contexts
• Diagram Rendering - Convert Mermaid to SVG/PNG with mermaid-cli
• Watch Mode - Re-run analysis automatically when new commits are detected

Example Output

BOOTCAMP.md - 1-page overview

# sindresorhus/ky Bootcamp

> Tiny Fetch-based HTTP client with ergonomic helpers, retries, and hooks.

## Quick Facts
| | |
|---|---|
| **Languages** | TypeScript |
| **Frameworks** | None |
| **Build System** | npm |

## Quick Start
1. Install dependencies: npm install
2. Run tests: npm test
3. Build: npm run build

## If You Only Have 30 Minutes
1. Read this document
2. Run `npm install && npm test`
3. Pick a starter task from FIRST_TASKS.md

ARCHITECTURE.md - System design with diagrams

```markdown

Architecture

Component Diagram

​```mermaid graph TD A[ky.ts] --> B[Ky Class] B --> C[request] B --> D[retry logic] B --> E[hooks] C -