DeepWiki: Automatically Generate Interactive Wikis for Any GitHub Repository

DeepWiki automates the creation of clean, interactive wikis for any GitHub, GitLab, or BitBucket repository. By simply providing a repository URL, DeepWiki scans the codebase, generates comprehensive documentation, renders diagrams to illustrate system behavior, and organizes the output into an intuitive, browsable wiki.

What it does:

• Analyzes code architecture and logic.
• Generates detailed technical documentation.
• Creates visual diagrams to explain system behavior.
• Organizes content into a structured, searchable wiki.

Key features

• Instant wiki generation – Convert any GitHub or GitLab repository into a full wiki in seconds.
• Private repository support – Securely access internal projects using personal access tokens.
• AI-powered analysis – Maps code structures and identifies complex relationships within the codebase.
• Automated diagrams – Generates Mermaid charts to visualize system architecture and data flow.
• Intuitive navigation – Features a clean interface designed for easy browsing.

Quick start (Getting Started)

Option 1: Docker (recommended)

# Clone the repository
git clone https://github.com/AsyncFuncAI/deepwiki-open.git
cd deepwiki-open

# Create a .env file with your API keys
echo "GOOGLE_API_KEY=your_google_api_key" > .env
echo "OPENAI_API_KEY=your_openai_api_key" >> .env

# Launch with Docker Compose
docker-compose up

Option 2: Manual setup

Step 1: Configure API keys

Create a .env file in the project root directory:

GOOGLE_API_KEY=your_google_api_key
OPENAI_API_KEY=your_openai_api_key

Step 2: Start the backend

Step 3: Start the frontend

# Install JavaScript dependencies
npm install
# or
yarn install

# Launch the web application
npm run dev
# or
yarn dev

Step 4: Using DeepWiki

Enter a GitHub or GitLab repository name (e.g., facebook/react, vercel/next.js, or https://gitlab.com/gitlab-org/gitlab).

For private repositories, click "+ Add access tokens" and input your GitHub or GitLab personal access token.

Click "Generate Wiki" to begin the process.

How DeepWiki works

DeepWiki leverages AI to perform the following steps:

1. Clones and analyzes the repository (supporting private repos via token authentication).
2. Generates code embeddings to facilitate intelligent information retrieval.
3. Produces documentation using context-aware AI models.
4. Renders diagrams that clarify code relationships and logic.
5. Structures the compiled data into a cohesive wiki.

Advanced setup

Environment variables

Docker setup

Deploy DeepWiki using Docker:

# Pull the image from the GitHub Container Registry
docker pull ghcr.io/asyncfuncai/deepwiki-open:latest

# Run the container
docker run -p 8001:8001 -p 3000:3000 \
    -e GOOGLE_API_KEY=your_google_api_key \
    -e OPENAI_API_KEY=your_openai_api_key \
    -v ~/.adalflow:/root/.adalflow \
    ghcr.io/asyncfuncai/deepwiki-open:latest

Alternatively, use the provided docker-compose.yml:

# Ensure the .env file is configured with API keys first
docker-compose up

API server details

The API server manages the following core functions:

• Repository cloning and indexing.
• RAG (Retrieval-Augmented Generation) operations.
• Streaming chat completions.

DeepWiki FAQ

API key issues

• "Missing environment variables": Verify that the .env file is located in the project root and contains both required API keys.
• "Invalid API key": Confirm the key was copied correctly without trailing spaces or hidden characters.

Connection issues

• "Cannot connect to API server": Check that the API server is active and listening on port 8001.
• "CORS errors": The API is configured to allow all origins. If errors persist, ensure the frontend and backend are running on the same network or machine.

Generation issues

• "Error generating wiki": For exceptionally large repositories, test the tool with a smaller project first.
• "Invalid repo format": Ensure the input follows a standard GitHub or GitLab URL format.
• "Cannot fetch repo structure": For private repositories, verify that the personal access token is valid and has the necessary read permissions.
• "Diagram rendering error": The application includes an automated recovery feature to fix broken diagram syntax.