Guidedog のビルドとインストール¶
macOS に Homebrew でインストールする¶
Apple シリコンまたは Intel 搭載の Mac では、公式 tap insanai/homebrew-guidedog を使います。
brew tap insanai/guidedog
brew install insanai/guidedog/guidedog
guidedog --version
Homebrew はプロセッサに合ったリリースアーカイブを選び、SHA-256 を検証します。パッケージには Typst、Graphviz、tree-sitter が含まれています。HTML と PDF の生成に Odin コンパイラ、Python 環境、別途の Typst インストールは不要です。対応する OS は macOS 12 以降です。
はじめてのプロジェクト に沿って最初のプロジェクトを作成してください。インストール済みのバージョンを更新するには、次を実行します。
brew update
brew upgrade insanai/guidedog/guidedog
brew test insanai/guidedog/guidedog を実行すると、プロジェクトを作成して HTML と PDF を生成し、インストールしたパッケージを確認できます。
ソースからビルドする¶
tools/odin-release.txt で固定された Odin ツールチェーンを使ってください。リリースは Odin dev-2026-10 と Typst 0.15.1 を使用しています。共有ライブラリを使うビルドには Graphviz の開発用ライブラリが必要です。
開発用ビルド¶
リポジトリのルートで実行します。
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
tree-sitter のビルドは、ソースベースの autodoc 用に固定版の Python 文法を用意する。Graphviz の開発ファイルはシステムのパッケージ管理で導入する。Typst ブリッジのないビルドでは、インストール済みの typst で PDF を作る。--typst=/absolute/path/to/typst で明示的に選べる。
組み込みコンパイラ¶
ネイティブ依存を一度ビルドし、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
Typst ブリッジは Rust コードで、Guidedoc の無割り当て境界の外にある。埋め込みビルドでは別の Typst 実行ファイルを起動せずに済むが、コンパイラー自身のメモリ消費はなくならない。
Windows では出力名を build/guidedog.exe にする。パスなしで guidedog を使うには、実行ファイルを PATH に入れる。