codebase dump 다운로드 - codebase dump 소스 코드 다운로드

codebase dump

AI 소스 코드

v0.6.0

다운로드

readme

이 프로젝트는 코드베이스를 단일 파일 덤프로 분석하고 요약하도록 설계된 가벼운 버전의 Codebase Digest입니다. 생성 된 출력에는 다음이 포함됩니다.

코드 구조 및 내용
코드베이스의 기본 요약

이 출력은 추가 분석 또는 프롬프트 기반 작업을 지원하기 위해 Chatgpt, Google Gemini 및 기타 대형 언어 모델 (LLM)의 입력으로 사용될 수 있습니다.

가능한 프롬프트에 대한 영감은 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 Code 에서이 프로젝트를 열고 가상 환경을 설정하는 것이 좋습니다.

용법

명령 줄

설치되면 명령 줄에서 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` 매개 변수로 정의 된대로 Audits API로 출력을 보내십시오.
`--audit-base-url`	API BASE URL이 감사를 보내기 위해 (기본값 : https://codeaudits.ai/)
`--api-key`	https://codeaudits.ai/에서 제출 된 저장소를 계정에 할당하려는 개인 API 키

예

프로젝트 코드 구조의 마크 다운 파일 생성 :

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

Markdown 파일을 생성하여 감사 앱 Codeaudits.ai로 푸시하십시오.

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

Markdown 파일을 생성하여 감사의 인스턴스 인스턴스로 푸시하십시오.

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

가장 큰 5 개의 가장 큰 파일을 무시하고 마크 다운 파일을 생성하고 app app 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과 함께 온라인으로 시도하십시오

온라인 환경 인 Google Colab에서 Codebase-Dump를 사용해 볼 수 있습니다. 컴퓨터에 파이썬 환경이없는 경우 좋은 옵션이 될 수 있습니다. Codebase-Dump Colab을 시작하십시오. 테스트하려면 런타임을 통해 모든 코드를 실행하십시오 -> 모두 실행하십시오.

GitHub 작업의 사용

GitHub 작업 워크 플로에서 Codebase-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를 사용하여 수동으로 트리거됩니다.
CodeBase-Dump를 설치하고 코드 구조 및 요약을 포함하는 project_dump_for_llm.md라는 .md 파일을 생성합니다.
-audit-upload 플래그는 https://codeaudits.ai/의 Audits API로 출력을 보냅니다.
그런 다음 생성 된 파일은 쉽게 액세스하고 다운로드 할 수 있도록 아티팩트로 업로드됩니다.

다음은?

직접 사용하십시오

코드베이스 덤프를 받으면 LLM 중 하나에 입력 프롬프트로 복사 한 다음 gemini, chatgpt, Claude 및 코드베이스와 관련된 기타 질문을 요청하십시오. 예를 들어, "이 코드를 // 선택 // 아키텍처로 리팩터링하기위한 제안 된 단계는 무엇입니까?"에 대해 묻습니다.

가능한 프롬프트에 대한 영감을 얻으려면 Codebase Digest 저장소의 LLM 프롬프트 섹션을 확인하십시오.