ai digest

intisari ai

Alat CLI untuk menggabungkan basis kode Anda ke dalam satu file Penurunan Harga untuk digunakan dengan Proyek Claude atau ChatGPT khusus.

Fitur

• Mengumpulkan semua file di direktori dan subdirektori tertentu

• Mengabaikan artefak build umum dan file konfigurasi

• Menghasilkan satu file Markdown yang berisi seluruh basis kode

• Memberikan opsi untuk penghapusan spasi dan pola pengabaian khusus

Cara Menggunakan

Mulailah dengan menjalankan alat CLI di direktori proyek Anda:

 npx ai-cernaan

Ini akan menghasilkan file codebase.md dengan basis kode Anda.

Setelah Anda membuat file Markdown yang berisi basis kode, Anda dapat menggunakannya dengan model AI seperti ChatGPT dan Claude untuk analisis dan bantuan kode.

Dengan ObrolanGPT:

1. Buat GPT Khusus

2. Unggah file Markdown yang dihasilkan ke basis pengetahuan GPT

Dengan Claude:

1. Buat Proyek baru

2. Tambahkan file Markdown ke pengetahuan Proyek

Untuk hasil terbaik, unggah ulang file Markdown sebelum memulai sesi obrolan baru untuk memastikan AI memiliki versi basis kode Anda yang terbaru.

Pilihan

• -i, --input : Tentukan direktori input (default: direktori saat ini)

• -o, --output : Tentukan file keluaran (default: codebase.md)

• --no-default-ignores : Menonaktifkan pola pengabaian default

• --whitespace-removal : Mengaktifkan penghapusan spasi

• --show-output-files : Menampilkan daftar file yang disertakan dalam output

• --ignore-file : Tentukan file abaikan khusus (default: .aidigestignore)

• --help : Tampilkan bantuan

Contoh

1. Penggunaan dasar:

    npx ai-cernaan

2. Tentukan masukan dan keluaran:

    npx ai-digest -i /path/ke/proyek/Anda -o project_summary.md

3. Aktifkan penghapusan spasi:

    npx ai-digest --penghapusan spasi putih

4. Tampilkan daftar file yang disertakan:

    npx ai-digest --tampilkan-file keluaran

5. Gabungkan beberapa opsi:

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

Pola Abaikan Kustom

ai-digest mendukung pola pengabaian khusus menggunakan file .aidigestignore di direktori root proyek Anda. File ini berfungsi mirip dengan .gitignore , memungkinkan Anda menentukan file dan direktori yang harus dikecualikan dari agregasi.

Gunakan tanda --show-output-files untuk melihat file mana yang disertakan, sehingga memudahkan untuk mengidentifikasi kandidat yang akan dikecualikan.

Penghapusan Spasi Putih

Saat menggunakan tanda --whitespace-removal , ai-digest menghapus kelebihan spasi dari file untuk mengurangi jumlah token saat digunakan dengan model AI. Fitur ini dinonaktifkan untuk bahasa yang bergantung pada spasi seperti Python dan YAML.

Penanganan File Biner dan SVG

File biner dan SVG disertakan dalam output dengan catatan tentang jenis filenya. Hal ini memungkinkan model AI untuk mengetahui file-file ini tanpa menyertakan konten lengkapnya.

Pembangunan Lokal

Jalankan npm run start untuk menjalankan alat CLI pada proyek lokal. (Sangat meta!)

Jalankan npm test untuk menjalankan tes.

Untuk meneruskan tanda ke CLI, gunakan tanda -- seperti ini: npm run start -- --whitespace-removal .

Terapkan Versi Baru

npm publish

Berkontribusi

Kontribusi dipersilakan! Silakan kirimkan Permintaan Tarik.

Lisensi

Proyek ini dilisensikan di bawah Lisensi MIT.