GitHub Guide Tool

A Chrome extension that helps you quickly understand GitHub open-source projects by generating AI-powered project documentation.

English | 中文

📖 Overview

GitHub Guide Tool is a Chrome browser extension that analyzes GitHub repositories and generates comprehensive project guides using AI. Instead of sending entire codebases to AI models, it extracts code skeletons and metadata to produce accurate analysis while saving tokens.

Key Features

• 🚀 Instant Analysis - Analyze any public GitHub repository with one click
• 🤖 Multiple AI Providers - Support for Claude, OpenAI, SiliconFlow, and BigModel
• 🧠 Intelligent Chunking - Automatically split large codebases for models with smaller context limits
• 📊 Smart Strategy - Adaptive analysis depth based on project size
• ⚡ Streaming Output - Real-time AI response display
• 💾 Cache System - 24-hour result caching to avoid repeated API calls
• 📄 Markdown Export - Export analysis results as Markdown files
• 🔒 Private Repos - Support for private repositories with GitHub token

🎯 How It Works

GitHub Repository → Code Skeleton Extraction → AI Analysis → Formatted Guide

1. Fetch Repository Info - Get file tree, README, and configuration files via GitHub API
2. Extract Code Skeleton - Parse directory structure, function signatures, and exports
3. AI Analysis - Send skeleton data to AI for comprehensive analysis
4. Display Results - Show formatted Markdown guide with syntax highlighting

🛠️ Installation

Option 1: Install from Release (Recommended)

1. Download the latest github-guide-tool.zip from Releases
2. Unzip the file to get the dist folder
3. Open Chrome and navigate to chrome://extensions/
4. Enable Developer mode (toggle in top-right corner)
5. Click Load unpacked and select the dist folder
6. Done! The extension icon will appear in your toolbar

Option 2: Build from Source

# Clone the repository
git clone https://github.com/alexanderkinging/github-guide-tool.git
cd github-guide-tool

# Install dependencies
npm install

# Build the extension
npm run build

# The built extension will be in the dist/ folder

Then follow steps 3-6 from Option 1.

🔑 Configuration

Before using the extension, you need to configure API keys:

1. Click the extension icon
2. Go to Settings
3. Configure the following:

Required Settings

• AI Provider: Choose from Claude, OpenAI, or SiliconFlow
• AI API Key: Your API key for the selected provider

Optional Settings

• GitHub Token: Personal Access Token to increase API rate limit (from 60 to 5000 requests/hour)

Getting API Keys

• Claude API: Anthropic Console
• OpenAI API: OpenAI Platform
• SiliconFlow: SiliconFlow Console
• GitHub Token: GitHub Settings → Developer settings → Personal access tokens

📚 Usage

1. Visit any GitHub repository page (e.g., https://github.com/facebook/react)
2. Click the GitHub Guide Tool icon in your toolbar
3. Click Analyze Repository
4. Wait for the analysis to complete (streaming output will show progress)
5. Review the generated guide
6. Optionally:
   • Click 📋 to copy to clipboard
   • Click 💾 to export as Markdown file

🎨 Analysis Strategy

The extension automatically adjusts analysis depth based on project size:

Project Size	File Count	Analysis Depth
Small	< 50	Deep Analysis (Complete skeleton)
Medium	50-200	Standard Analysis (Core modules)
Large	> 200	Quick Overview (Overview + core modules)

🏗️ Tech Stack

• Language: TypeScript
• UI Framework: React 18
• Styling: Tailwind CSS
• Build Tool: Vite + CRXJS
• Chrome API: Manifest V3
• Markdown Rendering: react-markdown with syntax highlighting

📂 Project Structure

github-guide-tool/
├── src/
│   ├── popup/              # Extension popup UI
│   │   ├── components/     # React components
│   │   └── App.tsx
│   ├── background/         # Service Worker
│   │   └── index.ts
│   ├── content/            # Content Script
│   │   └── index.ts
│   ├── lib/                # Shared modules
│   │   ├── github/         # GitHub API client
│   │   ├── analyzer/       # Code skeleton extraction
│   │   └── ai/             # AI service adapters
│   └── types/              # TypeScript type definitions
├── icons/                  # Extension icons
├── manifest.json           # Chrome extension manifest
└── docs/                   # Documentation

🔧 Development

# Install dependencies
npm install

# Start development server (with hot reload)
npm run dev

# Build for production
npm run build

# Type checking
npm run type-check

# Lint code
npm run lint

📋 Roadmap

v1.8.0 (Current) ✅

• Intelligent chunked analysis for large codebases
• Token estimation and model context limits
• Multi-round analysis with structured summaries
• Progress display for chunked analysis

v1.5.0 - v1.7.0 ✅

• Private repository support
• Multi-language code skeleton extraction (Go, Rust, Java, C++)
• Custom prompt templates
• BigModel (智谱) AI provider support

v1.0.0 ✅

• Basic Chrome extension framework
• GitHub API integration
• Code skeleton extraction (JS/TS/Python)
• AI analysis (Claude/OpenAI/SiliconFlow)
• Streaming output
• Markdown export
• Cache system
• Memory optimization

v2.0.0 (Future)

• Interactive Q&A mode
• Multi-language UI (i18n)
• Chrome Web Store publication
• Enhanced code navigation

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• Anthropic - Claude API
• OpenAI - GPT API
• SiliconFlow - AI inference platform
• GitHub - Repository hosting and API

📧 Contact

If you have any questions or suggestions, please open an issue on GitHub.

---

Note: This extension requires API keys from third-party AI services. Please ensure you comply with their respective terms of service and usage policies.