前言¶

在 DeepSeek Harness (DSH) 的生態中，插件是擴展智能體能力的主要方式。面對一個新項目，手動編寫 README.md 往往既耗時又容易遺漏關鍵信息，比如目錄結構、腳本命令或技術棧細節。# dsh-readme 插件旨在解決這一痛點，通過掃描項目文件自動生成結構化的文檔骨架。

是什麼¶

這是一個工作流插件，由 uckkk 維護。它掃描項目（package.json、目錄結構、技術棧、腳本、許可證），自動生成一份結構化的 README.md。它是純 Node 實現，無需網絡連接或外部服務。

核心功能¶

1. 項目掃描：讀取 package.json、目錄結構、腳本和許可證文件。
2. 技術棧識別：自動識別依賴，包括 React、Vue、Next、Vite、Express、NestJS、TypeScript、Tailwind 等。
3. 文檔生成：生成包含標題、描述、安裝、使用方法、項目結構樹和許可證的結構化骨架。

安裝與啓用¶

1. 安裝插件：

dsh plugin add dsh-readme

2. 安裝後，需在 profile 的 package.json 文件的 dsh.profile.bundles 字段中添加 "dsh-readme"，以啓用該插件。

典型用法¶

安裝完成後，在會話中調用該插件註冊的工具即可。

幫我給這個項目生成一份 README
→ 調用 generate_readme(root="/workspace")

適用場景與注意¶

• 該插件生成的是結構化骨架（含項目結構樹、scripts），具體的功能特性、API 說明等可生成後再補充潤色。
• 安全提示：安裝即在本機運行第三方代碼，請自行審閱源碼與許可證（MIT）後再使用。

結尾¶

經過上面的步驟，你可以快速獲得一份標準化的 README 骨架，專注於填充業務細節。相關代碼與目錄可在此查看：GitHub。