AI 应用人工智能RAG文档【免费下载链接】deepwiki-openOpen Source DeepWiki: AI-Powered Wiki Generator for GitHub/Gitlab/Bitbucket Repositories. Join the discord: https://discord.gg/gMwThUMeme项目地址https://gitcode.com/gh_mirrors/de/deepwiki-open点击查看免费下载DeepWiki-Open 是一个开源实现的开源版 DeepWiki——只需输入一个 GitHub、GitLab 或 Bitbucket 仓库地址它就会自动克隆代码、分析结构、生成完整文档与可视化架构图并组织成易于浏览的 Wiki同时提供基于 RAG 的仓库问答Preguntas与多轮深度研究Investigación Profunda能力。本文以仓库中的 README.es.md西班牙语版官方文档为主体骨架结合 api/ 后端与 src/ 前端源码系统讲解部署方式、模型供应商选择系统、Embedding 配置、问答与研究功能以及常见故障排查帮助你从零搭建并深度定制自己的 DeepWiki 服务。一、DeepWiki-Open 是什么DeepWiki 能够自动为任意 GitHub、GitLab 或 BitBucket 仓库创建精美且可交互的 Wiki。输入仓库名后它会依次完成以下工作分析代码结构Analizar la estructura del código生成全面的文档Generar documentación completa创建可视化图表解释各部分如何协同工作Crear diagramas visuales将全部内容组织成易于导航的 WikiOrganizar todo en una wiki生成 codemap提供以代码为中心的引导式浏览Generar un mapa de código从当前仓库的源码结构看这套流程由后端任务状态机完整落地api/services/wiki/tasks.py 中的generate_repo_wiki依次驱动INDEXING → DETERMINING_STRUCTURE → GENERATING → COMPLETED四个阶段分别对应索引构建、结构确定、页面生成与缓存落盘。核心特性一览即时文档化数秒内将任意 GitHub、GitLab 或 BitBucket 仓库转化为 Wiki私有仓库支持通过个人访问令牌Personal Access Token安全访问私有仓库智能分析由 AI 驱动的代码结构与关系理解精美图表自动生成 Mermaid 图可视化架构与数据流简单导航直观易用的界面浏览 Wiki 内容问答功能基于 RAG检索增强生成与仓库对话获得精准答案深度研究多轮研究流程深入剖析复杂主题多模型供应商支持 Google Gemini、OpenAI、OpenRouter 以及本地 Ollama 模型DeepWiki 主界面screenshots/Interface.png二、快速开始两种部署方式方式一使用 Docker最简单# 克隆仓库 git clone https://github.com/AsyncFuncAI/deepwiki-open.git cd deepwiki-open # 创建 .env 文件并写入你的 API 密钥 echo GOOGLE_API_KEYyour_google_api_key .env echo OPENAI_API_KEYyour_openai_api_key .env # 可选如使用 OpenRouter 模型追加 OpenRouter 密钥 echo OPENROUTER_API_KEYyour_openrouter_api_key .env # 使用 Docker Compose 一键启动 docker-compose up说明数据持久化上述 Docker 命令以及docker-compose.yml的配置会把宿主机上的~/.adalflow目录挂载到容器内的/root/.adalflow。该路径用于存放克隆的仓库~/.adalflow/repos/这些仓库的 embeddings 与索引~/.adalflow/databases/已生成并缓存的 Wiki 内容~/.adalflow/wikicache/这样即使容器停止或被删除你的数据也能持久保留。从 docker-compose.yml 可以看到更多部署细节API 端口默认8001可用PORT环境变量覆盖Next.js 前端占用3000容器还通过LOG_FILE_PATH默认api/logs/application.log持久化日志并配置了 6G 内存上限、2G 预留以及/health健康检查间隔 60s、超时 10s、重试 3 次、启动等待 30s。API 密钥获取位置Google 密钥在 Google AI Studio 获取OpenAI 密钥在 OpenAI Platform 获取。方式二手动配置推荐便于开发调试第 1 步配置 API 密钥在项目根目录创建.env文件GOOGLE_API_KEYyour_google_api_key OPENAI_API_KEYyour_openai_api_key # 可选如使用 OpenRouter 模型追加此行 OPENROUTER_API_KEYyour_openrouter_api_key第 2 步启动后端# 安装 Python 依赖使用 Poetry python -m pip install poetry2.0.1 poetry install -C api # 启动 API 服务 python -m api.main后端入口为 api/main.py所有密钥在 api/config.py 中通过os.environ.get统一加载并回写进环境变量供全链路使用。第 3 步启动前端# 安装 JavaScript 依赖 npm install # 或 yarn install # 启动 Web 应用 npm run dev # 或 yarn dev第 4 步使用 DeepWiki在浏览器打开 http://localhost:3000输入 GitHub、GitLab 或 Bitbucket 仓库地址例如https://github.com/openai/codex、https://github.com/microsoft/autogen、https://gitlab.com/gitlab-org/gitlab、https://bitbucket.org/redradish/atlassian_app_versions对私有仓库点击 Agregar tokens de acceso添加访问令牌并输入你的 GitHub 或 GitLab 个人访问令牌点击 Generar Wiki生成 Wiki等待生成完成通过个人访问令牌访问私有仓库screenshots/privaterepo.png私有仓库克隆原理对应源码 api/repository.py不同平台采用不同的令牌注入方式——GitHub 将令牌拼进 URL 认证段GitLab 使用oauth2:token方案Bitbucket 则根据令牌前缀自动选择认证方案以ATCTT开头的 HTTP 访问令牌使用x-bitbucket-api-token-auth旧版 App Password 使用x-token-auth。克隆采用--depth1 --single-branch浅克隆以提升速度且错误信息中会自动掩码令牌替换为***TOKEN***防止凭据泄露。三、工作原理DeepWiki 使用 AI 完成以下完整流程克隆并分析 GitHub、GitLab 或 Bitbucket 仓库私有仓库通过令牌认证为代码创建 embeddings实现智能检索结合上下文用 AI 生成文档使用 Google Gemini、OpenAI、OpenRouter 或本地 Ollama 模型创建可视化图表解释代码关系组织成结构化的 Wiki通过问答功能支持与仓库智能对话通过深度研究提供深入调研能力官方文档给出了如下端到端流程图MermaidEmbedding 索引的实现细节见 api/rag/pipeline.pyread_all_documents按code_extensions/doc_extensions过滤文件并读取内容通过 tiktoken 统计 token 数超过MAX_EMBEDDING_TOKENS * 10即 81920 token的大文件会被跳过LineTrackingTextSplitter在 adalflow 的TextSplitter基础上为每个 chunk 标注 1 起始的start_line/end_line随后经ToEmbeddings批量向量化后存入LocalDB保存为databases/{repo_name}.pkl并支持索引已存在则直接加载复用的缓存策略。四、项目结构官方文档给出了顶层结构概览结合当前仓库实际布局整理如下deepwiki/ ├── api/ # API 后端服务器 │ ├── main.py # API 入口 │ ├── repository.py # 仓库克隆与解析GitHub/GitLab/Bitbucket │ ├── config.py # 配置加载、模型/Embedder 装配 │ ├── config/ # 配置文件目录generator/embedder/repo/lang │ ├── rag/ # RAG 流水线索引构建、检索 │ ├── services/ # wiki 生成、research问答与深度研究 │ ├── routers/ # FastAPI 路由chat/repo/wiki/auth/system/codemap │ ├── schemas/ # Pydantic 数据模型 │ └── clients/ # 各模型供应商客户端 │ ├── src/ # Next.js 前端 │ ├── app/ # Next.js app 目录 │ │ └── page.tsx # 应用主页 │ └── components/ # React 组件 │ ├── Mermaid.tsx # Mermaid 图渲染器 │ ├── CodeMap.tsx # Codemap 组件 │ ├── Ask.tsx # 问答组件 │ └── ... │ ├── public/ # 静态资源 ├── package.json # JavaScript 依赖 └── .env # 环境变量需自行创建五、基于提供者的模型选择系统核心章节DeepWiki 实现了一套灵活、基于提供者provider的模型选择系统支持多个 LLM 供应商无需修改代码即可切换模型。5.1 支持的供应商与模型Google默认gemini-2.5-flash同时支持gemini-2.5-flash-lite、gemini-2.5-pro等OpenAI默认gpt-5-nano同时支持gpt-5、4o等OpenRouter通过统一 API 访问众多模型包括 Claude、Llama、Mistral 等Ollama支持本地运行的开源模型如llama3结合当前仓库实际配置api/config/generator.json系统实际预置的供应商还包括DashScope通义千问、Amazon Bedrock、Azure并通过_DEFAULT_PROVIDER_MAPapi/config.py将每个 provider 映射到具体的客户端类GoogleGenAIClient、OpenAIClient、LiteLLMClient、OpenRouterClient、OllamaClient、BedrockClient、AzureAIClient、DashscopeClient等。每个模型都带有独立的采样参数例如Google 系列temperature: 1.0、top_p: 0.8、top_k: 20OpenAIgpt-4o/o1temperature: 0.7、top_p: 0.8Ollama 本地模型通过options传入temperature、top_p和上下文窗口num_ctx如qwen3:1.7b为 32000llama3:8b为 8000Bedrock预置 Claude 3 Sonnet/Haiku/Opus、Amazon Titan、Cohere Command R、AI21 J2 Ultra 等get_model_config(provider, model)api/config.py负责按供应商解析出model_client与model_kwargs对 Ollama 走options结构其他供应商走标准参数结构。若省略模型名会自动使用该供应商的default_model。5.2 环境变量每个供应商需要对应的 API 密钥环境变量# API 密钥 GOOGLE_API_KEYtu_clave_api_google # Google Gemini 模型必需 OPENAI_API_KEYtu_clave_api_openai # OpenAI 模型必需 OPENROUTER_API_KEYtu_clave_api_openrouter # OpenRouter 模型必需 # OpenAI API 基础 URL 配置 OPENAI_BASE_URLhttps://punto-final-personalizado.com/v1 # 可选用于自定义 OpenAI API 端点 # 配置目录 DEEPWIKI_CONFIG_DIR/ruta/a/directorio/config/personalizado # 可选自定义配置文件存放位置5.3 配置文件DeepWiki 使用 JSON 配置文件管理系统的各个方面默认位于api/config/目录可通过DEEPWIKI_CONFIG_DIR环境变量更换位置。加载逻辑见 api/config.pyload_json_config会读取 JSON 并递归执行replace_env_placeholders将配置中的${ENV_VAR}占位符替换为环境变量值缺失时保留原样并记录警告。配置文件用途generator.json文本生成模型配置定义可用供应商Google、OpenAI、OpenRouter、Ollama 等、各供应商默认与可用模型、温度与 top_p 等模型参数embedder.jsonEmbedding 模型与文本处理配置定义用于向量存储的 embedding 模型、RAG 检索器配置、文档切分器设置repo.json仓库处理配置文件过滤器排除文件/目录、代码/文档扩展名、仓库大小上限与处理规则以当前仓库真实配置为例api/config/embedder.json 中embedder默认OpenAIclient_class: OpenAIClient、batch_size: 500模型text-embedding-3-smalldimensions: 256、encoding_format: floatembedder_ollama本地OllamaClientnomic-embed-textembedder_googleGoogleEmbedderClient、batch_size: 100模型gemini-embedding-001task_type: SEMANTIC_SIMILARITYembedder_bedrockBedrockClient模型amazon.titan-embed-text-v2:0retrievertop_k: 20检索返回 Top-20 片段text_splitter按词切分split_by: wordchunk_size: 350chunk_overlap: 100而 api/config/repo.json 中file_filters默认排除.venv/、node_modules/、.git/、dist/、build/、docs/等目录以及yarn.lock、poetry.lock、.env、各类锁文件与二进制/压缩包等文件code_extensions覆盖.py/.js/.ts/.java/.cpp/.go/.rs/.tsx等 17 种扩展名doc_extensions覆盖.md/.txt/.rst/.json/.yaml/.ymlrepository.max_size_mb默认 50000。这些过滤器由iterate_filesapi/config.py统一执行保证 Wiki 文件树与实际被索引的文件完全一致。5.4 服务商自定义模型选择自定义模型选择功能专门面向服务提供商设计满足以下需求为组织内用户提供不同 AI 模型的可选项无需修改代码即可快速适配快速演进的 LLM 生态支持预定义列表之外的特制模型或微调模型你可以在前端界面中从预定义选项里选择模型或直接输入自定义模型标识符来扩展你的模型供给。5.5 企业私有通道的 Base URL 配置OpenAI 客户端的base_url配置主要面向拥有私有 API 通道的企业用户允许连接私有或企业专属的 API 端点允许组织使用自托管或定制部署的 LLM 服务支持与兼容 OpenAI API 的第三方服务集成即将推出后续更新中DeepWiki 将支持用户在自己的请求中提供 API 密钥的模式让拥有私有通道的企业客户复用现有 API 配置而无需与 DeepWiki 部署共享凭据。六、使用 OpenAI 兼容的 Embedding 模型如阿里 Qwen如果你希望使用兼容 OpenAI API 的 Embedding 模型例如阿里云 Qwen按以下步骤操作用api/config/embedder_openai_compatible.json的内容替换api/config/embedder.json的内容该示例配置见仓库 api/config/embedder.openai_compatible.json.bak使用initialize_kwargs中的${OPENAI_API_KEY}、${OPENAI_BASE_URL}占位符embedding 模型为text-embedding-v3batch_size: 10在项目根目录的.env文件中配置必要的环境变量例如OPENAI_API_KEYtu_api_key OPENAI_BASE_URLtu_endpoint_compatible_openai程序会自动把embedder.json中的占位符替换为环境变量的实际值这样无需改动任何代码即可切换到任意 OpenAI 兼容的 Embedding 服务。补充默认 Embedder 类型由DEEPWIKI_EMBEDDER_TYPE环境变量控制默认openai可取值openai/google/ollama/bedrock见 api/config.pyget_embedder会根据类型自动选择embedder/embedder_google/embedder_ollama/embedder_bedrock并装配Embedder实例。七、问答Preguntas与深度研究Investigación Profunda7.1 问答功能问答功能让你通过**检索增强生成RAG**与仓库对话上下文感知的回答基于仓库真实代码给出准确答案RAG 驱动系统检索相关代码片段提供有依据的回答实时流式输出答案边生成边展示交互体验更流畅对话历史系统在问题之间保持上下文交互更连贯从实现层面看api/services/research.pyresearch_chat会把历史消息按用户-助手配对写入rag.memory.add_dialog_turn以维护多轮上下文并将用户消息注入检索器回答经ChatStreamer流式返回api/chat/_stream.py若输入 token 数超过MAX_INPUT_TOKENS7500低于 8192 的模型上限系统会记录告警。7.2 深度研究功能深度研究将仓库分析提升到新高度采用多轮研究流程深入调查通过多轮研究迭代深挖复杂主题结构化过程遵循清晰的研究计划带阶段更新与完整结论自动延续AI 自动持续研究直至得出结论最多 5 次迭代研究阶段研究计划描述方法与初步发现研究更新在先前迭代基础上融入新视角最终结论基于所有迭代给出完整回答使用方式在问答界面的发送按钮前打开 Investigación Profunda深度研究开关即可。对应源码api/services/research.py当检测到mode deep_research时系统按research_iteration区分首次迭代DEEP_RESEARCH_FIRST_ITERATION_PROMPT、中间迭代DEEP_RESEARCH_INTERMEDIATE_ITERATION_PROMPT与最终迭代DEEP_RESEARCH_FINAL_ITERATION_PROMPT并在迭代次数达到 5 时输出最终结论。深度研究对复杂主题进行多轮调查screenshots/DeepResearch.png八、常见故障排查API 密钥问题Faltan variables de entorno缺少环境变量确认.env文件位于项目根目录且包含所需密钥Clave API no válidaAPI 密钥无效检查是否完整复制密钥、有无多余空格Error de API OpenRouter确认 OpenRouter 密钥有效且账户有足够额度连接问题No se puede conectar al servidor API无法连接 API 服务器确认 API 服务器运行在8001端口Error CORSAPI 已配置为允许所有来源但若仍有问题尝试将前端与后端运行在同一台机器上生成问题Error al generar wiki生成 Wiki 出错仓库过大时先尝试较小的仓库Formato de repositorio no válido仓库格式无效确认使用的是 GitHub、GitLab 或 Bitbucket 的合法 URL 格式No se pudo obtener la estructura del repositorio无法获取仓库结构私有仓库请确认输入的 personal access token 有效且具有相应权限Error de renderizado de diagrama图表渲染错误应用会自动尝试修复损坏的图表通用解决方案重启前后端两个服务简单的重启往往能解决大部分问题检查浏览器控制台打开浏览器开发者工具查看 JavaScript 错误检查 API 日志查看运行 API 的终端中的 Python 错误输出日志默认写入api/logs/application.log九、结语围绕 README.es.md 这份官方文档本文完整覆盖了 DeepWiki-Open 的部署Docker 与手动两种方式、端到端工作原理、基于提供者的多模型选择系统环境变量、generator.json/embedder.json/repo.json三份核心配置、OpenAI 兼容 Embedding 的切换方案、RAG 问答与最多 5 轮的深度研究以及故障排查清单。你可以在此基础上继续阅读 README.md英文原版、README.zh.md简体中文版或其他语言版本并结合 api/config/ 下的配置文件与 api/services/wiki/tasks.py、api/rag/pipeline.py 等源码深入理解其实现。项目采用 MIT 许可证详见 LICENSE。赞分享AI 应用人工智能RAG文档【免费下载链接】deepwiki-openOpen Source DeepWiki: AI-Powered Wiki Generator for GitHub/Gitlab/Bitbucket Repositories. Join the discord: https://discord.gg/gMwThUMeme项目地址https://gitcode.com/gh_mirrors/de/deepwiki-open点击查看免费下载相关推荐DeepWiki-Open 实战指南为 GitHub/GitLab/Bitbucket 仓库一键生成 AI 驱动的交互式 WikiDeepWiki Open 实战指南为 GitHub/GitLab/Bitbucket 仓库一键生成 AI 驱动的交互式 Wiki DeepWiki OpenAI 应用人工智能RAG文档DeepWiki-Open 部署与配置实战为 GitHub/GitLab/Bitbucket 仓库自动生成 AI 交互式 WikiDeepWiki Open 部署与配置实战为 GitHub/GitLab/Bitbucket 仓库自动生成 AI 交互式 Wiki DeepWiki OpenAI 应用人工智能RAG文档DeepWiki-Open 实战指南为 GitHub/GitLab/Bitbucket 仓库自动生成 AI 交互式 Wiki 的部署、配置与深度研究DeepWiki Open 实战指南为 GitHub/GitLab/Bitbucket 仓库自动生成 AI 交互式 Wiki 的部署、配置与深度研究 DeepAI 应用人工智能RAG文档上一篇gclone命令行完全指南从基础操作到高级参数设置下一篇柯南平台Conan常见问题解答新手必知的15个流量回放技巧创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考