Erste Schritte

Erste Schritte

codeknit in unter 5 Minuten in Betrieb nehmen.

1. Voraussetzungen

Sie benötigen:

• Go 1.26+
• Einen C-Compiler (CGo ist für tree-sitter erforderlich)

2. Installation aus dem Quellcode

git clone https://github.com/awslabs/codeknit.git
cd codeknit
make build
# Binary befindet sich unter ./bin/codeknit

3. Zum PATH hinzufügen

Fügen Sie das Binary zur PATH-Umgebungsvariable Ihrer Shell hinzu:

# bash (~/.bashrc)
export PATH="$PATH:$(pwd)/bin"

# zsh (~/.zshrc)
export PATH="$PATH:$(pwd)/bin"

# fish (~/.config/fish/config.fish)
fish_add_path $(pwd)/bin

Laden Sie Ihre Shell neu oder führen Sie source ~/.bashrc (oder ~/.zshrc) aus, damit die Änderung wirksam wird.

4. Installation überprüfen

Stellen Sie sicher, dass codeknit funktioniert:

codeknit --version

5. Ersten Parse-Vorgang durchführen

Führen Sie Ihren ersten Parse-Vorgang für ein Code-Repository durch:

codeknit parse ./myproject

Dieser Befehl:

• Parst alle Quelldateien in ./myproject
• Extrahiert strukturelle Informationen (Funktionen, Klassen, Beziehungen)
• Schreibt chunkierte .skt-Dateien in ./skeleton/ (Standard-Ausgabeverzeichnis)

Wenn Sie diesen Befehl erneut ausführen, verwenden Sie --clean, um vorherige Ausgaben zu entfernen:

codeknit parse ./myproject --clean

6. Die Ausgabe lesen

Die .skt-Dateien enthalten strukturierte Code-Informationen. Hier ein kleines Beispiel:

[symbols]
## src/main.go
S1 module/package L1-L1 main {}
S2 type/struct L5-L8 Server {exported}
S3 callable/function L10-L12 NewServer(addr: string) -> *S2 {exported}
S4 callable/method L14-L19 Start() {receiver=*Server}

[edges]
S2 --contains--> S4
S3 --returns--> S2

Wichtige Abschnitte:

• [symbols]: Definitionen, gruppiert nach Datei, mit Name, Zeilenbereich und Metadaten
• [edges]: Beziehungen wie contains, calls, inherits oder returns

7. Nächste Schritte

Nachdem Sie Ihren ersten Parse-Vorgang durchgeführt haben:

• Erfahren Sie mehr über den Parse-Befehl: Parse-Befehlsleitfaden
• Erkunden Sie die strukturelle Analyse: Graph-Befehlsleitfaden
• Verstehen Sie die Duplikaterkennung: Fingerprint-Befehlsleitfaden
• Lesen Sie das vollständige Ausgabeformat: Ausgabeformat-Referenz
• Sehen Sie sich alle verfügbaren Flags an: CLI-Flags-Referenz