實用工具

AI README 產生器

丟進零散的專案筆記,產出一份含安裝、用法和選項表的完整 README.md。

自備 Key 或官方託管AI 助手1.1萬
到哪裡取得 Key

Key 只在你的瀏覽器裡。Key 由瀏覽器直接傳給服務商,不經過我們的伺服器,我們不記錄也不保存。建議使用專門建立、設有額度上限的 Key,用完及時到服務商後台刪除。

輸入

結果

結果會顯示在這裡。

大多數專案的 README 只寫著「TODO」。把手邊有的東西都貼進來——一句專案描述、package.json、命令列工具的 --help 輸出、指令清單——就能得到一份完整的 README.md:標題與簡介、徽章、功能、需求、安裝、附可直接複製範例的用法、選項表、開發、貢獻和授權條款。章節順序參考了熱門的 README 鷹架命令列工具 kefranabg/readme-md-generator;差別在於你不必一題一題回答它的問題。

它是怎麼運作的

  • 筆記裡沒寫的資訊——儲存庫網址、版本、授權條款——會變成醒目的 <!-- TODO --> 預留位置,而不是捏造的事實。
  • 筆記中的旗標、選項和環境變數,會整理成含「選項、預設值、說明」欄位的表格。
  • 筆記用中文寫,也可以要一份英文 README,反過來也行;指令和程式碼永遠不會被翻譯。

你的資料去了哪裡

使用自備 Key 時,你輸入的內容和 Key 由瀏覽器直接傳送給你選擇的 AI 服務商,不經過 hysenlabs 的伺服器。使用官方託管時,內容經我們的伺服器轉送給我們的服務商(DeepSeek),以 credits 計費;我們只記錄每次執行的 Token 數和成本用於計費,從不保存你輸入的內容和回傳的結果。服務商如何處理這些內容,以它自己的隱私權政策為準。

本工具會接觸金鑰與憑證,因此任何一次執行都不會被儲存,連你自己的歷史裡也不會有。

關於你的 API Key

我們承諾不會收集、儲存或洩漏你的 Key:它只保存在目前頁面的記憶體裡(除非你勾選「在此分頁記住」),關閉頁面即消失。但任何 Key 只要在網頁裡用過,都值得多一分小心——建議專門為這裡建立一把設有額度上限的 Key,用完後及時到服務商後台刪除或輪換。

它要花多少

本工具完全免費,不需要登入,也不消耗點數。

常見問題

會不會捏造功能或徽章?
它被明確指示不要這樣做,缺少的資訊一律留下預留位置。徽章只會針對筆記中能確認的東西加上,例如 npm 套件名稱或授權條款,並使用 shields.io 網址;不想要徽章可以關掉。
貼什麼內容效果最好?
套件描述檔(package.json、pyproject.toml 或 Cargo.toml)、--help 的輸出,再加一句說明這個專案是給誰用的。有了真實的旗標名稱和安裝指令,README 才會既整齊又正確。
我的筆記和 Key 會傳到哪裡?
用你的 Key 從這個頁面直接送到你選的 AI 服務商;hysenlabs.com 什麼都不保留。還沒公開的專案,請使用你能接受其條款的服務商和專門為此建立的 Key,用完再把 Key 刪除。

背後的開源專案

本工具是獨立實作,並未打包第三方函式庫。kefranabg/readme-md-generator(MIT)在程式碼層面做的是同一件事——如果你需要在自己的程式裡實作它,從那裡開始,而不是呼叫一個網頁。

kefranabg/readme-md-generator

也常被稱作

  • readme 產生器
  • ai 寫 readme
  • readme.md 範本
  • github readme 產生器
  • 從 package.json 產生 readme