deepwiki-rs

一键生成代码文档，让团队和 AI 秒懂项目

deepwiki-rs 是一个用 Rust 编写的开源工具，旨在将代码库自动转化为清晰、准确的技术文档和 AI 就绪的上下文。它解决了开发团队在维护文档时面临的耗时、易过时以及难以与代码同步的问题。核心能力包括自动分析代码结构、生成结构化文档，并输出为适合人类阅读和 AI 代理处理的格式。通过深度解析代码，它能够提供项目概览、模块说明、函数注释等，帮助新成员快速上手，同时为 AI 编程助手提供精准的代码上下文。其 Rust 实现保证了高性能和低资源占用，适合集成到 CI/CD 流程中。

开源 free 开源模型

访问官网 ↗ GitHub ↗ 文档 ↗

GitHub 星标 ★ 3085

维护状态较活跃

是否开源是

定价模式 free

项目数据

分类开源模型

开发团队sopaco

所属国家

官网地址https://deepwiki.netlify.app

GitHubhttps://github.com/sopaco/deepwiki-rs

定价模式free

价格说明开源项目，MIT 许可证，完全免费，可自行部署使用。

访问状态

是否开源是

开源协议MIT

主要语言Rust

技术栈/模型deepseek,deepwiki,dsh-plugin,grok,okf-format,openwiki

GitHub 星标★ 3085

30天Star增速

HF 下载量

上线时间2025-09-05 00:00:00

最近更新2026-09-23 00:00:00

维护状态较活跃

中文支持

访问方式

移动端支持

综合评分

收录时间2026-08-09

浏览次数11

使用教程

难度：入门约 15 分钟部署方式：命令行工具 5 步

环境要求

已安装 Rust 与 Cargo 工具链（cargo 命令可用）
一个可用的 LLM 服务：API Key 与 base-url（如 OpenAI、DeepSeek、OpenRouter 等）
待生成文档的本地代码库（例如 ./src 目录）
可选：从源码构建时需要 Git

安装与启动步骤

1安装 deepwiki-rs

官方推荐方式，直接从 crates.io 安装到本地 Cargo 环境，装好后即可全局调用 deepwiki-rs 命令。
```
cargo install deepwiki-rs
```
2或从源码构建

想用最新代码时，克隆仓库后以 release 模式编译；产物在 target/release 下。
```
git clone https://github.com/sopaco/deepwiki-rs
cd deepwiki-rs
cargo build --release
```
3准备模型与密钥

提前确认 LLM 提供商的 base-api 地址和 API Key，并按官方建议准备“高效模型”和“强力模型”两个模型名。
4运行生成文档

用 -p 指定要分析的代码目录，同时传入两个模型、base-url 和 api-key，即可自动生成 Repo-Wiki 文档。
```
deepwiki-rs -p ./src --model-efficient GPT-5-mini --model-poweruful GPT-5-Pro --llm-api-base-url https://api.openai.com/v1 --llm_api_key sk-xxxxxxxx
```
5配置 litho.toml

如需开启本地文档知识库与增量监听，在项目下创建 litho.toml 并写入 knowledge.local_docs 相关配置。

关键配置

配置项	必填	说明	示例
`--llm-api-base-url`	是	LLM 提供商的 API 基础地址	`https://api.openai.com/v1`
`--llm_api_key`	是	调用大模型所需的 API 密钥	`sk-xxxxxxxx`
`--model-efficient`	是	负责批量分析的高效模型，侧重成本与速度	`GPT-5-mini`
`--model-poweruful`	是	负责汇总撰写的强力模型（README 原文拼写如此）	`GPT-5-Pro`
`-p`	是	要分析的代码库目录路径	`./src`
`knowledge.local_docs.enabled`	否	是否启用本地文档知识库作为上下文来源	`true`

如何确认成功

运行命令后无报错并正常结束，即说明文档生成流程执行成功，可在输出目录查看生成的文档内容。

常见问题

Q：怎么安装 Litho？

A：推荐执行 cargo install deepwiki-rs；也可以克隆仓库后执行 cargo build --release 自行编译。

Q：没有 Rust 环境能装吗？

A：不能。项目是 Rust 编写的命令行工具，官方给出的两种安装方式都依赖 Cargo 工具链，需先安装 Rust。

Q：两个模型参数是必须的吗？

A：README 示例中同时设置了高效模型与强力模型，建议按示例同时提供，并搭配 base-url 与 api-key 使用。

Q：配置文件放在哪里？

A：README 示例为项目根目录下的 litho.toml，其中可配置本地文档知识库的开关、缓存目录与变更监听。

注意事项

README 示例中的参数拼写为 --model-poweruful，请以实际版本的 --help 输出为准，若报未知参数可尝试修正拼写。
API Key 属于敏感信息，请勿直接写入会提交到仓库的文件中。
项目已演进为 Terrain（https://github.com/sopaco/terrain），长期使用可关注迁移说明。

核心亮点

自动分析代码结构，生成结构化文档，减少手动维护成本
输出格式兼顾人类阅读和 AI 代理，提升开发效率
Rust 编写，性能高，适合集成到 CI/CD 流程

不足之处

文档/社区待观察
项目尚在成长中，生态和插件支持可能有限

适用场景

大型代码库的文档自动生成与维护
为 AI 编程助手提供代码上下文
新成员快速熟悉项目结构

替代项目

rustdoc、doxygen、sphinx

项目介绍

deepwiki-rs 是编程开发领域的开源项目，由 sopaco 开发，2025 年首次发布。

在全站 13,014 个收录项目中，它的 GitHub 星标数（3,085）位列前 30%，在编程开发分类的 490 个项目里位列前 15%。

近 42 天，它的 GitHub 星标从 1,683 增加到 3,085，净增 1,402。

项目保持着较活跃的维护节奏，最近一次代码更新于 2026-09-23。MIT 许可证，完全免费，可自行部署使用。

它主要面向的使用场景是：大型代码库的文档自动生成与维护。同类可对比的替代方案包括 rustdoc、doxygen、sphinx。

上一篇：swark

下一篇：zerostack