Bỏ qua để đến nội dung

Cài đặt

Hướng dẫn này cài đặt codeknit từ nguồn, thêm nó vào PATH, kích hoạt tính năng hoàn thiện shell và kiểm tra xem nó có chạy được không.

Điều kiện tiên quyết

  • Go 1.26 hoặc mới hơn
  • Trình biên dịch C. codeknit sử dụng CGo để xây dựng các trình phân tích cú pháp tree-sitter.

Các bước

Terminal window
git clone https://github.com/awslabs/codeknit.git
cd codeknit
make build

Tệp nhị phân được ghi vào ./bin/codeknit.

Sử dụng tệp nhị phân dựng sẵn thay thế

Phần tiêu đề “Sử dụng tệp nhị phân dựng sẵn thay thế”

Các tệp nhị phân dựng sẵn cho Linux, macOS và Windows (amd64 và arm64) có trên trang releases. Tải xuống kho lưu trữ cho nền tảng của bạn, giải nén và di chuyển tệp nhị phân vào PATH. Mỗi bản phát hành bao gồm tệp checksums.txt để bạn có thể xác minh tệp tải xuống.

Bỏ qua phần này nếu bạn đã di chuyển tệp nhị phân vào thư mục đã có trong PATH, chẳng hạn như /usr/local/bin.

Thay thế /path/to/codeknit bằng thư mục chứa tệp nhị phân. Nếu bạn xây dựng từ nguồn, đó là thư mục bin bên trong kho lưu trữ đã nhân bản.

Thêm dòng cho shell của bạn vào tệp cấu hình của nó:

Terminal window
# 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

Tải lại shell hoặc nguồn tệp bạn đã chỉnh sửa:

Terminal window
source ~/.bashrc # bash
source ~/.zshrc # zsh

Đối với fish, hãy mở một terminal mới.

codeknit tạo các tập lệnh hoàn thiện cho bash, zsh, fish và PowerShell. Chạy lệnh cho shell của bạn một lần:

Terminal window
# bash
codeknit completion bash >> ~/.bashrc
# zsh
codeknit completion zsh >> ~/.zshrc
# fish
codeknit completion fish > ~/.config/fish/completions/codeknit.fish
# PowerShell
codeknit completion powershell >> $PROFILE

Các lệnh bash, zsh và PowerShell sẽ thêm vào tệp cấu hình của bạn. Chạy lại chúng sẽ thêm tập lệnh lần thứ hai, vì vậy chỉ chạy mỗi lệnh một lần.

Mở một shell mới hoặc nguồn tệp cấu hình của bạn để kích hoạt tính năng hoàn thiện.

Terminal window
codeknit --version

Nếu lệnh in ra một phiên bản, codeknit đã được cài đặt. Nếu shell báo command not found, hãy kiểm tra xem thư mục trong dòng PATH của bạn có chứa tệp nhị phân codeknit không, sau đó tải lại shell.

Chỉ thực hiện việc này nếu bạn dự định đóng góp cho codeknit. Chạy các lệnh này từ thư mục gốc của kho lưu trữ đã nhân bản:

Terminal window
make deps # cài đặt các phụ thuộc
make setup # cấu hình git hooks
make test # chạy bộ kiểm tra

make lint chạy trình kiểm tra và định dạng.