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.
Aus dem Quellcode installieren
Abschnitt betitelt „Aus dem Quellcode installieren“Voraussetzungen
- Go 1.26 oder höher
- Ein C-Compiler. codeknit verwendet CGo, um seine tree-sitter-Parser zu bauen.
Schritte
git clone https://github.com/awslabs/codeknit.gitcd codeknitmake buildDas Binary wird nach ./bin/codeknit geschrieben.
Stattdessen ein vorgefertigtes Binary verwenden
Abschnitt betitelt „Stattdessen ein vorgefertigtes Binary verwenden“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.
codeknit zu Ihrem PATH hinzufügen
Abschnitt betitelt „codeknit zu Ihrem PATH hinzufügen“Ü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:
# 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/codeknitLaden Sie Ihre Shell neu oder führen Sie die Datei aus, die Sie bearbeitet haben:
source ~/.bashrc # bashsource ~/.zshrc # zshFür fish öffnen Sie ein neues Terminal.
Shell-Vervollständigungen aktivieren
Abschnitt betitelt „Shell-Vervollständigungen aktivieren“codeknit generiert Vervollständigungsskripte für bash, zsh, fish und PowerShell. Führen Sie den Befehl für Ihre Shell einmal aus:
# bashcodeknit completion bash >> ~/.bashrc
# zshcodeknit completion zsh >> ~/.zshrc
# fishcodeknit completion fish > ~/.config/fish/completions/codeknit.fish
# PowerShellcodeknit completion powershell >> $PROFILEDie 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.
Installation überprüfen
Abschnitt betitelt „Installation überprüfen“codeknit --versionWenn 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.
Entwicklungsumgebung einrichten
Abschnitt betitelt „Entwicklungsumgebung einrichten“Führen Sie dies nur aus, wenn Sie zu codeknit beitragen möchten. Führen Sie diese Befehle vom Stammverzeichnis des geklonten Repositorys aus:
make deps # Abhängigkeiten installierenmake setup # Git-Hooks konfigurierenmake test # Testsuite ausführenmake lint führt den Linter und Formatter aus.
Nächste Schritte
Abschnitt betitelt „Nächste Schritte“- Führen Sie Ihren ersten Befehl in Erste Schritte aus.
- Durchsuchen Sie alle Flags im CLI-Flags-Referenz.