Guidedog bauen und installieren¶
Unter macOS mit Homebrew installieren¶
Verwenden Sie auf Macs mit Apple Silicon oder Intel den offiziellen Tap insanai/homebrew-guidedog:
brew tap insanai/guidedog
brew install insanai/guidedog/guidedog
guidedog --version
Homebrew wählt das Release-Archiv für Ihren Prozessor und prüft dessen SHA-256. Das Paket enthält Typst, Graphviz und tree-sitter. Für HTML und PDF brauchen Sie weder einen Odin-Compiler noch eine Python-Umgebung oder eine separate Typst-Installation. Das Release setzt macOS 12 oder neuer voraus.
Erstellen Sie Ihr erstes Projekt mit Das erste Projekt. So aktualisieren Sie eine installierte Version:
brew update
brew upgrade insanai/guidedog/guidedog
Prüfen Sie das installierte Paket mit brew test insanai/guidedog/guidedog. Der Test erstellt ein Projekt und erzeugt HTML und PDF.
Aus dem Quellcode bauen¶
Verwenden Sie die in tools/odin-release.txt festgelegte Odin-Werkzeugkette. Das Release nutzt Odin dev-2026-10 und Typst 0.15.1. Für den Build mit gemeinsam genutzten Bibliotheken sind die Graphviz-Entwicklungsbibliotheken nötig.
Entwicklungsbuild¶
Im Stammverzeichnis des Repositorys:
mkdir -p build
native/tree-sitter/build.sh
odin build cmd/guidedog -out:build/guidedog -o:speed -vet -strict-style
build/guidedog --version
build/guidedog formats
Der tree-sitter-Build liefert die festgelegte Python-Grammatik für quelltextbasiertes autodoc. Installieren Sie Graphviz-Entwicklungsdateien über die Paketverwaltung. Ohne Typst-Brücke verwendet der PDF-Build ein installiertes typst. Wählen Sie es bei Bedarf mit --typst=/absolute/path/to/typst aus.
Eingebetteter Compiler¶
Bauen Sie die nativen Abhängigkeiten einmal und linken Sie sie in das Odin-Programm:
cargo build --release --manifest-path native/typst_bridge/Cargo.toml
native/graphviz/build.sh
odin build cmd/guidedog -out:build/guidedog -o:speed \
-define:GUIDEDOG_TYPST_BRIDGE=true -define:GRAPHDOG_STATIC=true
Die Typst-Brücke besteht aus Rust-Code außerhalb der allokationsfreien Grenze von Guidedoc. Ein eingebetteter Build muss kein separates Typst-Programm starten. Die eigenen Speicherkosten des Compilers bleiben jedoch bestehen.
Nennen Sie die Ausgabe unter Windows build/guidedog.exe. Nehmen Sie das Programm in PATH auf, um guidedog ohne Pfadangabe zu verwenden.