Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

SpecForgeのセットアップ

SpecForgeスイートはいくつかのコンポーネントで構成されています:

  • SpecForgeサーバー:他のコンポーネントが接続するバックエンドサーバーです。Dockerまたは実行ファイルとして実行できます。
  • SpecForge VSCode拡張機能:VSCodeでLilo言語のサポートを提供し、仕様の編集と管理、およびインタラクティブな可視化のレンダリングを行います。
  • SpecForge Python SDK:PythonコードからSpecForgeサーバーと対話するためのAPIを提供します。これは、PythonスクリプトやJupyterノートブックからSpecForgeサーバーと仕様やデータをやり取りするために使用できます。

必要なすべてのファイルは、SpecForgeリリースページから入手できます。

クイックスタート

すぐに始めるには、次の手順に従ってください:

  1. 依存ツールであるz3rsvg-converterをインストールする(OS固有の手順を参照; rsvg-converterはオプション)
  2. お使いのオペレーティングシステム用のSpecForge実行ファイルをダウンロードして展開する
  3. ライセンスを設定する(お使いのOSに於いて適切な場所にlicense.jsonを配置)
  4. (オプション)環境変数を設定してLLMプロバイダーを設定する(例:SPECFORGE_LLM_PROVIDER=openaiOPENAI_API_KEY=...) - LLMプロバイダーの設定を参照
  5. SpecForgeサーバーを起動する: ./specforge serve(Windowsでは.\specforge.exe serve
  6. VSCode拡張機能をインストールする(ドキュメントを参照)
  7. プロジェクト用のディレクトリを作成し、.liloファイルを直接配置する
  8. VSCodeでディレクトリを開き、仕様の記述を開始する

注意: プロジェクト設定ファイルlilo.tomlは省略可能です。最初のセットアップでは、これをスキップして、仕様ファイルとデータファイルをプロジェクトルートに直接配置しても差し支えありません。lilo.tomlをどんな場合にどのように使用するかについては、プロジェクト設定を参照してください。

詳細なセットアップ手順

プラットフォームを選択して詳細なセットアップ手順を確認してください:

  • Windows - Windowsの完全なセットアップガイド
  • macOS - macOS(Apple Silicon)の完全なセットアップガイド
  • Linux - Linuxの完全なセットアップガイド
  • Docker - 実行ファイルの代わりにDockerを使用する

サーバー環境変数

SpecForgeサーバーは起動時に以下の環境変数を読み込みます。これらはspecforge serveの実行前に設定するか、Docker Composeファイルに記述できます。

変数デフォルト説明
SPECFORGE_PORTInteger8080サーバーがリッスンするポート。
SPECFORGE_CACHE_BOUNDInteger64例示キャッシュの最大エントリ数。キャッシュはSMTソルバー(Z3)の結果を保存し、冗長な計算を回避します。0に設定するとキャッシュを無効化します。
SPECFORGE_SEMAPHORE_LIMITInteger8同時に実行できるSMTソルバー(Z3)インスタンスの最大数。リソース枯渇を防ぐために並列実行を制限します。0に設定するとセマフォを無効化します(並列数制限なし)。

使用例:

SPECFORGE_PORT=9090 SPECFORGE_CACHE_BOUND=128 ./specforge serve

LLM関連の環境変数(SPECFORGE_LLM_PROVIDERSPECFORGE_LLM_MODELOPENAI_API_KEYなど)については、LLMプロバイダーの設定ガイドを参照してください。

これらすべての設定は、SpecForge VSCode拡張機能の設定でも構成できます。