SpecForgeのセットアップ
SpecForgeスイートはいくつかのコンポーネントで構成されています:
- SpecForgeサーバー:他のコンポーネントが接続するバックエンドサーバーです。Dockerまたは実行ファイルとして実行できます。
- SpecForge VSCode拡張機能:VSCodeでLilo言語のサポートを提供し、仕様の編集と管理、およびインタラクティブな可視化のレンダリングを行います。
- SpecForge Python SDK:PythonコードからSpecForgeサーバーと対話するためのAPIを提供します。これは、PythonスクリプトやJupyterノートブックからSpecForgeサーバーと仕様やデータをやり取りするために使用できます。
必要なすべてのファイルは、SpecForgeリリースページから入手できます。
クイックスタート
すぐに始めるには、次の手順に従ってください:
- 依存ツールである
z3とrsvg-converterをインストールする(OS固有の手順を参照;rsvg-converterはオプション) - お使いのオペレーティングシステム用のSpecForge実行ファイルをダウンロードして展開する
- ライセンスを設定する(お使いのOSに於いて適切な場所に
license.jsonを配置) - (オプション)環境変数を設定してLLMプロバイダーを設定する(例:
LLM_PROVIDER=openai、OPENAI_API_KEY=...) - LLMプロバイダーの設定を参照 - SpecForgeサーバーを起動する:
./specforge serve(Windowsでは.\specforge.exe serve) - VSCode拡張機能をインストールする(ドキュメントを参照)
- プロジェクト用のディレクトリを作成し、
.liloファイルを直接配置する - VSCodeでディレクトリを開き、仕様の記述を開始する
注意: プロジェクト設定ファイルlilo.tomlは省略可能です。最初のセットアップでは、これをスキップして、仕様ファイルとデータファイルをプロジェクトルートに直接配置しても差し支えありません。lilo.tomlをどんな場合にどのように使用するかについては、プロジェクト設定を参照してください。
詳細なセットアップ手順
プラットフォームを選択して詳細なセットアップ手順を確認してください: