DeepWiki-Open — открытая альтернатива DeepWiki: вики-документация по репозиторию с диаграммами и RAG-чатом

· 2 мин чтения
documentation rag wiki mermaid self-hosted
📂 Исходный код на GitHub

Open-source генератор вики-документации для репозиториев GitHub, GitLab и Bitbucket: анализ кода, Mermaid-диаграммы, карта кода, RAG-чат Ask и многошаговый DeepResearch.

DeepWiki-Open — открытая альтернатива DeepWiki: вики-документация по репозиторию с диаграммами и RAG-чатом

DeepWiki-Open — это open-source реализация идеи DeepWiki: сервис, который автоматически превращает любой репозиторий GitHub, GitLab или Bitbucket в красивую интерактивную вики. Указываете ссылку на репозиторий — и получаете сгенерированную документацию, визуальные диаграммы архитектуры и карту кода для пошаговых экскурсий по кодовой базе. Проект набрал около 18 тысяч звёзд и 2 тысяч форков, распространяется под лицензией MIT.

Репозиторий: AsyncFuncAI/deepwiki-open. Бэкенд написан на Python (FastAPI), фронтенд — на Next.js. Недавно вышла версия DeepWiki-Open 2.0 под названием Grok Wiki, дистрибутив доступен на grok-wiki.com.

Что получается на выходе

Достаточно ввести имя репозитория, и DeepWiki выполнит пять шагов:

  1. Проанализирует структуру кода
  2. Сгенерирует полноценную документацию
  3. Построит визуальные диаграммы, объясняющие работу системы
  4. Организует всё в удобную навигируемую вики
  5. Создаст codemap — карту кода для code-centric экскурсий по проекту

Ключевые возможности:

  • Мгновенная документация — любой репозиторий превращается в вики за считанные секунды
  • Приватные репозитории — безопасный доступ через персональные токены
  • Умный анализ — ИИ понимает структуру и взаимосвязи в коде
  • Диаграммы Mermaid — автоматическая генерация схем архитектуры и потоков данных
  • Режим «Спросить» (Ask) — общение с репозиторием через RAG для точных ответов по коду
  • DeepResearch — многошаговое исследование сложных тем
  • Гибкий выбор моделей — Google Gemini, OpenAI, OpenRouter, Azure OpenAI и локальные Ollama

Как это работает

Внутри конвейер из нескольких этапов:

  1. Клонирование и анализ репозитория GitHub, GitLab или Bitbucket (приватные — через токены доступа)
  2. Создание эмбеддингов кода для интеллектуального поиска
  3. Генерация документации с учётом контекста выбранным провайдером моделей
  4. Построение диаграмм, показывающих связи в коде
  5. Организация всего в структурированную вики

Поверх этого работают интерактивные режимы. Ask отвечает на вопросы по коду через RAG: подбираются релевантные фрагменты репозитория, ответ стримится в реальном времени, поддерживается история общения. DeepResearch проводит многошаговый анализ: модель сама строит план исследования, собирает промежуточные результаты и выдаёт итоговый вывод. Включается переключателем «Deep Research» в интерфейсе.

Поддерживаемые провайдеры и модели

Провайдер Модели Ключ
Google gemini-2.5-flash (по умолчанию), gemini-2.5-flash-lite, gemini-2.5-pro GOOGLE_API_KEY
OpenAI gpt-5-nano (по умолчанию), gpt-5, 4o и другие OPENAI_API_KEY
OpenRouter Claude, Llama, Mistral и множество других через единый API OPENROUTER_API_KEY
Azure OpenAI gpt-4o (по умолчанию) и другие AZURE_OPENAI_API_KEY + endpoint и версия
Ollama Локальные open-source модели, например llama3 OLLAMA_HOST

Важный нюанс: ключ OPENAI_API_KEY нужен даже при генерации через Google — он используется для создания эмбеддингов. Если нужны OpenAI-совместимые эмбеддинги (например, Alibaba Qwen), замените api/config/embedder.json на embedder_openai_compatible.json и задайте OPENAI_BASE_URL — значения подставятся из переменных окружения автоматически. Для корпоративных сценариев есть и кастомный OPENAI_BASE_URL: можно подключить приватные API OpenAI или self-hosted решения.

