codebase dump

讀書我

該項目是Codebase Digest的輕量級版本，旨在分析和總結您的代碼庫中的單文件轉儲。生成的輸出包括：

• 代碼結構和內容
• 代碼庫的基本摘要

該輸出可以用作大型語言模型（LLM）等大型語言模型的輸入，例如Chatgpt，Google Gemini和其他人進行進一步分析或支持及時的任務。

有關可能提示的靈感，請參閱Codebase Digest存儲庫中的LLM提示部分。

如何使用

安裝

選項1：通過PIP安裝

您可以直接從PYPI安裝Codebase-Dump：

pip install codebase-dump

選項2：通過克隆存儲庫來安裝

克隆設置存儲庫

git clone https://github.com/your-username/codebase-dump.git
cd codebase-dump
pip install -r requirements.txt

我建議在Visual Studio代碼中打開此項目並設置虛擬環境。

用法

命令行

安裝後，您可以從命令行運行Codebase-dump：

codebase-dump < path_to_codebase > -f < output_filename > -o < output_format >

可用的參數

選項	描述
path_to_directory	要分析目錄的路徑
-o, --output-format	輸出格式（文本，降價）。默認值：文字
-f, --file	輸出文件名
--max-size	kb中的最大文本內容大小（默認：10240 kb）
--ignore-top-large-files	要忽略的最大文件數量（默認值：0）
--audit-upload	將輸出發送到由--audit-base-url參數定義的審核API
--audit-base-url	API基本URL將審核發送到（默認：https：//codeaudits.ai/）
--api-key	您的私有API密鑰將提交的存儲庫分配到您的帳戶上

例子

生成項目代碼結構的降價文件：

codebase-dump . -f project_dump_for_llm.md -o markdown

---

生成降價文件，然後將其推到審核應用程序codeaudits.ai：

codebase-dump . -o markdown --audit-upload

---

生成一個降價文件，然後將其推到審核應用的自定義實例：

codebase-dump . -o markdown --audit-upload --audit-base-url https://your-audit-instance.com/

---

在忽略最大的5個最大文件時生成降價文件，然後將其推到審核應用程序codeaudits.ai：

codebase-dump . -o markdown --audit-upload --ignore-top-large-files=5

來自來源

您還可以直接從源代碼運行Codebase-dump：

pip install -e .
python src/codebase_dump/app.py < path_to_codebase > -f < output_filename > -o < output_format >

與Google Colab在線嘗試

您可以在在線環境中嘗試使用Codebase-Dump，Google Colab。如果您的計算機上沒有Python環境，則可以是一個不錯的選擇。只需在此處啟動：Codebase-Dump Colab。要測試它，請通過運行時運行所有代碼 - >運行全部。

在github動作中使用

您可以在github操作工作流中自動化代碼庫 - dump，以生成並將代碼轉儲保存為工件。這是一個示例工作流程配置（該自身存儲庫中可用的工作示例：.github/workflows/codebase_dump.yml）。

 name : Generate Project Dump for LLM

on :
  workflow_dispatch :

jobs :
  generate-file :
    runs-on : ubuntu-latest

    steps :
      - name : Checkout code
        uses : actions/checkout@v4

      - name : Set up Python
        uses : actions/setup-python@v3
        with :
          python-version : " 3.10 "

      - name : Install codebase-dump
        run : pip install codebase-dump

      - name : Generate Single-File Prompt for LLM
        run : codebase-dump . -f project_dump_for_llm.md -o markdown --audit-upload

      - name : Upload Prompt File as Artifact
        uses : actions/upload-artifact@v3
        with :
          name : project_dump_for_llm.md
          path : project_dump_for_llm.md

在此示例中：

• 使用Workflow_disPatch手動觸發工作流程。
• 它安裝了代碼庫 - dump並生成一個名為project_dump_for_llm.md的.md文件，其中包含代碼結構和摘要。
• -audit-upload標誌將輸出發送到https://codeaudits.ai/上的審核API
• 然後將生成的文件作為工件上傳，以便於訪問和下載。

接下來是什麼？

獨自使用

獲得代碼庫轉儲後，將其複製到LLM的一個提示符中，然後開始詢問Gemini，Chatgpt，Claude和其他與您的代碼庫有關的問題。例如，詢問“將此代碼重構為//您選擇//架構進行的建議步驟。”。

有關可能提示的靈感，請在Codebase Digest存儲庫中查看LLM提示部分。

使用代碼審核

解析的代碼庫也已上傳到https://codeaudits.ai/應用程序。當您啟動返回給您的鏈接時，您可以運行一些預配置的代碼審核，例如架構重構提示，缺少測試或簡化提示。