การติดตั้ง
คู่มือนี้จะติดตั้ง codeknit จากซอร์ส เพิ่มลงใน PATH ของคุณ เปิดใช้งานการเติมคำในเชลล์ และตรวจสอบว่าโปรแกรมทำงานได้
ติดตั้งจากซอร์ส
หัวข้อที่มีชื่อว่า “ติดตั้งจากซอร์ส”ข้อกำหนดเบื้องต้น
- Go 1.26 หรือใหกว่า
- คอมไพเลอร์ C codeknit ใช้ CGo ในการสร้าง tree-sitter parsers
ขั้นตอน
git clone https://github.com/awslabs/codeknit.gitcd codeknitmake buildไบนารีจะถูกเขียนไปที่ ./bin/codeknit
ใช้ไบนารีที่สร้างไว้ล่วงหน้าแทน
หัวข้อที่มีชื่อว่า “ใช้ไบนารีที่สร้างไว้ล่วงหน้าแทน”ไบนารีที่สร้างไว้ล่วงหน้าสำหรับ Linux, macOS และ Windows (amd64 และ arm64) มีอยู่ใน หน้ารุ่น ดาวน์โหลดไฟล์เก็บถาวรสำหรับแพลตฟอร์มของคุณ แตกไฟล์ และย้ายไบนารีไปยัง PATH ของคุณ แต่ละรุ่นมีไฟล์ checksums.txt ที่คุณสามารถตรวจสอบการดาวน์โหลดได้
เพิ่ม codeknit ลงใน PATH ของคุณ
หัวข้อที่มีชื่อว่า “เพิ่ม codeknit ลงใน PATH ของคุณ”ข้ามส่วนนี้หากคุณย้ายไบนารีไปยังไดเรกทอรีที่อยู่ใน PATH อยู่แล้ว เช่น /usr/local/bin
แทนที่ /path/to/codeknit ด้วยไดเรกทอรีที่มีไบนารี หากคุณสร้างจากซอร์ส ไดเรกทอรีดังกล่าวคือไดเรกทอรี bin ภายใน repository ที่โคลนมา
เพิ่มบรรทัดสำหรับเชลล์ของคุณลงในไฟล์การกำหนดค่า:
# 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/codeknitรีโหลดเชลล์ของคุณ หรือโหลดไฟล์ที่คุณแก้ไขใหม่:
source ~/.bashrc # bashsource ~/.zshrc # zshสำหรับ fish ให้เปิดเทอร์มินัลใหม่
เปิดใช้งานการเติมคำในเชลล์
หัวข้อที่มีชื่อว่า “เปิดใช้งานการเติมคำในเชลล์”codeknit สร้างสคริปต์การเติมคำสำหรับ bash, zsh, fish และ PowerShell รันคำสั่งสำหรับเชลล์ของคุณครั้งเดียว:
# bashcodeknit completion bash >> ~/.bashrc
# zshcodeknit completion zsh >> ~/.zshrc
# fishcodeknit completion fish > ~/.config/fish/completions/codeknit.fish
# PowerShellcodeknit completion powershell >> $PROFILEคำสั่งสำหรับ bash, zsh และ PowerShell จะเพิ่มไปยังโปรไฟล์ของคุณ การรันคำสั่งซ้ำจะเพิ่มสคริปต์ครั้งที่สอง ดังนั้นให้รันแต่ละคำสั่งเพียงครั้งเดียว
เปิดเชลล์ใหม่ หรือโหลดโปรไฟล์ของคุณใหม่เพื่อเปิดใช้งานการเติมคำ
ตรวจสอบการติดตั้ง
หัวข้อที่มีชื่อว่า “ตรวจสอบการติดตั้ง”codeknit --versionหากคำสั่งแสดงเวอร์ชัน แสดงว่า codeknit ได้รับการติดตั้งแล้ว หากเชลล์ของคุณรายงาน command not found ให้ตรวจสอบว่าไดเรกทอรีในบรรทัด PATH ของคุณมีไบนารี codeknit หรือไม่ จากนั้นรีโหลดเชลล์ของคุณ
ตั้งค่าสภาพแวดล้อมการพัฒนา
หัวข้อที่มีชื่อว่า “ตั้งค่าสภาพแวดล้อมการพัฒนา”ดำเนินการนี้เฉพาะเมื่อคุณวางแผนที่จะมีส่วนร่วมใน codeknit รันคำสั่งเหล่านี้จากรากของ repository ที่โคลนมา:
make deps # ติดตั้ง dependenciesmake setup # กำหนดค่า git hooksmake test # รันชุดทดสอบmake lint จะรัน linter และ formatter
ขั้นตอนถัดไป
หัวข้อที่มีชื่อว่า “ขั้นตอนถัดไป”- รันคำสั่งแรกของคุณใน เริ่มต้นใช้งาน
- ดูรายละเอียดของแฟล็กทั้งหมดใน CLI flags reference