式・スクリプトの説明文を用意する

最終更新日: 2025年5月25日

リポジトリに含まれる式とスクリプトの説明資料を自動生成します。（別途、AIモデルが必要です。）

概要

本ツールはリポジトリファイルの内容をAIモデルが解析し、式およびスクリプトを説明する日本語文章を自動生成します。

本ツールを実行した後に設計書出力(HTML)を行うと、式とスクリプトの説明文が設計書に反映されます。

ダウンロードとセットアップ

本ツールは Premium Support を契約している Wagby ユーザーに提供しています。ご契約者様は Premium Support でお問い合わせください。

入手した zip ファイルを解凍すると Reng-1.0.0.jar というファイルが得られます。これをWagbyインストールフォルダ内の misc フォルダにコピーしてください。

メモ

どのバージョンのWagbyでもご利用できます。

使い方

準備

このツールは Java 17 以降で動作します。旧版のWagbyをご利用で Java8/11 でお使いの場合も、このツールを実行するときは Java17 以降に切り替えてください。
設計書出力(HTML版)を一度、実行します。miscフォルダ内にhelpersフォルダが作成され、その中にglossary.mdというファイルが作成されます。このファイルがあることを事前に確認しておいてください。
このツールは各 AI モデルが提供する「API KEY」を使います。事前にご利用予定の AI モデルについての API KEY を入手しておいてください。

注意

AI モデルの API KEY 利用は有料です。本ツール利用時にかかる API 料金は、ご利用者様が負担するものとします。

API KEYを登録する

Windows OS ご利用の場合

「設定 > システム > バージョン情報 > システムの詳細設定」から「環境変数...」を開きます。

環境変数を開く
システム環境変数で API KEY を設定します。以下は Open AI の例です。

環境変数の設定(1)

環境変数の設定(2)
設定後、このウィンドウを保存します。
コマンドプロンプトを開きます。

コマンドプロンプトを開く
echoコマンドで、キーの内容を確認します。誤りがあれば(1)からやり直してください。
```
echo %OPENAI_API_KEY%
```
echoコマンドで内容を確認する

Linux / Mac OS X ご利用の場合

環境変数を設定してください。以下は Open AI の API KEY を .bash_profile に設定した例です。

export OPENAI_API_KEY="(YOUR KEY)"

実行

misc フォルダを開きます。次のコマンドで実行します。

java -jar Reng-1.0.0.jar

実行すると AI モデルと通信を行い、リポジトリに含まれる式とスクリプトを解析し、適切な日本語の説明文を取得します。

注意

この通信（およびAIによる解析の実行）には時間がかかります。コンソールにリアルタイムで解析結果が出力されます。

入力元となるWagbyフォルダを指定する

misc以外のフォルダからこのプログラムを実行することもできます。この場合、コマンドライン引数に、対象となるWagbyフォルダを指定してください。

java -jar Reng-1.0.0.jar ~/prj/Wagby-9.3.3

利用できるAIモデル

本ツールが利用できるAIモデルは OpenAI/Anthropic/Google Gemini です。以下のAIモデルについて、いずれか1つを選択して、関連する変数を設定します。（複数指定することはできません。)

利用するAIモデル	必要な環境変数	説明	省略時の値
Open AI	OPENAI_API_KEY	APIキー	なし。設定は必須。
	OPENAI_MODEL	種別。次の指定が行える。 gpt-5 gpt-5-mini gpt-5-nanogpt-5 gpt-5.4 gpt-5.4-mini gpt-5.4-nano gpt-5.5 gpt-4o-mini gpt-4.1 gpt-4.1-mini	gpt-5
	temperature	環境変数ではなく実行時パラメータとして指定できる。gpt-4系の場合は0.2から0.5を推奨。gpt-5の場合は指定しない。[後述]	1 (gpt-5前提)
Anthropic	ANTHROPIC_API_KEY	APIキー	なし。設定は必須。
	ANTHROPIC_MODEL	種別。次の指定が行える。 claude-sonnet-4-6 claude-opus-4-7	claude-sonnet-4-6
	temperature	環境変数ではなく実行時パラメータとして指定できる。[後述]	0.5
Vertex AI Gemini	GOOGLE_CLOUD_PROJECT_ID	Google Cloud プロジェクトID。別途、認証も必要。(*)	なし。設定は必須。
	GEMINI_MODEL	種別。次の指定が行える。 gemini-2.5-pro gemini-2.5-flash gemini-2.5-flash-lite	gemini-2.5-pro
	temperature	環境変数ではなく実行時パラメータとして指定できる。[後述]	0.5

(*) Vertex AI Gemini を利用する場合、事前に次のような Google Cloud 認証を行ってください。

gcloud config set project <PROJECT_ID>
gcloud auth application-default login

なお、本ツールは Google AI Studio には対応していません。

temperatureを指定する

temperatureを指定する場合は、実行時のパラメータとします。

Open AI (GPT 4系)

java -jar Reng-1.0.0.jar --spring.ai.openai.chat.options.temperature=0.7

Anthropic

java -jar Reng-1.0.0.jar --spring.ai.anthropic.chat.options.temperature=0.7

Vertex AI Gemini

java -jar Reng-1.0.0.jar --spring.ai.vertex.ai.gemini.chat.options.temperature=0.7

出力結果

.cacheフォルダ

cache/vectorstore.json: 設計書出力(HTML)によって作成された用語一覧 (helpers/glossary.md) をRAGに登録したファイルです。スクリプトから説明文を作成するときにAIが参照します。

.historyフォルダ

ai-history.properties: AIに問い合わせた「式」の説明文をプロパティ形式で保持します。同じ式であれば再度の問い合わせを抑制するようになります。

.appendixフォルダ

<モデルID>_<スクリプトのタイミング>.md: AIが作成した、スクリプトの説明文です。Markdown形式となります。このあと設計書出力(HTML)を行うと、この内容をhtmlに変換して設計書に含めます。

リポジトリの書き換え

式の説明文は、repository/trunk以下のリポジトリファイルに直接、書き込まれます。

メモ

.appendixフォルダ以下のmdファイルや、repository/trunk以下のリポジトリファイルに含まれる説明文を直接、編集することは可能です。編集後、再度、設計書出力(HTML)を行うとその内容が反映されます。

本ツールの実行後に行うこと

本ツールの実行後に再び設計書出力(HTML)を行います。次の変更が反映されます。

式の説明が日本語文章に変更されます。
スクリプトの説明文が加わります。

仕様・制約

対応している式は「自動計算」「初期値」です。それ以外の式は今後、対応します。
対応しているスクリプトは「トランザクション」です。それ以外のスクリプトは今後、対応します。

変更履歴

1.0.0

2026年5月25日公開。