Перейти к содержимому
AggregaAggrega
Выберите язык: Русский
Эта страница переведена машинным способом. Читать оригинал на английском.

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.

Флаги

ФлагПо умолчаниюОписание
--listfalseВывести все виды схем, по одному в строке.

Что делает команда

aggrega get-schema <kind> выводит в стандартный вывод каноническую JSON Schema для одного вида сущности или контракта. Схема — это авторитетный структурный контракт: обязательные поля, допустимые значения и вложенность, которые компилятор принимает для этого вида. Она берётся из схем, встроенных в исполняемый файл, поэтому вывод всегда соответствует запущенной вами версии aggrega.

aggrega get-schema --list выводит имена всех видов, которые можно запросить, по одному в строке — виды сущностей, которые пишет автор (aggregate, component, feature, recipe, featurerecipe, manifest, release, plugin, schemalibrary, mappinglibrary, workloadlibrary, artifactlibrary, workload), а также внутренние схемы контрактов, используемые компилятором. Запустите её первой, если не уверены в точном токене, который нужно передать.

Когда использовать

Используйте get-schema, когда при написании нужна точная структура вида: какие поля обязательны, каким может быть значение, как вкладывается блок. Это эталон, с которым можно сверить написанный вручную файл, и отправная точка при изучении незнакомого вида. Поскольку команда выводит машиночитаемую JSON Schema, её вывод можно также передать редактору с поддержкой схем или инструменту валидации.

ИИ-ассистент, подключённый через aggrega mcp, читает те же байты из ресурса schema://<kind>, поэтому схема, по которой пишет ассистент, и схема, которую вы получаете в командной строке, идентичны. Эта страница описывает команду и не воспроизводит содержимое схем — запустите команду или откройте соответствующую страницу справочника сущностей, где поле за полем объясняется назначение каждого поля.

Примеры

Вывести схему для сущности Component:

Terminal window
aggrega get-schema component

Вывести все виды, которые можно запросить:

Terminal window
aggrega get-schema --list

Получить схему и просмотреть отдельное поле с помощью инструмента для JSON:

Terminal window
aggrega get-schema recipe | jq '.properties.spec'

О цикле написания, который питает эта команда — изучить структуру, создать заготовку, заполнить, проверить, — см. Написание файлов Aggrega.