Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/AsyncFuncAI/deepwiki-open/llms.txt

Use this file to discover all available pages before exploring further.

DeepWiki Open is an open-source, self-hostable tool that turns any code repository into a rich, interactive wiki in seconds. Point it at a GitHub, GitLab, or Bitbucket repo, and it analyzes the code structure, generates comprehensive documentation, produces Mermaid architecture diagrams, and sets up an AI-powered Q&A interface — all without manual effort.

Quickstart

Get DeepWiki running locally in minutes with manual setup

Docker Deployment

Run DeepWiki with a single Docker Compose command

Model Providers

Configure Google Gemini, OpenAI, Ollama, and more

Core Features

Explore wiki generation, Ask, DeepResearch, and export

What DeepWiki does

When you enter a repository URL, DeepWiki:
  1. Clones and analyzes the code structure (supports private repos with access tokens)
  2. Creates vector embeddings of the codebase for intelligent retrieval
  3. Generates documentation pages using your chosen AI model
  4. Produces Mermaid diagrams to visualize architecture and data flow
  5. Organizes everything into a navigable wiki with an AI chat interface

Key features

Wiki Generation

Instant, AI-generated documentation for any repository

Ask Feature

Chat with your repo using RAG-powered AI for accurate, grounded answers

DeepResearch

Multi-turn AI research for in-depth investigation of complex topics

Private Repositories

Securely access private repos using personal access tokens

Multiple LLM Providers

Google Gemini, OpenAI, OpenRouter, Azure OpenAI, AWS Bedrock, Ollama, DashScope

Export

Download your wiki as Markdown or JSON

Supported providers

ProviderModelsNotes
Google Geminigemini-2.5-flash, gemini-2.5-proDefault provider
OpenAIgpt-5, gpt-4o, o3, o4-miniRequires OPENAI_API_KEY
OpenRouter100+ models via unified APIRequires OPENROUTER_API_KEY
Azure OpenAIgpt-4o, gpt-4-turboRequires Azure credentials
AWS BedrockClaude, Titan, Cohere, AI21Requires AWS credentials
Ollamallama3, qwen3, and any local modelNo API key needed
DashScopeqwen-plus, qwen-turbo, deepseek-r1Alibaba Cloud models

Self-hosting options

DeepWiki is fully self-hostable. Choose your deployment method:
  • Manual setup — Run the Python backend and Next.js frontend separately
  • Docker Compose — Single command to bring up the full stack
  • Ollama — Run entirely locally with no external API keys required
DeepWiki stores cloned repositories, embeddings, and cached wikis in ~/.adalflow/ on the host machine. This data persists across restarts when using Docker volume mounts.

Build docs developers (and LLMs) love