Установка и запуск

Самый быстрый путь — Docker Compose:

git clone https://github.com/AsyncFuncAI/deepwiki-open.git
cd deepwiki-open

# Create .env with your API keys
echo "GOOGLE_API_KEY=your_google_api_key" > .env
echo "OPENAI_API_KEY=your_openai_api_key" >> .env
docker-compose up

Ручная установка состоит из трёх шагов:

# Step 1: backend (Python + Poetry)
python -m pip install poetry==2.0.1 && poetry install -C api
python -m api.main

# Step 2: frontend (Next.js)
npm install
npm run dev

# Step 3: open http://localhost:3000

Дальше — вводите URL репозитория (например, https://github.com/openai/codex), для приватных репозиториев добавляете токен доступа и нажимаете «Generate Wiki».

Есть готовый образ на GitHub Container Registry:

docker pull ghcr.io/asyncfuncai/deepwiki-open:latest

В каталоге ~/.adalflow хранятся клонированные репозитории, эмбеддинги, индексы и кэшированные вики. Помимо основного compose-файла, в репозитории есть варианты для LiteLLM (docker-compose-litellm.yml) и полностью локальной работы через Ollama (Dockerfile-ollama-local с отдельной инструкцией).

Для ограничения доступа предусмотрен режим авторизации: при DEEPWIKI_AUTH_MODE=true генерация вики требует секретный код из DEEPWIKI_AUTH_CODE. Это защищает фронтенд и кэш, но не блокирует прямые вызовы API — учитывайте это при публичном деплое.

Архитектура и конфигурация

Проект разделён на две части:

deepwiki/
├── api/                  # Backend API server
│   ├── main.py           # API entry point
│   ├── api.py            # FastAPI implementation
│   ├── rag.py            # RAG generation
│   └── data_pipeline.py  # Data processing utilities
├── src/                  # Next.js client app
│   ├── app/page.tsx      # Main page
│   └── components/Mermaid.tsx  # Mermaid diagram rendering
└── .env                  # Environment variables

API-сервер клонирует и индексирует репозитории, реализует RAG и поддерживает потоковую генерацию. Поведение настраивается через три JSON-файла в api/config/:

  • generator.json — конфигурация генерации текста и моделей
  • embedder.json — настройки эмбеддингов и ретривера
  • repo.json — правила обработки репозиториев

Путь к конфигурации можно переопределить переменной DEEPWIKI_CONFIG_DIR. Логирование стандартное для Python: LOG_LEVEL и LOG_FILE_PATH (по умолчанию api/logs/application.log), каталог монтируется в Docker для сохранности логов между перезапусками.

Кому подойдёт

  • Онбординг в незнакомый проект — вместо получасового блуждания по файлам читаете готовую вики с диаграммами
  • Изучение опенсорса — codemap и Ask позволяют задавать вопросы прямо по коду
  • Внутренние приватные репозитории — self-hosted деплой с токенами доступа и режимом авторизации
  • Работа без облака — поддержка Ollama даёт полностью локальный сценарий генерации

OpenRouter как провайдер удобен для сравнения моделей по цене и качеству: один ключ открывает доступ к моделям OpenAI, Anthropic, Google, Meta и других без регистрации в каждом сервисе.

В сухом остатке

DeepWiki-Open — зрелый опенсорс-инструмент (18k звёзд, MIT) для автоматической генерации вики-документации по кодовым базам. Ключевые плюсы: приватные репозитории, Mermaid-диаграммы, RAG-чат и DeepResearch, гибкость в выборе провайдеров вплоть до полностью локальных моделей. Минус, о котором стоит помнить: для эмбеддингов по умолчанию нужен ключ OpenAI, даже если саму документацию генерирует Gemini. Если вам нравится идея DeepWiki, но нужен self-hosted вариант — это самый популярный выбор.

Источник: https://github.com/AsyncFuncAI/deepwiki-open