codebase dump

Ридме

Этот проект представляет собой легкую версию Digest Codebase Digest, предназначенную для анализа и суммирования вашей кодовой базы в однолетный дамп. Сгенерированный выход включает в себя:

• Структура и содержимое кода
• Основное резюме кодовой базы

Этот вывод может использоваться в качестве входных данных для моделей крупных языков (LLMS), таких как CHATGPT, Google Gemini и другие для дальнейшего анализа или для поддержки задач на основе быстрого на основе быстрого.

Для вдохновения на возможные подсказки см. В разделе «Подсказки LLM» в репозитории дайджеста кодовой базы.

Как использовать

Установка

Вариант 1: Установите через PIP

Вы можете установить кодовой базой-пакет непосредственно из PYPI:

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	Максимальный допустимый размер содержимого текста в КБ (по умолчанию: 10240 КБ)
--ignore-top-large-files	Количество самых больших файлов для игнорирования (по умолчанию: 0)
--audit-upload	Отправить вывод в API аудитов в соответствии с определением параметра --audit-base-url
--audit-base-url	URL -адрес базы API для отправки аудита (по умолчанию: https://codeaudits.ai/)
--api-key	Ваш личный ключ API для назначения отправленного репозитория в вашу учетную запись на https://codeaudits.ai/

Примеры

Создайте файл разметки структуры кода вашего проекта:

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

---

Сгенерируйте файл разметки и подтолкните его к приложению Audits Codeaudits.ai:

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

---

Сгенерируйте файл разметки и подтолкните его в пользовательский экземпляр Audits:

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

---

Создайте файл разметки, игнорируя 5 самых больших файлов в лучших ведущих и перенапрягайте его в приложение Audits Codeaudits.ai:

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

Из источника

Вы также можете запустить кодовой базой-пакет непосредственно из исходного кода:

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, чтобы создать и сохранить дамп кода в качестве артефакта. Вот пример конфигурации рабочего процесса (рабочий пример, доступный в этом собственном репозитории: .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.
• Он устанавливает кодовой базой и генерирует файл .md с именем project_dump_for_llm.md, содержащий структуру кода и резюме.
• Флаг-Audit-upload отправляет вывод в API аудитов на https://codeaudits.ai/
• Сгенерированный файл затем загружается в качестве артефакта для легкого доступа и загрузки.

Что дальше?

Используйте его самостоятельно

Как только вы получите дамп кодовой базы, скопируйте это в одну из LLMS в качестве подсказки ввода и начните задавать вопросы Gemini, CHATGPT, CLAUDE и другим вопросам, связанным с вашей кодовой базой. Например, спросите о том, «какие предложенные шаги по переработке этого кода в // ваш выбор // архитектура».

Для вдохновения на возможные подсказки проверьте раздел «Подсказки LLM» в репозитории Digest Codebase.

Используйте кодовые аудиты

Парсированная кодовая база также была загружена в приложение https://codeaudits.ai/. Когда вы запускаете ссылку, которая была возвращена вам, вы можете запустить несколько предварительно сконфигурированных аудитов кода, например, намеки на рефакторинг архитектуры, отсутствующие тесты или подсказки для упрощения.