Menggunakan dengan Asisten AI
codeknit dilengkapi dengan skill siap pakai yang mengajarkan asisten pengodean AI cara menggunakannya secara efektif. Skill ini memungkinkan asisten untuk mengekstrak struktur kode, mendeteksi duplikat, dan melakukan analisis struktural tanpa perlu prompting manual.
Gambaran skill
Section titled “Gambaran skill”codeknit menyediakan dua skill:
codeknit-parse: Mengajarkan asisten untuk mengekstrak struktur kode (fungsi, kelas, metode, variabel) dan hubungan (panggilan, pewarisan, penampungan) ke dalam file.skt.codeknit-fingerprint: Mengajarkan asisten untuk mendeteksi kode duplikat dan hampir duplikat menggunakan fuzzy hashing.
Setiap skill mencakup dokumentasi yang dibaca oleh asisten sesuai kebutuhan untuk memahami penggunaan, flag, format keluaran, dan alur kerja.
Instalasi
Section titled “Instalasi”Gunakan helper installer untuk menyalin direktori skill ke folder skill asisten Anda. Installer hanya mengunduh file skill yang sudah dibundel, sehingga Anda tidak perlu mengkloning repositori.
Instal untuk Codex, Kiro, dan Claude Code:
curl -fsSL https://raw.githubusercontent.com/awslabs/codeknit/main/scripts/install-skills.sh | bashInstal untuk satu asisten:
curl -fsSL https://raw.githubusercontent.com/awslabs/codeknit/main/scripts/install-skills.sh | bash -s -- --assistant codexcurl -fsSL https://raw.githubusercontent.com/awslabs/codeknit/main/scripts/install-skills.sh | bash -s -- --assistant kirocurl -fsSL https://raw.githubusercontent.com/awslabs/codeknit/main/scripts/install-skills.sh | bash -s -- --assistant claudeDari checkout lokal, Anda dapat menggunakan helper Makefile:
make skills-install-dry-runmake skills-installInstaller melewati direktori skill yang sudah ada secara default. Untuk menggantinya, tambahkan --force:
curl -fsSL https://raw.githubusercontent.com/awslabs/codeknit/main/scripts/install-skills.sh | bash -s -- --assistant all --forceSetelah instalasi, asisten secara otomatis mengetahui cara menjalankan perintah codeknit, memilih flag yang sesuai, dan menginterpretasikan keluaran .skt.
Apa yang diajarkan oleh setiap skill
Section titled “Apa yang diajarkan oleh setiap skill”codeknit-parse
Section titled “codeknit-parse”Skill codeknit-parse mengajarkan asisten untuk:
- Menjalankan
codeknit parsedengan flag yang sesuai untuk berbagai skenario - Memilih mode keluaran yang tepat:
directory-flat(default) untuk sebagian besar proyekinlineuntuk file tunggal atau input kecildirectory-treeuntuk mencerminkan struktur sumber
- Membaca dan menginterpretasikan file keluaran
.skt, termasuk bagian[symbols],[edges], dan bagian opsional[dict] - Menggunakan data struktural untuk refactoring, pemetaan dependensi, dan tinjauan kode
- Menjalankan
codeknit graph analyzeuntuk wawasan kualitas kode yang lebih mendalam (dependensi siklik, simbol hub, god class, dll.)
codeknit-fingerprint
Section titled “codeknit-fingerprint”Skill codeknit-fingerprint mengajarkan asisten untuk:
- Menggunakan
codeknit fingerprintuntuk deteksi duplikat, audit DRY, dan identifikasi refactor - Memilih rentang kemiripan yang sesuai (
--min-similarity,--max-similarity) - Membaca bagian
[duplicates]untuk mengidentifikasi kode hampir duplikat - Memahami bahwa fingerprint mengukur bentuk struktural, bukan maksud semantik
- Menggunakan
--rerankdengan embeddings Ollama untuk mengurangi false positive jika diperlukan
Contoh alur kerja
Section titled “Contoh alur kerja”Analisis struktural
Section titled “Analisis struktural”- Minta asisten untuk menganalisis struktur basis kode Anda
- Asisten menjalankan
codeknit parse ./srcdan membaca file.sktyang dihasilkan - Asisten menjawab pertanyaan struktural: dependensi, rantai panggilan, dead code
- Untuk wawasan yang lebih mendalam, asisten menjalankan
codeknit graph analyze ./srcdan menginterpretasikan laporan
[symbols]## src/service.goS1 type/struct L5-L8 AuthService {}S2 callable/method L10-L15 Authenticate(token: string) {receiver=*AuthService}
[edges]S1 --contains--> S2Deteksi duplikat
Section titled “Deteksi duplikat”- Minta asisten untuk menemukan kode yang diduplikasi
- Asisten menjalankan
codeknit fingerprint ./src - Asisten membaca bagian
[duplicates]dalam keluaran - Asisten menyelidiki pasangan yang ditandai dan mengusulkan konsolidasi
[duplicates]S1, S2: 87% similarityS3, S4: 76% similarity- Selalu baca file
.skt, bukan sumber mentah, untuk pertanyaan struktural — file tersebut berisi struktur yang diekstrak dalam format yang ringkas dan dapat diandalkan - Gunakan
codeknit graph analyzeuntuk mengungkap masalah kualitas kode seperti dependensi siklik, simbol hub, dan rantai pewarisan yang dalam - Jalankan
codeknit fingerprintsebelum refactor besar untuk mengidentifikasi kode yang disalin-tempel yang harus dikonsolidasikan - Format
.sktdirancang untuk efisien dalam penggunaan token, menjadikannya ideal untuk jendela konteks LLM - Gunakan
--minifyuntuk lebih mengurangi penggunaan token saat memproses basis kode besar