前言¶
DeepSeek Harness (DSH) 的理念是「一切皆插件」。在插件生态中，dsh-project-compass 提供了代码库分析能力。当你接手一个陌生项目时，最大的成本往往不是读代码，而是不知道从哪里开始，以及不知道修改哪里会破坏什么。
插件介绍¶
这是一个 AI 驱动的 DSH 插件，用于代码库分析、开发者入职和项目级问答。插件维护者为 lpeixin，采用 MIT 许可证。
核心功能¶
插件无需在线，也无需先运行项目，即可对现有代码库进行分析。
- 代码库分析：扫描项目结构。
- 生成文档：
-ARCHITECTURE.md：架构说明，包含分层与依赖关系。
-MODULE_MAP.md：模块地图，列出模块职责、文件列表、依赖关系。
-KEY_FLOWS.md：关键流程提取，包含流程图与证据。
-GETTING_STARTED.md：项目上手指南。 - 项目级 AI 问答：提供带引用的问答接口，返回答案时附带证据引用。
典型用法¶
在项目根目录下执行以下命令进行分析并生成报告：
node scripts/compass-cli.mjs analyze . && node scripts/compass-cli.mjs report .
插件会将生成的文档输出到 <project>/docs/project-compass/ 目录。这些生成的 artifacts 默认会被 .gitignore 忽略。
适用场景与注意¶
- 适用场景：新开发者入职、接手遗留项目、技术负责人评估变更影响范围、需要项目上下文的 AI 智能体。
- 注意：插件以当前 dsh 进程的权限运行，请确保在执行前检查源码与许可证。文档主要用中文编写。
结尾¶
dsh-project-compass 通过提供带证据引用的文档，解决了“理解项目”这一非结构化问题。更多细节请参考项目主页。
