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
| Flag | Predefinição | Descrição |
|---|---|---|
--list | false | Listar todos os tipos de esquema, um por linha. |
O que 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. É servido a partir dos esquemas incorporados no binário, pelo que a saída corresponde sempre à versão de aggrega em execução.
aggrega get-schema --list imprime o nome de todos os tipos que se podem pedir, um por linha — os tipos de entidade que um autor escreve (aggregate, component, feature, recipe, featurerecipe, manifest, release, plugin, schemalibrary, mappinglibrary, workloadlibrary, artifactlibrary, workload) juntamente com os esquemas de contrato internos que o compilador usa. Execute-o primeiro quando não tiver a certeza do token exato a passar.
Quando o usar
Recorra a get-schema quando precisar da forma exata de um tipo durante a autoria — que campos são obrigatórios, o que um valor pode ser, como um bloco se aninha. É a referência com que verificar um ficheiro escrito à mão e o ponto de partida para aprender um tipo desconhecido. Como imprime JSON Schema legível por máquina, também pode ser fornecido a um editor que reconheça esquemas ou a uma ferramenta de validação.
Um assistente de IA ligado através de aggrega mcp lê os mesmos bytes a partir do recurso schema://<kind>, pelo que o esquema com base no qual um assistente escreve e o esquema obtido na linha de comandos são idênticos. Esta página documenta o comando; 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 significado de cada campo.
Exemplos
Imprimir o esquema de um Component:
aggrega get-schema componentListar todos os tipos que se podem pedir:
aggrega get-schema --listObter um esquema e inspecionar um único campo com uma ferramenta JSON:
aggrega get-schema recipe | jq '.properties.spec'Para o ciclo de autoria que este comando alimenta — aprender a forma, criar a estrutura, preencher, validar — consulte Escrever ficheiros do Aggrega.