DeepWiki-Open : un générateur de wiki open source pour les dépôts de code

Générer un wiki à partir d'une URL de dépôt

DeepWiki-Open est un outil open source qui génère automatiquement des pages wiki interactives pour les dépôts hébergés sur GitHub, GitLab ou Bitbucket. Étant donné une URL de dépôt, il clone le code, analyse sa structure et produit un wiki navigable avec des diagrammes Mermaid générés automatiquement qui expliquent l'architecture et le flux de données. Le projet est écrit en Python, avec un frontend Next.js et un backend FastAPI. Selon le README, les dépôts privés sont pris en charge lorsqu'un jeton d'accès personnel est fourni. Le README répertorie également des fonctionnalités telles que la documentation instantanée, la prise en charge des dépôts privés, l'analyse pilotée par l'IA, la génération automatique de diagrammes, la navigation simple, une fonction de questions-réponses basée sur le RAG, des capacités de recherche approfondie et la prise en charge de plusieurs fournisseurs de modèles. Le projet est distribué sous la licence MIT.

Deux façons de l'exécuter : Docker ou configuration manuelle

Pour exécuter DeepWiki-Open localement, le README décrit deux chemins. Le premier est Docker : après avoir cloné le dépôt, créez un fichier .env avec les clés API requises et exécutez docker-compose up. Cela monte un répertoire hôte pour conserver les dépôts clonés, les embeddings et le contenu wiki mis en cache après les redémarrages du conteneur. Le deuxième chemin est la configuration manuelle. Installez les dépendances Python avec poetry (python -m pip install poetry==2.0.1 && poetry install -C api), puis démarrez le serveur API avec python -m api.main. Pour le frontend, installez les dépendances JavaScript avec npm install ou yarn install, puis exécutez npm run dev ou yarn dev. L'application web est ensuite accessible à http://localhost:3000. Le README spécifie également des variables d'environnement pour les clés API, notamment GOOGLE_API_KEY, OPENAI_API_KEY et OPENROUTER_API_KEY, avec la note que si vous n'utilisez pas Ollama, vous avez toujours besoin d'une clé API OpenAI pour les embeddings.

Comment le backend et le frontend s'articulent

Le projet est divisé en une API backend et une application web frontend. Le backend, situé dans le répertoire api/, est un serveur FastAPI qui gère le clonage des dépôts, l'analyse du code, la création d'embeddings et la génération de documents. Il comprend également des modules pour la génération augmentée par récupération (rag.py) et le traitement des données (data_pipeline.py). Le frontend, sous src/, est une application Next.js qui fournit l'interface utilisateur et rend les diagrammes Mermaid via un composant dédié (Mermaid.tsx). Un organigramme dans le README illustre le pipeline de traitement : l'utilisateur soumet une URL de dépôt, l'outil vérifie s'il est privé, clone le code, analyse sa structure, crée des embeddings, sélectionne un fournisseur de modèles (Google, OpenAI, OpenRouter ou Ollama), génère des documents et des diagrammes, et organise le tout dans un wiki interactif.

Poser des questions et effectuer des recherches approfondies

DeepWiki-Open comprend une fonction de questions-réponses qui utilise la génération augmentée par récupération (RAG) pour répondre aux questions sur la base d'extraits de code réels du dépôt. Il diffuse les réponses en temps réel et maintient l'historique de conversation, permettant des interactions plus cohérentes. Une fonction distincte de recherche approfondie exécute une enquête en plusieurs étapes : elle crée d'abord un plan de recherche, puis fournit des mises à jour à chaque itération, et enfin donne une conclusion complète. L'IA continue automatiquement la recherche jusqu'à ce qu'elle atteigne une conclusion, avec un maximum de cinq itérations. Pour utiliser la recherche approfondie, vous activez le commutateur « recherche approfondie » dans l'interface avant de soumettre une question. Le README décrit également les étapes de recherche : plan de recherche, mises à jour de recherche et conclusion finale.

Fournisseurs de modèles, variables d'environnement et fichiers de configuration

DeepWiki-Open prend en charge plusieurs fournisseurs de modèles de langage : Google Gemini, OpenAI, OpenRouter et les modèles Ollama locaux. Le README répertorie les modèles par défaut : gemini-2.5-flash pour Google, gpt-5-nano pour OpenAI et llama3 pour Ollama. Chaque fournisseur nécessite une clé API stockée dans le fichier .env. Le système prend également en charge un mode d'autorisation qui restreint la génération de wiki aux utilisateurs disposant d'un code valide, activé via la variable d'environnement DEEPWIKI_AUTH_MODE. Cependant, le README note que ce mode ne peut pas bloquer complètement l'accès direct à l'API, ce n'est donc pas une frontière de sécurité. Les fichiers de configuration dans api/config/ contrôlent les paramètres du générateur, de l'embedder et du dépôt, et leur emplacement peut être modifié avec la variable d'environnement DEEPWIKI_CONFIG_DIR. Pour les modèles d'embedding compatibles OpenAI, tels que Alibaba Qwen, le README fournit un fichier de configuration alternatif et des instructions pour définir OPENAI_BASE_URL.

Dépannage et licence MIT

Le README comprend une section de dépannage qui traite des problèmes courants. Il recommande de vérifier que le fichier .env se trouve à la racine du projet et contient les clés API requises, de vérifier que le serveur API fonctionne sur le port 8001, et de redémarrer les deux serveurs si les problèmes persistent. Pour les grands dépôts, il suggère d'essayer d'abord un dépôt plus petit. Il note également que le mode d'autorisation n'est pas une mesure de sécurité complète, car un accès direct à l'API reste possible. La licence MIT sous laquelle le projet est distribué accorde la permission d'utiliser, copier, modifier, fusionner, publier, distribuer, sous-licencier et vendre le logiciel, mais elle fournit le logiciel « tel quel » sans garantie d'aucune sorte. Le README ne mentionne pas de benchmarks de performance, de préparation à la production ou de garanties de sécurité spécifiques au-delà de ce qui est énoncé dans la licence.

Conclusion éditoriale

DeepWiki-Open est un outil auto-hébergé qui peut générer une documentation riche et des wikis interactifs à partir de code source, avec la prise en charge de plusieurs fournisseurs d'IA et de dépôts privés. Le README ne fournit pas de benchmarks de performance ni de garanties de sécurité, ces aspects restent donc à vérifier.

Sources officielles

1. Official documentation
2. Official README
3. Project repository