deepwiki-rs

环境要求

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

安装与启动步骤

1. 1安装 deepwiki-rs

   官方推荐方式，直接从 crates.io 安装到本地 Cargo 环境，装好后即可全局调用 deepwiki-rs 命令。

   cargo install deepwiki-rs

   复制

2. 2或从源码构建

   想用最新代码时，克隆仓库后以 release 模式编译；产物在 target/release 下。

   git clone https://github.com/sopaco/deepwiki-rs
   cd deepwiki-rs
   cargo build --release

   复制

3. 3准备模型与密钥

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

4. 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. 5配置 litho.toml

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

关键配置

如何确认成功

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

常见问题

注意事项

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