Instalasi
Panduan ini menginstal codeknit dari sumber, menambahkannya ke PATH, mengaktifkan penyelesaian shell, dan memeriksa apakah aplikasi berjalan.
Instal dari sumber
Section titled “Instal dari sumber”Prasyarat
- Go 1.26 atau lebih baru
- Kompiler C. codeknit menggunakan CGo untuk membangun parser tree-sitter.
Langkah-langkah
git clone https://github.com/awslabs/codeknit.gitcd codeknitmake buildBiner akan disimpan di ./bin/codeknit.
Gunakan biner pra-bangun sebagai gantinya
Section titled “Gunakan biner pra-bangun sebagai gantinya”Biner pra-bangun untuk Linux, macOS, dan Windows (amd64 dan arm64) tersedia di halaman rilis. Unduh arsip untuk platform Anda, ekstrak, dan pindahkan biner ke PATH. Setiap rilis menyertakan file checksums.txt yang dapat Anda gunakan untuk memverifikasi unduhan.
Tambahkan codeknit ke PATH
Section titled “Tambahkan codeknit ke PATH”Lewati bagian ini jika Anda telah memindahkan biner ke direktori yang sudah ada di PATH, seperti /usr/local/bin.
Ganti /path/to/codeknit dengan direktori yang berisi biner. Jika Anda membangun dari sumber, direktori tersebut adalah bin di dalam repositori yang telah dikloning.
Tambahkan baris berikut untuk shell Anda ke file konfigurasi:
# bash (~/.bashrc)export PATH="$PATH:/path/to/codeknit"
# zsh (~/.zshrc)export PATH="$PATH:/path/to/codeknit"
# fish (~/.config/fish/config.fish)fish_add_path /path/to/codeknitMuat ulang shell, atau muat ulang file yang telah diedit:
source ~/.bashrc # bashsource ~/.zshrc # zshUntuk fish, buka terminal baru.
Aktifkan penyelesaian shell
Section titled “Aktifkan penyelesaian shell”codeknit menghasilkan skrip penyelesaian untuk bash, zsh, fish, dan PowerShell. Jalankan perintah untuk shell Anda sekali:
# bashcodeknit completion bash >> ~/.bashrc
# zshcodeknit completion zsh >> ~/.zshrc
# fishcodeknit completion fish > ~/.config/fish/completions/codeknit.fish
# PowerShellcodeknit completion powershell >> $PROFILEPerintah untuk bash, zsh, dan PowerShell menambahkan skrip ke profil Anda. Menjalankannya lagi akan menambahkan skrip untuk kedua kalinya, jadi jalankan masing-masing hanya sekali.
Buka shell baru, atau muat ulang profil Anda, untuk mengaktifkan penyelesaian.
Verifikasi instalasi
Section titled “Verifikasi instalasi”codeknit --versionJika perintah menampilkan versi, codeknit telah terinstal. Jika shell melaporkan command not found, periksa apakah direktori dalam baris PATH Anda berisi biner codeknit, lalu muat ulang shell.
Siapkan lingkungan pengembangan
Section titled “Siapkan lingkungan pengembangan”Lakukan ini hanya jika Anda berencana untuk berkontribusi pada codeknit. Jalankan perintah berikut dari root repositori yang telah dikloning:
make deps # instal dependensimake setup # konfigurasi git hooksmake test # jalankan rangkaian pengujianmake lint menjalankan linter dan formatter.
Langkah selanjutnya
Section titled “Langkah selanjutnya”- Jalankan perintah pertama Anda di Memulai.
- Jelajahi setiap flag di referensi flag CLI.