ai digest

AI 다이제스트

Claude 프로젝트 또는 사용자 정의 ChatGPT와 함께 사용할 수 있도록 코드베이스를 단일 Markdown 파일로 집계하는 CLI 도구입니다.

특징

• 지정된 디렉터리 및 하위 디렉터리의 모든 파일을 집계합니다.

• 일반적인 빌드 아티팩트 및 구성 파일을 무시합니다.

• 전체 코드베이스를 포함하는 단일 Markdown 파일을 출력합니다.

• 공백 제거 및 사용자 정의 무시 패턴에 대한 옵션 제공

사용방법

프로젝트 디렉터리에서 CLI 도구를 실행하여 시작하세요.

 npx ai 다이제스트

그러면 코드베이스가 포함된 codebase.md 파일이 생성됩니다.

코드베이스가 포함된 Markdown 파일을 생성한 후에는 코드 분석 및 지원을 위해 ChatGPT 및 Claude와 같은 AI 모델과 함께 사용할 수 있습니다.

ChatGPT 사용:

1. 맞춤 GPT 만들기

2. 생성된 마크다운 파일을 GPT의 지식 베이스에 업로드하세요.

클로드와 함께:

1. 새 프로젝트 만들기

2. 프로젝트 지식에 Markdown 파일 추가

최상의 결과를 얻으려면 새 채팅 세션을 시작하기 전에 Markdown 파일을 다시 업로드하여 AI에 최신 버전의 코드베이스가 있는지 확인하세요.

옵션

• -i, --input : 입력 디렉터리를 지정합니다. (기본값: 현재 디렉터리)

• -o, --output : 출력 파일 지정 (기본값: codebase.md)

• --no-default-ignores : 기본 무시 패턴을 비활성화합니다.

• --whitespace-removal : 공백 제거 활성화

• --show-output-files : 출력에 포함된 파일 목록을 표시합니다.

• --ignore-file : 사용자 정의 무시 파일 지정(기본값: .aidigestignore)

• --help : 도움말 표시

예

1. 기본 사용법:

    npx ai 다이제스트

2. 입력 및 출력을 지정합니다.

    npx ai-digest -i /path/to/your/project -o project_summary.md

3. 공백 제거 활성화:

    npx ai-digest --whitespace-removal

4. 포함된 파일 목록 표시:

    npx ai-digest --show-output-files

5. 여러 옵션 결합:

    npx ai-digest -i /path/to/your/project -o project_summary.md --whitespace-removal --show-output-files

사용자 정의 패턴 무시

ai-digest는 프로젝트 루트 디렉터리에 있는 .aidigestignore 파일을 사용하여 사용자 지정 무시 패턴을 지원합니다. 이 파일은 .gitignore 와 유사하게 작동하므로 집계에서 제외해야 하는 파일과 디렉터리를 지정할 수 있습니다.

--show-output-files 플래그를 사용하여 포함되는 파일을 확인하면 제외할 후보를 더 쉽게 식별할 수 있습니다.

공백 제거

--whitespace-removal 플래그를 사용하면 ai-digest는 파일에서 과도한 공백을 제거하여 AI 모델과 함께 사용할 때 토큰 수를 줄입니다. Python 및 YAML과 같은 공백 종속 언어에서는 이 기능이 비활성화됩니다.

바이너리 및 SVG 파일 처리

바이너리 파일 및 SVG는 해당 파일 유형에 대한 참고 사항과 함께 출력에 포함됩니다. 이를 통해 AI 모델은 전체 콘텐츠를 포함하지 않고도 이러한 파일을 인식할 수 있습니다.

지역개발

npm run start 실행하여 로컬 프로젝트에서 CLI 도구를 실행하세요. (매우 메타!)

테스트를 실행하려면 npm test 실행하세요.

CLI에 플래그를 전달하려면 npm run start -- --whitespace-removal 과 같이 -- 플래그를 사용하세요.

새 버전 배포

npm publish

기여

기여를 환영합니다! 언제든지 Pull Request를 제출해 주세요.

특허

이 프로젝트는 MIT 라이선스에 따라 라이선스가 부여됩니다.