Flatty Download- Flatty 소스 코드 다운로드

Flatty

AI 소스 코드

v1.0... official?

다운로드

Flatty- LLMS 용 Codebase-to-Text

Mac의 GitHub Repo 또는 폴더를 간단한 텍스트 파일로 변환하여 LLM (Claude, Chatgpt 등)에 업로드하여 컨텍스트 창에서 모든 것을 추론 할 수 있습니다.

Codebase → 텍스트 파일

Chatgpt 및 Claude와 같은 LLM을 사용하면 파일을 업로드 할 수 있지만 한 번에 업로드 할 수있는 수를 제한합니다. 수많은 파일이있는 대형 코드베이스를 처리 할 때 LLM에 직접 업로드 할 수는 없습니다. 결국 Rag (검색 증강 세대) 기술을 사용해야합니다. 제 경험상 전체 컨텍스트 창에 모든 것을 업로드하는 것만 큼 효과적이지는 않습니다. 특히 아키텍처에 대해 추론하거나 전체 시스템을 이해해야 할 때. 예를 참조하십시오.

Cursor와 같은 코딩 어시스턴트는 Amazeballs이지만 더 높은 수준의 시스템 이해보다 일상적인 코드 완료 및 인라인 편집에 더 잘 작동합니다.

특징

포괄적 인 파일 아파트 : 전체 코드베이스를 LLM에 적합한 구조화 된 텍스트 파일로 변환합니다.
스마트 파일 처리 : 지능적으로 이진 파일, 이미지, 빌드 아티팩트, 패키지 디렉토리, 숨겨진 파일 및 시스템 파일을 건너 뜁니다.
****? 패턴 기반 필터링 : 파일 컨텐츠 및 파일 이름 모두에 특정 코드 패턴 또는 키워드를 기반으로 파일을 선택적으로 포함하여 평평한 프로세스를 향상시킵니다. 집중 분석에 필요한 것을 정확하게 타겟팅하기 위해 포함 기준 AND / OR 조건을 사용하여 포함 기준을 사용자 정의하십시오.

설치

모험 선택 :

? (♂️ Quick Install (Easy Mode)

curl -fsSL https://raw.githubusercontent.com/mattmireles/flatty/main/install_flatty.sh | bash -s -- --quick

‍ 대추 편집증 설치 (추가 보안 점검)

curl -fsSL https://raw.githubusercontent.com/mattmireles/flatty/main/install_flatty.sh | bash

편집증 설치 (기본값)에는 체크섬 검증 및 전체 보안 검사가 포함됩니다. 빠른 설치는 "위험하게 살기를 좋아합니다"군중에 대한 이러한 검사를 건너 뜁니다.

용법

기본 사용량은 어리석게 간단합니다.

 cd your-project-directory
flatty

이렇게하면 ~/Documents/flatty/ llm 소비에 대한 준비가 된 모든 프로젝트의 텍스트 파일을 포함하여 멋지게 형식화 된 텍스트 파일을 만듭니다.

패턴 기반 필터링

패턴과 조건을 지정하여 평평한 출력에 포함 된 내용을 제어하십시오. 이 기능을 사용하면 코드베이스의 특정 부분에 집중하여 효율성과 관련성을 향상시킬 수 있습니다.

명령 라인 인수 :

--pattern "pattern1" : 파일을 필터로 패턴 또는 키워드를 지정합니다. 여러 패턴에 여러 개의 --pattern 플래그를 사용할 수 있습니다.
--condition AND|OR : 여러 패턴이 일치하는 방법을 정의합니다.
- AND : 모든 지정된 패턴은 파일 (파일 이름 또는 컨텐츠)에 있어야합니다.
- OR : 지정된 패턴 중 하나가 있어야합니다.

예 :

useEffect 또는 async function 포함하는 파일 포함 :

flatty --pattern " useEffect " --pattern " async function " --condition OR

useEffect 및 async function 모두 포함하는 파일 포함 :

flatty --pattern " useEffect " --pattern " async function " --condition AND

파일 이름에 README 있는 파일 포함 :

flatty --pattern " README " --condition OR

패턴이없는 기본 동작 (모든 적격 텍스트 파일 포함) :
```
flatty
```

행동:

또는 조건 : 파일이 파일 이름 또는 파일 컨텐츠에 지정된 패턴 중 하나라도 포함 된 경우 파일이 포함됩니다.
및 조건 : 파일은 모든 지정된 패턴이 파일 이름 또는 파일 컨텐츠에있는 경우에만 포함됩니다.
지정된 패턴 없음 : 모든 적격 텍스트 파일을 포함하고 원래 동작을 유지하는 기본값.

스마트 파일 처리

지능적으로 건너 뛰기 :

이진 파일 및 이미지
유물을 구축하십시오
패키지 디렉토리 ( node_modules , vendor )
숨겨진 파일과 .git
시스템 파일 ( .DS_Store )

산출

평평한 텍스트 파일은 ~/flattened/ directory에 저장됩니다.

 <project-name>-v<version>-<timestamp>.txt

각 출력 파일에는 다음이 포함됩니다.

프로젝트 정보 및 메타 데이터
디렉토리 및 파일 토큰 수를 갖춘 완전한 저장소 구조
정의 된 분리기로 분리 된 각 포함 된 텍스트 파일의 내용

개발

TalkTastic에 의해 ❤️로 개발되었습니다

기여

기부금을 환영합니다! 개선 또는 버그 수정에 대한 문제를 열거 나 풀 요청을 제출하십시오.

git 후크

flatty.sh 스크립트의 무결성을 유지하고 체크섬 파일 ( flatty.sh.sha256 )이 항상 최신 상태인지 확인하려면 기고자는 사전 커밋 GIT 후크를 설정해야합니다. 이 후크는 각 커밋 전에 체크섬을 자동으로 생성하고 업데이트합니다.

사전 커밋 후크를 설정하는 단계 :

Git Hooks 디렉토리로 이동하십시오.
```
 cd .git/hooks
```
pre-commit 후크를 만들거나 편집하십시오.
```
cursor pre-commit
```

pre-commit 파일에 다음 스크립트를 추가하십시오.

 #! /bin/bash

# Generate SHA256 checksum for flatty.sh
sha256sum flatty.sh > flatty.sh.sha256

# Add the checksum file to the commit
git add flatty.sh.sha256