Introduction to DeepWiki-Open

AI-powered documentation generator that creates beautiful, interactive wikis for any GitHub, GitLab, or BitBucket repository

DeepWiki-Open is an innovative AI-powered documentation generator that automatically creates comprehensive, interactive wikis for any GitHub, GitLab, or BitBucket repository. Transform your codebase into beautiful, navigable documentation in seconds.

What is DeepWiki-Open?

DeepWiki-Open analyzes your repository’s code structure, understands the relationships between components, and generates:

Interactive Documentation

Comprehensive documentation with code analysis and explanations

Visual Diagrams

Automatic Mermaid diagrams showing architecture and data flow

AI-Powered Chat

RAG-powered Q&A system to chat with your repository

Deep Research

Multi-turn AI research for complex code analysis

Key Features

🚀 Instant Documentation Generation

Simply enter a repository URL and DeepWiki will analyze the code structure, generate comprehensive documentation, and create visual diagrams to explain how everything works.

🔐 Private Repository Support

Securely access private repositories with personal access tokens from GitHub, GitLab, or BitBucket.

🤖 Multiple AI Model Providers

Choose from leading AI providers:

• Google Gemini (default: gemini-2.0-flash)
• OpenAI (gpt-4o, o1, o3, o4-mini)
• OpenRouter (access to Claude, Llama, Mistral, and more)
• Azure OpenAI (enterprise-grade deployment)
• Ollama (local open-source models)
• Amazon Bedrock (AWS-hosted models)
• DashScope (Alibaba Qwen models)

💬 Intelligent Q&A System

The Ask Feature uses Retrieval Augmented Generation (RAG) to provide accurate answers based on your repository’s actual code.

🔍 Advanced Research Capabilities

DeepResearch conducts multi-turn investigations for complex topics, providing comprehensive analysis through multiple research iterations.

🌍 International Support

Built-in support for 10+ languages including English, Chinese, Japanese, Spanish, Korean, Vietnamese, Portuguese, French, and Russian.

How It Works

1. Repository Analysis

   DeepWiki clones and analyzes your repository structure, including private repos with token authentication.

2. AI Processing

   Creates embeddings of the code for smart retrieval and uses AI to generate documentation with context-aware understanding.

3. Visualization

   Generates Mermaid diagrams to explain code relationships and system architecture.

4. Interactive Wiki

   Organizes everything into a structured, navigable wiki with intelligent Q&A capabilities.

Architecture Overview

Project Structure

The DeepWiki-Open project consists of:

Frontend (Next.js)

src/
├── app/                  # Next.js app directory
│   ├── page.tsx          # Main application page
│   └── api/              # API routes
├── components/           # React components
│   ├── Ask.tsx           # Q&A interface
│   ├── Mermaid.tsx       # Diagram renderer
│   └── ...
└── utils/               # Utility functions

Quick Start

Ready to get started? Choose your preferred setup method:

Docker Setup (Recommended)

Get up and running in minutes with Docker Compose

Manual Setup

Install and configure manually for development

You’ll need API keys from your chosen AI provider (Google, OpenAI, etc.) to get started. See the Environment Variables guide for details.

Next Steps

Quick Start Guide

Get DeepWiki running in under 5 minutes

Configuration

Configure your AI model providers

Features Guide

Learn about all DeepWiki features

API Reference

Explore the REST API endpoints