Zum Inhalt springen

Installation

Diese Anleitung installiert codeknit aus dem Quellcode, fügt es zu Ihrem PATH hinzu, aktiviert Shell-Vervollständigungen und überprüft, ob es läuft.

Voraussetzungen

  • Go 1.26 oder höher
  • Ein C-Compiler. codeknit verwendet CGo, um seine tree-sitter-Parser zu bauen.

Schritte

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

Das Binary wird nach ./bin/codeknit geschrieben.

Vorgefertigte Binaries für Linux, macOS und Windows (amd64 und arm64) finden Sie auf der Releases-Seite. Laden Sie das Archiv für Ihre Plattform herunter, entpacken Sie es und verschieben Sie das Binary in Ihren PATH. Jedes Release enthält eine checksums.txt-Datei, mit der Sie den Download überprüfen können.

Überspringen Sie diesen Abschnitt, wenn Sie das Binary in ein Verzeichnis verschoben haben, das bereits in Ihrem PATH enthalten ist, z. B. /usr/local/bin.

Ersetzen Sie /path/to/codeknit durch das Verzeichnis, das das Binary enthält. Wenn Sie aus dem Quellcode gebaut haben, ist dies das bin-Verzeichnis innerhalb des geklonten Repositorys.

Fügen Sie die Zeile für Ihre Shell zu ihrer Konfigurationsdatei hinzu:

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

Laden Sie Ihre Shell neu oder führen Sie die Datei aus, die Sie bearbeitet haben:

Terminal-Fenster
source ~/.bashrc # bash
source ~/.zshrc # zsh

Für fish öffnen Sie ein neues Terminal.

codeknit generiert Vervollständigungsskripte für bash, zsh, fish und PowerShell. Führen Sie den Befehl für Ihre Shell einmal aus:

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

Die Befehle für bash, zsh und PowerShell hängen an Ihr Profil an. Wenn Sie sie erneut ausführen, wird das Skript ein zweites Mal hinzugefügt, daher führen Sie jeden Befehl nur einmal aus.

Öffnen Sie eine neue Shell oder laden Sie Ihr Profil, um die Vervollständigungen zu aktivieren.

Terminal-Fenster
codeknit --version

Wenn der Befehl eine Version ausgibt, ist codeknit installiert. Wenn Ihre Shell command not found meldet, überprüfen Sie, ob das Verzeichnis in Ihrer PATH-Zeile das codeknit-Binary enthält, und laden Sie dann Ihre Shell neu.

Führen Sie dies nur aus, wenn Sie zu codeknit beitragen möchten. Führen Sie diese Befehle vom Stammverzeichnis des geklonten Repositorys aus:

Terminal-Fenster
make deps # Abhängigkeiten installieren
make setup # Git-Hooks konfigurieren
make test # Testsuite ausführen

make lint führt den Linter und Formatter aus.