Pular para o conteúdo
AggregaAggrega
Selecionar língua: Português (Brasil)
Esta página foi traduzida automaticamente. Leia o original em inglês.

aggrega get-schema

Imprimir o JSON Schema de um tipo de entidade ou de contrato

Sinopse

aggrega get-schema [kind] [flags]

Descrição

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

FlagPadrãoDescrição
--listfalseListar cada tipo de esquema, um por linha.

O que ele faz

aggrega get-schema <kind> imprime na saída padrão o JSON Schema canônico de um tipo de entidade ou de contrato. O esquema é o contrato estrutural de referência: os campos obrigatórios, os valores permitidos e o aninhamento que o compilador aceita para esse tipo. Ele é servido a partir dos esquemas embutidos no binário, então a saída sempre corresponde à versão de aggrega que você está executando.

aggrega get-schema --list imprime o nome de cada tipo que você pode solicitar, um por linha — os tipos de entidade que um autor escreve (aggregate, component, feature, recipe, featurerecipe, manifest, release, plugin, schemalibrary, mappinglibrary, workloadlibrary, artifactlibrary, workload) junto com os esquemas de contrato internos que o compilador usa. Execute-o primeiro quando não tiver certeza do token exato a passar.

Quando usá-lo

Recorra a get-schema quando precisar da forma exata de um tipo durante a autoria — quais campos são obrigatórios, o que um valor pode ser, como um bloco se aninha. É a referência com a qual verificar um arquivo escrito à mão, e o ponto de partida para aprender um tipo desconhecido. Como ele imprime JSON Schema legível por máquina, você também pode passá-lo a um editor com suporte a esquemas ou a uma ferramenta de validação.

Um assistente de IA conectado por meio de aggrega mcp lê os mesmos bytes do recurso schema://<kind>, então o esquema com base no qual um assistente escreve e o esquema que você obtém na linha de comando são idênticos. Esta página documenta o comando; ela não reproduz o conteúdo de nenhum esquema — execute o comando ou abra a página correspondente da referência de entidades para a explicação campo a campo do que cada campo significa.

Exemplos

Imprimir o esquema de um Component:

Terminal window
aggrega get-schema component

Listar cada tipo que você pode solicitar:

Terminal window
aggrega get-schema --list

Obter um esquema e inspecionar um único campo com uma ferramenta JSON:

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

Para o ciclo de autoria que este comando alimenta — aprender a forma, gerar o esqueleto, preencher, validar —, consulte Escrever arquivos do Aggrega.