aggrega get-schema
エンティティ種別またはコントラクト種別の JSON Schema を出力します
概要
aggrega get-schema [kind] [flags]説明
Print the canonical JSON Schema for an embedded kind.
The kind is the lowercase-hyphenated schema name — for example component, aggregate, ir, or template-context. Entity kinds, the intermediate-representation and wire-format contracts, and the wasm-* plugin socket contracts are all addressable. The emitted bytes are identical to the distributed schema file.
Use --list to enumerate every available kind, one per line.フラグ
| フラグ | デフォルト | 説明 |
|---|---|---|
--list | false | すべてのスキーマ種別を 1 行に 1 つずつ一覧表示します。 |
動作
aggrega get-schema <kind> は、1 つのエンティティ種別またはコントラクト種別の正規の JSON Schema を標準出力に出力します。このスキーマは信頼できる構造上のコントラクトであり、その種別についてコンパイラが受け付ける必須フィールド、許可される値、およびネスト構造を示します。スキーマはバイナリに組み込まれたものから提供されるため、出力は常に実行中の aggrega のバージョンと一致します。
aggrega get-schema --list は、指定できるすべての種別の名前を 1 行に 1 つずつ出力します。作成者が記述するエンティティ種別(aggregate、component、feature、recipe、featurerecipe、manifest、release、plugin、schemalibrary、mappinglibrary、workloadlibrary、artifactlibrary、workload)に加え、コンパイラが使用する内部のコントラクトスキーマも含まれます。渡すべき正確なトークンがわからない場合は、まずこれを実行してください。
使用する場面
作成中に種別の正確な形、つまりどのフィールドが必須か、値として何を取りうるか、ブロックがどのようにネストするかを知る必要がある場合は get-schema を使用します。手書きのファイルを照合する際の基準となり、見慣れない種別を学ぶ際の出発点にもなります。機械可読な JSON Schema を出力するため、スキーマ対応のエディタや検証ツールに渡すこともできます。
aggrega mcp を通じて接続された AI アシスタントは、schema://<kind> リソースから同じバイト列を読み取ります。そのため、アシスタントが作成時に基準とするスキーマと、コマンドラインで取得するスキーマは同一です。このページではコマンドについて説明しており、スキーマの内容そのものは掲載していません。各フィールドの意味をフィールドごとに説明したものについては、コマンドを実行するか、対応するエンティティリファレンスのページを参照してください。
例
Component のスキーマを出力します:
aggrega get-schema component要求できるすべての種別を一覧表示します:
aggrega get-schema --listスキーマを取得し、JSON ツールで 1 つのフィールドを確認します:
aggrega get-schema recipe | jq '.properties.spec'このコマンドが組み込まれる作成ループ(形を学び、雛形を作成し、記入し、検証する)については、Aggrega ファイルの作成を参照してください。