deepwiki-rs命令行完全指南从基础命令到高级参数的实战手册【免费下载链接】deepwiki-rsTurn code into clarity. Generate accurate technical docs and AI-ready context in minutes—perfectly structured for human teams and intelligent agents.项目地址: https://gitcode.com/gh_mirrors/de/deepwiki-rs在开始前先明确这篇文章的主角deepwiki-rs 命令行工具。deepwiki-rs又称 Litho是一款基于 Rust 的高性能 AI 文档生成引擎只需一条命令就能把任意代码库翻译成结构清晰、带 C4 架构图Context / Container / Component / Code的专业技术文档。本文将从安装、基础命令讲起逐步深入到双模型配置、缓存控制、知识挂载等高级参数帮你从零上手、快速生成高质量的项目架构文档。一、快速安装 deepwiki-rs两种方式任选1. 从 crates.io 一键安装推荐前提是已安装 Rust1.70 及以上与 Cargocargo install deepwiki-rs2. 从源码构建最新版git clone https://gitcode.com/gh_mirrors/de/deepwiki-rs cd deepwiki-rs cargo build --release # 可执行文件位于 target/release/ 目录安装完成后在终端输入deepwiki-rs --version即可验证是否成功。二、基础命令第一次生成文档就这么简单1. 最简用法一条命令生成当前项目文档在项目根目录直接运行deepwiki-rs工具会自动扫描代码结构、调用 LLM 分析并把文档输出到默认目录./litho.docs。2. 指定项目路径与输出目录deepwiki-rs -p ./my-project -o ./docs这里-p指定待分析的项目路径-o指定文档输出位置这两个参数是最常用的基础命令。3. 指定生成文档的语言# 生成中文文档 deepwiki-rs -p ./my-project --target-language zh # 生成日文文档 deepwiki-rs -p ./my-project --target-language ja支持zh、en、ja、ko、de、fr、ru、vi八种目标语言见 src/cli.rs。三、LLM 配置参数让 deepwiki-rs 跑起来的核心deepwiki-rs 的文档生成依赖大模型 API以下是必学的核心参数1. 最基础的 LLM 参数组合deepwiki-rs -p ./src \ --llm-api-base-url https://api.openai.com/v1 \ --llm-api-key sk-你的密钥 \ --model-efficient gpt-4o-mini \ --model-powerful gpt-4o2. 双模型机制高效 强大的黄金组合--model-efficient负责常规推理任务的高效模型速度快、成本低--model-powerful负责复杂架构推理的高质量模型并在高效模型失败时自动兜底推荐在生产环境中配置双模型例如高效模型用gpt-4o-mini、强大模型用gpt-4o既省 token 又保证质量参考 litho-example.toml。3. 支持 8 大 LLM 提供商支持openai、moonshot、deepseek、mistral、openrouter、anthropic、gemini以及本地部署的ollama无需 API Key默认地址http://localhost:11434。切换提供商只需一个参数deepwiki-rs -p ./src --llm-provider deepseek \ --llm-api-base-url https://api.deepseek.com \ --llm-api-key ${DEEPSEEK_API_KEY}四、高级参数实战控制生成过程与性能1. 跳过阶段节省时间deepwiki-rs 的流水线分四步预处理Preprocessing→ 研究Research→ 编排Composition→ 输出Output参见 src/generator/workflow.rs。你可以按需跳过# 跳过预处理适合已生成过中间缓存的项目 deepwiki-rs --skip-preprocessing # 跳过 AI 研究阶段 deepwiki-rs --skip-research # 跳过最终文档生成只做分析 deepwiki-rs --skip-documentation2. 缓存控制断点续跑与强制重生成# 关闭缓存 deepwiki-rs --no-cache # 强制重新生成清空缓存后完整重跑 deepwiki-rs --force-regenerate缓存机制让重复生成的耗时大幅降低日常增量修改代码后直接重跑即可无需担心重复消耗 token。3. 并发与上下文调优deepwiki-rs --max-tokens 4000 --temperature 0.7 \ --max-parallels 4 --tool-concurrency 4 --verbose--max-tokens单次请求最大 token 数--temperature模型随机性0.0 确定 / 1.0 创意--max-parallels并行 LLM 请求数默认 3--tool-concurrencyReAct 循环中的工具并发数默认 4--verbose开启详细日志便于排查问题4. 边界分析调优专治 504 超时对大项目或较慢的 LLM边界分析容易超时可用以下参数快速收敛详见 litho-example.tomldeepwiki-rs --boundary-code-limit 25 \ --boundary-include-source false \ --boundary-only-directories-when-files-more-than 100五、sync-knowledge 子命令挂载外部知识源deepwiki-rs 支持把 PDF、Markdown、SQL、YAML 等外部文档挂载为知识源让生成的文档带上业务上下文# 同步外部知识处理并缓存本地文档 deepwiki-rs sync-knowledge # 强制同步绕过缓存 deepwiki-rs sync-knowledge --force # 指定配置文件同步 deepwiki-rs sync-knowledge --config ./litho.toml在 litho-example.toml 中你可以把知识按architecture、database、api、deployment、adr、workflow、general分类并指定target_agents让每类文档精准投递给对应的 AI 智能体。六、用配置文件替代长命令litho.toml 使用技巧当参数越来越多推荐用配置文件管理。将 litho-example.toml 复制为项目根目录的litho.toml然后一条命令搞定deepwiki-rs --config ./litho.toml配置文件中可管理项目路径、输出目录、排除目录、LLM 双模型、缓存策略、知识库分类等全部设置。建议把配置文件纳入版本管理方便团队共享API Key 用环境变量${LITHO_LLM_API_KEY}注入切勿硬编码。七、常见问题速查问题解决方案提示 mermaid-fixer 未安装运行cargo install mermaid-fixer边界分析 504 超时使用--boundary-code-limit 25 --boundary-include-source false想用本地模型免费测试配置--llm-provider ollama无需 API Key文档重复生成太慢保留缓存去掉--force-regenerate直接重跑配置文件在哪找模板参考 litho-example.toml结语从最基础的deepwiki-rs -p ./my-project到双模型、缓存控制、知识挂载等高级参数deepwiki-rs 命令行工具用最简洁的语法把代码 → 文档这件事做到了极致。建议新手先用默认参数跑通流程再逐步尝试--model-efficient与--model-powerful双模型组合最后用litho.toml固化团队配置并接入 CI/CD 实现文档随提交自动更新。现在就动手让你项目里那份永远过期的文档变成随时与代码同步的活文档吧【免费下载链接】deepwiki-rsTurn code into clarity. Generate accurate technical docs and AI-ready context in minutes—perfectly structured for human teams and intelligent agents.项目地址: https://gitcode.com/gh_mirrors/de/deepwiki-rs创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
deepwiki-rs命令行完全指南从基础命令到高级参数的实战手册【免费下载链接】deepwiki-rsTurn code into clarity. Generate accurate technical docs and AI-ready context in minutes—perfectly structured for human teams and intelligent agents.项目地址: https://gitcode.com/gh_mirrors/de/deepwiki-rs在开始前先明确这篇文章的主角deepwiki-rs 命令行工具。deepwiki-rs又称 Litho是一款基于 Rust 的高性能 AI 文档生成引擎只需一条命令就能把任意代码库翻译成结构清晰、带 C4 架构图Context / Container / Component / Code的专业技术文档。本文将从安装、基础命令讲起逐步深入到双模型配置、缓存控制、知识挂载等高级参数帮你从零上手、快速生成高质量的项目架构文档。一、快速安装 deepwiki-rs两种方式任选1. 从 crates.io 一键安装推荐前提是已安装 Rust1.70 及以上与 Cargocargo install deepwiki-rs2. 从源码构建最新版git clone https://gitcode.com/gh_mirrors/de/deepwiki-rs cd deepwiki-rs cargo build --release # 可执行文件位于 target/release/ 目录安装完成后在终端输入deepwiki-rs --version即可验证是否成功。二、基础命令第一次生成文档就这么简单1. 最简用法一条命令生成当前项目文档在项目根目录直接运行deepwiki-rs工具会自动扫描代码结构、调用 LLM 分析并把文档输出到默认目录./litho.docs。2. 指定项目路径与输出目录deepwiki-rs -p ./my-project -o ./docs这里-p指定待分析的项目路径-o指定文档输出位置这两个参数是最常用的基础命令。3. 指定生成文档的语言# 生成中文文档 deepwiki-rs -p ./my-project --target-language zh # 生成日文文档 deepwiki-rs -p ./my-project --target-language ja支持zh、en、ja、ko、de、fr、ru、vi八种目标语言见 src/cli.rs。三、LLM 配置参数让 deepwiki-rs 跑起来的核心deepwiki-rs 的文档生成依赖大模型 API以下是必学的核心参数1. 最基础的 LLM 参数组合deepwiki-rs -p ./src \ --llm-api-base-url https://api.openai.com/v1 \ --llm-api-key sk-你的密钥 \ --model-efficient gpt-4o-mini \ --model-powerful gpt-4o2. 双模型机制高效 强大的黄金组合--model-efficient负责常规推理任务的高效模型速度快、成本低--model-powerful负责复杂架构推理的高质量模型并在高效模型失败时自动兜底推荐在生产环境中配置双模型例如高效模型用gpt-4o-mini、强大模型用gpt-4o既省 token 又保证质量参考 litho-example.toml。3. 支持 8 大 LLM 提供商支持openai、moonshot、deepseek、mistral、openrouter、anthropic、gemini以及本地部署的ollama无需 API Key默认地址http://localhost:11434。切换提供商只需一个参数deepwiki-rs -p ./src --llm-provider deepseek \ --llm-api-base-url https://api.deepseek.com \ --llm-api-key ${DEEPSEEK_API_KEY}四、高级参数实战控制生成过程与性能1. 跳过阶段节省时间deepwiki-rs 的流水线分四步预处理Preprocessing→ 研究Research→ 编排Composition→ 输出Output参见 src/generator/workflow.rs。你可以按需跳过# 跳过预处理适合已生成过中间缓存的项目 deepwiki-rs --skip-preprocessing # 跳过 AI 研究阶段 deepwiki-rs --skip-research # 跳过最终文档生成只做分析 deepwiki-rs --skip-documentation2. 缓存控制断点续跑与强制重生成# 关闭缓存 deepwiki-rs --no-cache # 强制重新生成清空缓存后完整重跑 deepwiki-rs --force-regenerate缓存机制让重复生成的耗时大幅降低日常增量修改代码后直接重跑即可无需担心重复消耗 token。3. 并发与上下文调优deepwiki-rs --max-tokens 4000 --temperature 0.7 \ --max-parallels 4 --tool-concurrency 4 --verbose--max-tokens单次请求最大 token 数--temperature模型随机性0.0 确定 / 1.0 创意--max-parallels并行 LLM 请求数默认 3--tool-concurrencyReAct 循环中的工具并发数默认 4--verbose开启详细日志便于排查问题4. 边界分析调优专治 504 超时对大项目或较慢的 LLM边界分析容易超时可用以下参数快速收敛详见 litho-example.tomldeepwiki-rs --boundary-code-limit 25 \ --boundary-include-source false \ --boundary-only-directories-when-files-more-than 100五、sync-knowledge 子命令挂载外部知识源deepwiki-rs 支持把 PDF、Markdown、SQL、YAML 等外部文档挂载为知识源让生成的文档带上业务上下文# 同步外部知识处理并缓存本地文档 deepwiki-rs sync-knowledge # 强制同步绕过缓存 deepwiki-rs sync-knowledge --force # 指定配置文件同步 deepwiki-rs sync-knowledge --config ./litho.toml在 litho-example.toml 中你可以把知识按architecture、database、api、deployment、adr、workflow、general分类并指定target_agents让每类文档精准投递给对应的 AI 智能体。六、用配置文件替代长命令litho.toml 使用技巧当参数越来越多推荐用配置文件管理。将 litho-example.toml 复制为项目根目录的litho.toml然后一条命令搞定deepwiki-rs --config ./litho.toml配置文件中可管理项目路径、输出目录、排除目录、LLM 双模型、缓存策略、知识库分类等全部设置。建议把配置文件纳入版本管理方便团队共享API Key 用环境变量${LITHO_LLM_API_KEY}注入切勿硬编码。七、常见问题速查问题解决方案提示 mermaid-fixer 未安装运行cargo install mermaid-fixer边界分析 504 超时使用--boundary-code-limit 25 --boundary-include-source false想用本地模型免费测试配置--llm-provider ollama无需 API Key文档重复生成太慢保留缓存去掉--force-regenerate直接重跑配置文件在哪找模板参考 litho-example.toml结语从最基础的deepwiki-rs -p ./my-project到双模型、缓存控制、知识挂载等高级参数deepwiki-rs 命令行工具用最简洁的语法把代码 → 文档这件事做到了极致。建议新手先用默认参数跑通流程再逐步尝试--model-efficient与--model-powerful双模型组合最后用litho.toml固化团队配置并接入 CI/CD 实现文档随提交自动更新。现在就动手让你项目里那份永远过期的文档变成随时与代码同步的活文档吧【免费下载链接】deepwiki-rsTurn code into clarity. Generate accurate technical docs and AI-ready context in minutes—perfectly structured for human teams and intelligent agents.项目地址: https://gitcode.com/gh_mirrors/de/deepwiki-rs创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
