mirror of
https://github.com/aljazceru/Tutorial-Codebase-Knowledge.git
synced 2025-12-19 15:34:23 +01:00
94 lines
5.3 KiB
Markdown
94 lines
5.3 KiB
Markdown
<h1 align="center">Turns Codebase into Easy Tutorial with AI</h1>
|
|
|
|
|
|
|
|
> *Ever stared at a new codebase written by others feeling completely lost? This tutorial shows you how to build an AI agent that analyzes GitHub repositories and creates beginner-friendly tutorials explaining exactly how the code works.*
|
|
|
|
<p align="center">
|
|
<img
|
|
src="./assets/banner.png" width="800"
|
|
/>
|
|
</p>
|
|
|
|
This is a tutorial project of [Pocket Flow](https://github.com/The-Pocket/PocketFlow), a 100-line LLM framework. It crawls GitHub repositories and build a knowledge base from the code. It analyzes entire codebases to identify core abstractions and how they interact, and transforms complex code into beginner-friendly tutorials with clear visualizations.
|
|
|
|
- Check out the [Substack Post](https://zacharyhuang.substack.com/p/ai-codebase-knowledge-builder-full) for more!
|
|
|
|
## ⭐ Example Results for Popular GitHub Repositories!
|
|
|
|
<p align="center">
|
|
<img
|
|
src="./assets/example.png" width="600"
|
|
/>
|
|
</p>
|
|
|
|
🤯 All these tutorials are generated **entirely by AI** by crawling the GitHub repo!
|
|
|
|
- [AutoGen Core](https://the-pocket.github.io/Tutorial-Codebase-Knowledge/AutoGen%20Core) - Build AI teams that talk, think, and solve problems together like coworkers!
|
|
|
|
- [Browser Use](https://the-pocket.github.io/Tutorial-Codebase-Knowledge/Browser%20Use) - Let AI surf the web for you, clicking buttons and filling forms like a digital assistant!
|
|
|
|
- [Celery](https://the-pocket.github.io/Tutorial-Codebase-Knowledge/Celery) - Supercharge your app with background tasks that run while you sleep!
|
|
|
|
- [Click](https://the-pocket.github.io/Tutorial-Codebase-Knowledge/Click) - Turn Python functions into slick command-line tools with just a decorator!
|
|
|
|
- [Crawl4AI](https://the-pocket.github.io/Tutorial-Codebase-Knowledge/Crawl4AI) - Train your AI to extract exactly what matters from any website!
|
|
|
|
- [CrewAI](https://the-pocket.github.io/Tutorial-Codebase-Knowledge/CrewAI) - Assemble a dream team of AI specialists to tackle impossible problems!
|
|
|
|
- [DSPy](https://the-pocket.github.io/Tutorial-Codebase-Knowledge/DSPy) - Build LLM apps like Lego blocks that optimize themselves!
|
|
|
|
- [FastAPI](https://the-pocket.github.io/Tutorial-Codebase-Knowledge/FastAPI) - Create APIs at lightning speed with automatic docs that clients will love!
|
|
|
|
- [Flask](https://the-pocket.github.io/Tutorial-Codebase-Knowledge/Flask) - Craft web apps with minimal code that scales from prototype to production!
|
|
|
|
- [LangGraph](https://the-pocket.github.io/Tutorial-Codebase-Knowledge/LangGraph) - Design AI agents as flowcharts where each step remembers what happened before!
|
|
|
|
- [LevelDB](https://the-pocket.github.io/Tutorial-Codebase-Knowledge/LevelDB) - Store data at warp speed with Google's engine that powers blockchains!
|
|
|
|
- [MCP Python SDK](https://the-pocket.github.io/Tutorial-Codebase-Knowledge/MCP%20Python%20SDK) - Build powerful apps that communicate through an elegant protocol without sweating the details!
|
|
|
|
- [NumPy Core](https://the-pocket.github.io/Tutorial-Codebase-Knowledge/NumPy%20Core) - Master the engine behind data science that makes Python as fast as C!
|
|
|
|
- [OpenManus](https://the-pocket.github.io/Tutorial-Codebase-Knowledge/OpenManus) - Build AI agents with digital brains that think, learn, and use tools just like humans do!
|
|
|
|
- [Pydantic Core](https://the-pocket.github.io/Tutorial-Codebase-Knowledge/Pydantic%20Core) - Validate data at rocket speed with just Python type hints!
|
|
|
|
- [Requests](https://the-pocket.github.io/Tutorial-Codebase-Knowledge/Requests) - Talk to the internet in Python with code so simple it feels like cheating!
|
|
|
|
- [SmolaAgents](https://the-pocket.github.io/Tutorial-Codebase-Knowledge/SmolaAgents) - Build tiny AI agents that punch way above their weight class!
|
|
|
|
|
|
## 🚀 Getting Started
|
|
|
|
1. Clone this repository
|
|
|
|
2. Install dependencies:
|
|
```bash
|
|
pip install -r requirements.txt
|
|
```
|
|
|
|
3. Generate a complete codebase tutorial by running the main script:
|
|
```bash
|
|
python main.py https://github.com/username/repo --include "*.py" "*.js" --exclude "tests/*" --max-size 50000
|
|
```
|
|
- `repo_url` - URL of the GitHub repository (required)
|
|
- `-n, --name` - Project name (optional, derived from URL if omitted)
|
|
- `-t, --token` - GitHub token (or set GITHUB_TOKEN environment variable)
|
|
- `-o, --output` - Output directory (default: ./output)
|
|
- `-i, --include` - Files to include (e.g., "*.py" "*.js")
|
|
- `-e, --exclude` - Files to exclude (e.g., "tests/*" "docs/*")
|
|
- `-s, --max-size` - Maximum file size in bytes (default: 100KB)
|
|
|
|
The application will crawl the repository, analyze the codebase structure, generate tutorial content, and save the output in the specified directory (default: ./output).
|
|
|
|
|
|
## 💡 Development Tutorial
|
|
|
|
- I built using [**Agentic Coding**](https://zacharyhuang.substack.com/p/agentic-coding-the-most-fun-way-to), the fastest development paradigm, where humans simply [design](docs/design.md) and agents [code](flow.py).
|
|
|
|
- The secret weapon is [Pocket Flow](https://github.com/The-Pocket/PocketFlow), a 100-line LLM framework that lets Agents (e.g., Cursor AI) build for you
|
|
|
|
- Step-by-step YouTube development tutorial coming soon! Please subscribe to my [YouTube Channel](https://www.youtube.com/@ZacharyLLM?sub_confirmation=1)
|
|
|