Compilar e instalar Guidedog¶
Instalar en macOS con Homebrew¶
En un Mac con Apple silicon o Intel, use el tap oficial insanai/homebrew-guidedog:
brew tap insanai/guidedog
brew install insanai/guidedog/guidedog
guidedog --version
Homebrew elige el archivo de la versión que corresponde a su procesador y comprueba su SHA-256. El paquete incluye Typst, Graphviz y tree-sitter. Para generar HTML y PDF no necesita un compilador de Odin, un entorno de Python ni una instalación aparte de Typst. La versión requiere macOS 12 o posterior.
Cree su primer proyecto siguiendo Tu primer proyecto. Para actualizar la versión instalada:
brew update
brew upgrade insanai/guidedog/guidedog
Ejecute brew test insanai/guidedog/guidedog para comprobar el paquete instalado. La prueba crea un proyecto y genera HTML y PDF.
Compilar desde el código fuente¶
Use la versión de Odin fijada en tools/odin-release.txt. La versión publicada usa Odin dev-2026-10 y Typst 0.15.1. La compilación con bibliotecas compartidas requiere las bibliotecas de desarrollo de Graphviz.
Compilación de desarrollo¶
Desde la raíz del repositorio:
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
La construcción de tree-sitter aporta la gramática Python fijada para autodoc basado en fuentes. Instala los archivos de desarrollo de Graphviz con el gestor del sistema. Sin el puente Typst, el PDF usa el programa typst instalado. Selecciónalo con --typst=/absolute/path/to/typst.
Compilador integrado¶
Compile una vez las dependencias nativas y enlácelas al ejecutable Odin:
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
El puente Typst está escrito en Rust y queda fuera del límite sin asignaciones de Guidedoc. La versión integrada evita lanzar un ejecutable Typst separado, pero no elimina el consumo del compilador.
En Windows, llama a la salida build/guidedog.exe. Añade el ejecutable al PATH para usar guidedog sin indicar su ruta.