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/应用程序。当您启动返回给您的链接时，您可以运行一些预配置的代码审核，例如架构重构提示，缺少测试或简化提示。