クイックスタート
1) インストール
sh
dotnet tool install -g codersインストール/使用法の詳細
ワークスペース初期化
coders init を実行して、基本設定とサンプル .jssp ファイル一式を生成します。
-f|--forceがない場合、config.ymlが存在すると中断します。-v|--verboseでコンソールログを情報レベルに拡張します。--forceを使うと既存ファイルを新しいテンプレートで上書きします。
生成される config.yml の既定値は次のとおりです:
yaml
llmOptions:
# 使用する LLM 供給者
provider: "ollama"
# ビルド時に使用するモデル名
model: "gpt-oss-safeguard:20b"
# LLM のエンドポイントと認証情報
url: "http://localhost:11434"
apiKey: "OLLAMA_API_KEY"
timeoutSeconds: 300
stream: true
entry: main.jssp
projects: []ルートの llmOptions は LLM 呼び出しに必要な供給者、モデル、エンドポイント、認証、タイムアウト、ストリーミング設定を担当します。projects はプラットフォーム別の出力を定義し、coders platform add で項目を追加して編集します。
プラットフォーム管理
coders platform list [-v]: 登録済みのプラットフォームキーと既定のターゲット/言語情報を出力します。coders platform add <platform> [-v]: 指定したプラットフォームの既定プロジェクト構成をconfig.ymlに追加します。生成されたエントリ/出力パスとオプションは必要に応じて編集します。coders platform remove <platform> [-v]: 予約されたサブコマンドです。
ソースビルド
coders build <platform> [-v] で .jssp を解析し、指定したプラットフォーム向けにコードを生成します。
platformはconfig.ymlのprojectsに宣言されたプラットフォームキーと一致する必要があります。config.ymlがない場合はビルドが中断され、エントリファイルがない場合はエラーになります。- 出力ディレクトリは存在しなければ自動的に作成されます。
プロンプト抽出
coders extract <target> <platform> [-o|--output <path>] [-v] でプロンプトなどのリソースを抽出します。
targetは抽出対象 (例:prompt)、platformはプラットフォームキーです。--outputで出力先ディレクトリを変更できます。指定しない場合は現在の場所が使われます。
代表的な流れ
sh
coders init
coders platform add <platform>
coders build <platform> -v初期化後、必要なプラットフォームを構成に追加し、同じキーでビルドを実行します。
2) ワークスペース初期化
sh
coders init生成される基本ファイル:
config.ymlmain.jssp
3) プラットフォーム追加
sh
coders platform add springboot
coders platform add reactjs
coders platform add mysqlconfig.yml に projects 項目が追加されます。
4) DSL 作成
main.jssp に Coders DSL を記述します。
js
domain Email string(320);
table user {
user_id int64 auto;
email Email unique;
key(user_id);
}5) ビルド
sh
coders build springboot出力は config.yml の outPath に生成されます。
プラットフォーム別ビルド例
sh
coders build springboot
coders build reactjs
coders build mysql各プラットフォームは projects 設定に基づき別々の出力ディレクトリに生成されます。
単一実行で複数プラットフォームをビルド
プラットフォームキーを繰り返し実行するか、スクリプトにまとめて実行します。
sh
coders build springboot
coders build reactjs
coders build mysql現在の CLI には複数プラットフォームの一括ビルド機能がないため、順次実行します。
6) プロンプト抽出 (任意)
sh
coders extract prompt springbootプラットフォーム別の変換ルールを確認するのに便利です。
チェックリスト
config.ymlのprojectsにプラットフォームが登録されているかentryファイルが存在するか- LLM 設定 (
llmOptions) が正しいか
よくあるミス
coders build実行時にプラットフォームキーを省略entryがmain.jsspと異なるのに更新していない- LLM 供給者/モデル名が実際のサービスと不一致