aggrega get-schema
Das JSON Schema für eine Entitäts- oder Vertragsart ausgeben
Übersicht
aggrega get-schema [kind] [flags]Beschreibung
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.Flags
| Flag | Standard | Beschreibung |
|---|---|---|
--list | false | Jede Schema-Art auflisten, eine pro Zeile. |
Funktionsweise
aggrega get-schema <kind> gibt das kanonische JSON Schema für eine Entitäts- oder Vertragsart auf der Standardausgabe aus. Das Schema ist der maßgebliche strukturelle Vertrag: die Pflichtfelder, die zulässigen Werte und die Verschachtelung, die der Compiler für diese Art akzeptiert. Es wird aus den in das Binary eingebauten Schemas bereitgestellt, sodass die Ausgabe immer zu der Version von aggrega passt, die Sie ausführen.
aggrega get-schema --list gibt den Namen jeder Art aus, die Sie anfordern können, einen pro Zeile – die Entitätsarten, die ein Autor schreibt (aggregate, component, feature, recipe, featurerecipe, manifest, release, plugin, schemalibrary, mappinglibrary, workloadlibrary, artifactlibrary, workload), neben den internen Vertragsschemas, die der Compiler verwendet. Führen Sie es zuerst aus, wenn Sie sich über das genaue zu übergebende Token unsicher sind.
Wann es zu verwenden ist
Greifen Sie zu get-schema, wenn Sie beim Verfassen die genaue Form einer Art benötigen – welche Felder Pflicht sind, was ein Wert sein darf, wie ein Block verschachtelt wird. Es ist die verbindliche Grundlage, gegen die eine von Hand geschriebene Datei geprüft wird, und der Ausgangspunkt, um eine unbekannte Art kennenzulernen. Da es maschinenlesbares JSON Schema ausgibt, können Sie es auch einem schemafähigen Editor oder einem Validierungswerkzeug übergeben.
Ein über aggrega mcp verbundener KI-Assistent liest dieselben Bytes aus der Ressource schema://<kind>, sodass das Schema, gegen das ein Assistent schreibt, und das Schema, das Sie auf der Kommandozeile abrufen, identisch sind. Diese Seite dokumentiert den Befehl; sie gibt den Inhalt keines Schemas wieder – führen Sie den Befehl aus oder öffnen Sie die entsprechende Seite der Entitätsreferenz für die feldweise Erklärung, was jedes Feld bedeutet.
Beispiele
Das Schema für eine Component ausgeben:
aggrega get-schema componentJede Art auflisten, die Sie anfordern können:
aggrega get-schema --listEin Schema abrufen und ein einzelnes Feld mit einem JSON-Werkzeug untersuchen:
aggrega get-schema recipe | jq '.properties.spec'Für den Authoring-Zyklus, den dieser Befehl speist – Form kennenlernen, Gerüst erstellen, ausfüllen, validieren –, siehe Aggrega-Dateien verfassen.