repo-to-text

將儲存庫結構及其內容轉換為單一文字檔案,包含樹狀輸出與 Markdown 程式碼區塊中的檔案內容。

repo-to-text 是什麼?

將儲存庫結構及其內容轉換為單一文字檔案,包含樹狀輸出與 Markdown 程式碼區塊中的檔案內容。這可能有助於與 LLM 討論您的程式碼。

repo-to-text 概覽

這是什麼

repo-to-text 是一個命令列工具,能將目錄的結構與檔案內容轉換成單一格式化文字檔。輸出內容包含目錄樹狀圖以及每個檔案的內容,並以 Markdown 程式碼區塊呈現。此工具專為協助與大型語言模型(LLM)分享程式碼而設計,便於開發與除錯。該工具以 Python 撰寫,並以開放原始碼套件形式發布於 PyPI。

主要功能

  • 產生單一文字檔,包含目錄樹狀圖與儲存庫中所有檔案的內容。
  • 使用類似 XML 的標籤結構化輸出,提升可讀性。
  • 支援透過 .repo-to-text-settings.yaml 設定檔進行自訂,可使用 gitignore 風格的規則忽略特定檔案或目錄。
  • 提供命令列選項,可指定輸出目錄、啟用除錯日誌、輸出至標準輸出,或建立預設設定檔。
  • 可在設定檔中設定最大字數,當內容超過限制時自動分割輸出為多個檔案。
  • 也提供 Docker 容器,方便在容器化環境中使用。

使用情境

  • 將程式碼庫分享給 LLM,以進行程式碼審查、除錯或重構協助。
  • 為儲存庫的結構與內容建立快照,用於文件記錄或歸檔。
  • 準備專案的簡潔文字表示,便於分析或比較。

快速開始

bashpip install repo-to-textcd /path/to/your/repositoryrepo-to-text這會在當前目錄產生一個帶時間戳記的文字檔,並將內容複製到剪貼簿。更多選項請參閱儲存庫的 README。

授權與價格

本專案採用 MIT 授權條款。為開放原始碼且免費使用。

內容整理自該專案公開的 README 與儲存庫資訊。

將此徽章加入你的 README

Featured on YunoDB 徽章樣式與說明

你是這個專案的維護者嗎?展示它已收錄於 YunoDB。

Markdown[![Featured on YunoDB](https://yunodb.com/badge/kirill-markinrepo-to-text.svg)](https://yunodb.com/tools/kirill-markinrepo-to-text?utm_source=github&utm_medium=badge)
HTML<a href="https://yunodb.com/tools/kirill-markinrepo-to-text?utm_source=github&utm_medium=badge"><img src="https://yunodb.com/badge/kirill-markinrepo-to-text.svg" alt="Featured on YunoDB" height="20"></a>