本ドキュメントでは、本プロジェクトの開発環境構築、コードの変更、新しいツールの追加、およびテストの手順について解説します。
bun install
開発実行には llama-server と学習済みモデルが必要です。scripts/ 内のスクリプトを使用してください。
bin/: サイドカーバイナリ (llama-server) の格納場所。data/: データベースファイル (vector.db) の永続化レイヤー。logs/: 開発・診断用のログ出力。resources/: バンドルされる静的リソース(アイコン等)。src/backend/src/mcp.rs: MCP の全ツールロジック。src/backend/src/db.rs: スキーマ管理。test/: 統合テスト一式。新しい機能を MCP ツールとして公開する場合、以下の手順を踏みます。
src/backend/src/mcp.rs 内で、JSON-RPC でやり取りするメソッド名(例: tools/list)を確認し、新しいツール用の定義を追加します。
handle_search_vector などの既存の関数を参考に、新しい非同期関数を実装します。
message_handler 関数の match 文にツール名を追加し、実装したハンドラーを呼び出すように設定します。
src/backend/src/mcp.rs の末尾にある mod tests に、新しいツールの入出力を検証するテストを追加してください。
コアロジック(DB・MCP・LLM連係)のテストです。
cd src/backend cargo test
実際の HTTP/SSE 通信を介したテスト(開発環境が整っている場合)。
bun test
本プロジェクトでは、リリースのポータビリティを確保するため、特定のプラットフォームに依存しない自動化スクリプトを採用しています。
以下のコマンドを実行すると、新しいリリースブランチ(release/vX.Y.Z)が作成され、package.json, tauri.conf.json, Cargo.toml のバージョンが一括更新・コミットされます。
bun run release <新バージョン番号> # 例: bun run release 0.2.0
作成されたリリースブランチで、以下のコマンドを実行して最終的なパッケージ(MSI/EXE)を確認します。
bun run build
ビルドに問題がなければ、マスターブランチにマージし、タグを打ってリリースを確定させます。
git checkout master git merge release/v0.2.0 git tag -a v0.2.0 -m "Release v0.2.0"
cargo fmt および cargo clippy を遵守してください。README.md や document/ 内の該当ドキュメントを必ず更新してください。