# OpenDeepWiki — Turn Any Repo into AI Documentation

> Self-hosted tool that converts GitHub, GitLab, and Gitea repositories into AI-powered knowledge bases with Mermaid diagrams and conversational AI. MIT license, 3,000+ stars.

## Install

Save as a script file and run:

## Quick Use

```bash
git clone https://github.com/AIDotNet/OpenDeepWiki.git
cd OpenDeepWiki
# Configure API keys in docker-compose.yml
make build
make up
```

Access at `http://localhost:8090`. Enter any repo URL to generate documentation.

---

## Intro

OpenDeepWiki is an open-source tool that converts any code repository into a comprehensive, AI-powered knowledge base — with auto-generated Mermaid diagrams, structured documentation, and a conversational AI interface for asking questions about the code. With 3,000+ GitHub stars and MIT license, it supports GitHub, GitLab, Gitea, Gitee, and Bitbucket repositories. Built on .NET 9 and Semantic Kernel, it processes repos in minutes: cloning, scanning, filtering, generating README, creating document catalogs, and building searchable wikis. Also supports MCP integration for connecting to AI tools.

Best for: teams who want auto-generated documentation and a chat interface for understanding codebases.
Works with: GitHub, GitLab, Gitea, Gitee, AtomGit repositories.
Setup time: under 5 minutes with Docker.

---

## OpenDeepWiki — How It Works

### Processing Pipeline

1. **Clone** — Clones the target repository
2. **Scan** — Reads `.gitignore`, scans directory structure
3. **Filter** — Intelligent filtering for relevant files
4. **Generate README** — Creates or improves project README
5. **Classify** — Generates project type classifications
6. **Catalog** — Creates structured document catalog
7. **Process** — Generates detailed documentation pages
8. **Visualize** — Creates Mermaid diagrams for code structure

### Key Features

- **Multi-Platform**: GitHub, GitLab, Gitea, Gitee, AtomGit, Bitbucket
- **Multi-Language**: Analyzes code in any programming language
- **Mermaid Diagrams**: Auto-generated architecture and flow diagrams
- **Conversational AI**: Chat interface powered by RAG for code questions
- **SEO-Friendly**: Next.js frontend with proper meta tags
- **MCP Support**: Connect as MCP server to AI tools
- **Multi-DB**: SQLite, PostgreSQL, SQL Server, MySQL

### Tech Stack

| Layer | Technology |
|-------|-----------|
| Backend | C#, .NET 9, Semantic Kernel |
| Frontend | TypeScript, Next.js |
| AI Providers | OpenAI, Azure OpenAI, Anthropic |
| Databases | SQLite, PostgreSQL, SQL Server, MySQL |
| Deployment | Docker, Kubernetes (Sealos) |

### FAQ

**Q: What is OpenDeepWiki?**
A: A self-hosted tool that converts any Git repository into an AI-powered wiki with auto-generated documentation, Mermaid diagrams, and a conversational AI interface.

**Q: Is it free?**
A: Yes, MIT license. You provide your own LLM API keys (OpenAI, Azure, or Anthropic).

**Q: How long does it take to process a repo?**
A: Small repos: 1-2 minutes. Large repos: 5-15 minutes depending on size and LLM speed.

---

## Source & Thanks

> Created by [AIDotNet](https://github.com/AIDotNet). Licensed under MIT.
>
> [OpenDeepWiki](https://github.com/AIDotNet/OpenDeepWiki) — ⭐ 3,000+

---

<!-- ZH -->

## 快速使用

```bash
git clone https://github.com/AIDotNet/OpenDeepWiki.git
cd OpenDeepWiki && make build && make up
```

访问 `http://localhost:8090`，输入任何仓库 URL 生成文档。

---

## 简介

OpenDeepWiki 是开源工具，将任何代码仓库转换为 AI 驱动的知识库——自动生成 Mermaid 图表、结构化文档和对话式 AI 界面。3,000+ Star，MIT 许可证，支持 GitHub/GitLab/Gitea 等平台。

---

## 来源与感谢

> Created by [AIDotNet](https://github.com/AIDotNet). Licensed under MIT.
>
> [OpenDeepWiki](https://github.com/AIDotNet/OpenDeepWiki) — ⭐ 3,000+

---
Source: https://tokrepo.com/en/workflows/24613482-86e1-487a-a2ad-450c9bb7dfaa
Author: Script Depot