Referência da CLI dos adaptadores

Os adaptadores ContractForge expõem um vocabulário de comandos compartilhado para que os usuários não precisem para aprender um formato de ferramenta diferente para cada plataforma. Sinalizadores específicos do adaptador são permitido, mas os nomes e significados dos comandos principais devem permanecer consistentes.

Use o pacote do adaptador para o tempo de execução de destino:

Plataforma	CLI
Databricks	contractforge-databricks
AWS	contractforge-aws
Snowflake	contractforge-snowflake
Fabric	contractforge-fabric
GCP	contractforge-gcp

Comandos padrão

Comando	Propósito
plan	Carregue contratos, valide a semântica e retorne o status da capacidade do adaptador.
render	Gere SQL nativos, scripts, manifestos ou revise artefatos sem executá-los.
deploy	Publique ou registre artefatos de tempo de execução nativos para um único contrato quando o adaptador o suportar.
deploy-project	Renderize e, opcionalmente, implante um projeto solicitado de project.yaml.
run	Execute um caminho de contrato já implantado ou executável diretamente, quando houver suporte.
smoke	Execute um cenário de validação de propriedade do adaptador limitado.
cost-report	Renderize ou leia as evidências de custo da plataforma, quando disponíveis.
cleanup-plan	Produza um plano de limpeza revisado sem excluir recursos por padrão.
stabilization-report	Relate portões de superfície estável, revise limites e portões de promoção restantes.

Alguns adaptadores expõem comandos extras quando o recurso é genuinamente nativo essa plataforma, como sources, performance-report, source-promotion ou ajudantes de aplicação/leitura de governança. Esses comandos não devem substituir o padrão vocabulário de planejamento, renderização, implantação e evidências.

Bandeiras comuns

Bandeira	Significado
--environment	Contrato de ambiente que possui vinculação de tempo de execução, evidência, artefato e credencial.
--output-dir	Diretório para artefatos gerados e arquivos de revisão.
--dry-run	Valide/renderize sem realizar mutação remota.
--run	Execute após implementar/renderizar quando o comando do adaptador suportar.
--wait	Aguarde a execução remota atingir um estado terminal.
--readback	Consulte evidências nativas ou metadados após a execução.
--strict-final	Falha quando um portão final estável não está fechado.

Pontos de entrada dos adaptadores

contractforge-databricks stabilization-report --strict-final
contractforge-aws stabilization-report --strict-final
contractforge-snowflake stabilization-report --strict-final
contractforge-fabric stabilization-report --strict-final
contractforge-gcp stabilization-report --strict-final

Fluxo de trabalho padrão

Planeje um contrato:

contractforge-<adapter> plan path/to/contract.ingestion.yaml --environment path/to/environment.yaml

Renderizar artefatos nativos:

contractforge-<adapter> render path/to/contract.ingestion.yaml --environment path/to/environment.yaml --output-dir .contractforge/out

Implemente ou execute um projeto ordenado por meio do caminho de comando de propriedade do adaptador:

contractforge-aws deploy-project examples/real-world/usgs-earthquake-rest-medallion/project.yaml --run --wait
contractforge-gcp deploy-project examples/real-world/usgs-earthquake-rest-medallion/project.yaml --deploy-orchestration --run-orchestration --wait-orchestration --readback-orchestration

A execução do projeto deve usar o contrato do projeto e o adaptador CLI, não soluções alternativas de tempo de execução escritas à mão.

Regras

• Mantenha a semântica de origem, destino, modo de gravação, qualidade e governança nos contratos.
• Mantenha credenciais, locais de artefatos, armazéns, pools e IDs nativos em arquivos de ambiente.
• Não faça downgrade silenciosamente da semântica não suportada.
• Prefira SUPPORTED_WITH_WARNINGS ou REVIEW_REQUIRED a ocultar diferenças de plataforma.
• Persista ou leia novamente a evidência de execução real sempre que o adaptador reivindicar maturidade de tempo de execução.