Flatty

Flatty-CodeBase-to-Text untuk LLMS

Ubah repo atau folder github di Mac Anda menjadi file teks sederhana sehingga Anda dapat mengunggahnya ke LLM (Claude, ChatGpt, dll.) Untuk beralasan dari semuanya di jendela konteks.

CodeBase → File Teks

LLMS seperti Chatgpt dan Claude memungkinkan Anda mengunggah file, tetapi mereka membatasi berapa banyak yang dapat Anda unggah sekaligus. Saat Anda berurusan dengan basis kode besar yang memiliki banyak file, Anda tidak bisa hanya mengunggahnya langsung ke LLM. Anda akhirnya harus menggunakan teknik Rag (Retrieval Augmented Generation), yang dalam pengalaman saya tidak seefektif mengunggah semuanya ke dalam jendela konteks penuh - terutama ketika Anda perlu beralasan tentang arsitektur atau memahami seluruh sistem. Lihat contoh.

Asisten pengkodean seperti Cursor adalah Amazeballs, tetapi mereka bekerja lebih baik untuk penyelesaian kode sehari-hari dan edit inline daripada yang mereka lakukan untuk pemahaman sistem tingkat yang lebih tinggi.

Fitur

• Perataan File Komprehensif: Mengubah seluruh basis kode menjadi file teks terstruktur yang cocok untuk LLMS.
• Penanganan File Cerdas: Cerdas melompati file biner, gambar, membangun artefak, direktori paket, file tersembunyi, dan file sistem.
• ****? Penyaringan berbasis pola: Tingkatkan proses perataan Anda dengan secara selektif termasuk file berdasarkan pola kode tertentu atau kata kunci di kedua konten file dan nama file. Kustomisasi kriteria inklusi Anda menggunakan AND / OR kondisi untuk menargetkan apa yang Anda butuhkan untuk analisis terfokus.

Instalasi

Pilih petualangan Anda:

?

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

‍♂️ Pemasangan paranoid (pemeriksaan keamanan ekstra)

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

Instalasi paranoid (default) mencakup verifikasi checksum dan pemeriksaan keamanan penuh. Install cepat melewatkan cek ini untuk kerumunan "Saya suka hidup berbahaya".

Penggunaan

Penggunaan Dasar Sederhana Bodoh:

 cd your-project-directory
flatty

Ini membuat file teks yang diformat dengan baik di ~/Documents/flatty/ berisi semua file teks proyek Anda, siap untuk konsumsi LLM.

Penyaringan berbasis pola

Kendalikan apa yang termasuk dalam output Anda yang rata dengan menentukan pola dan kondisi. Fitur ini memungkinkan Anda untuk fokus pada bagian spesifik basis kode Anda, meningkatkan efisiensi dan relevansi.

Argumen baris perintah:

• --pattern "pattern1" : Tentukan pola atau kata kunci untuk memfilter file. Anda dapat menggunakan beberapa flag --pattern untuk beberapa pola.
• --condition AND|OR : Tentukan bagaimana beberapa pola harus dicocokkan.
  • AND : semua pola yang ditentukan harus ada dalam file (baik dalam nama file atau konten).
  • OR : Salah satu dari pola yang ditentukan harus ada.

Contoh:

1. Sertakan file yang berisi fungsi useEffect atau async function :

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

2. Sertakan file yang berisi async function useEffect dan ASYNC:

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

3. Sertakan file dengan README di nama file:

   flatty --pattern " README " --condition OR

4. Perilaku default tanpa pola (termasuk semua file teks yang memenuhi syarat):

   flatty

Perilaku:

• Atau kondisi: File disertakan jika ada pola yang ditentukan ditemukan di nama file atau konten file.
• Dan kondisi: File disertakan hanya jika semua pola yang ditentukan ditemukan dalam nama file atau konten file.
• Tidak ada pola yang ditentukan: Default untuk memasukkan semua file teks yang memenuhi syarat, mempertahankan perilaku asli.

Penanganan file pintar

Flatty dengan cerdas melompat:

• File dan gambar biner
• Bangun artefak
• Direktori Paket ( node_modules , vendor )
• File tersembunyi dan .git
• File sistem ( .DS_Store )

Keluaran

File teks yang diratakan disimpan di direktori ~/flattened/ dengan nama file diformat sebagai:

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

Setiap file output termasuk:

• Informasi Proyek dan Metadata
• Struktur repositori lengkap dengan direktori dan jumlah token file
• Isi masing -masing file teks yang disertakan, dipisahkan oleh pemisah yang ditentukan

Perkembangan

Dikembangkan dengan ❤️ oleh TalkTastic

Berkontribusi

Kontribusi dipersilakan! Harap buka masalah atau kirimkan permintaan tarik untuk peningkatan atau perbaikan bug.

Git Hooks

Untuk mempertahankan integritas skrip flatty.sh dan memastikan bahwa file checksum ( flatty.sh.sha256 ) selalu terkini, kontributor harus mengatur kait git pra-komit. Kait ini secara otomatis menghasilkan dan memperbarui checksum sebelum setiap komit.

Langkah-langkah untuk mengatur kait pra-komit:

1. Arahkan ke direktori Git Hooks:

    cd .git/hooks

2. Buat atau edit kait pre-commit :

   cursor pre-commit

3. Tambahkan skrip berikut ke file 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

4. Buat hook dapat dieksekusi:

   chmod +x pre-commit

Penjelasan: Kait ini memastikan bahwa setiap kali flatty.sh dimodifikasi dan komit dibuat, file checksum flatty.sh.sha256 yang sesuai secara otomatis diperbarui dan termasuk dalam komit. Ini mempertahankan proses verifikasi integritas untuk skrip instalasi.

Lisensi

Mit