Referência de comandos da CLI

Interprete corretamente saídas de comandos da CLI, comprovantes, erros estruturados e códigos de saída.

Visão geral

Use o binário instalado após a verificação e a instalação. Esta referência distingue descoberta de comandos, resultados de execução, comprovantes de pré-verificação e respostas de serviços.

Manifesto de ações

O sucesso grava um único array JSON. Cada entrada tem name, description, inputSchema, executes e class. O manifesto incorporado para clientes tem 25 ações, das quais 22 têm executes: true. altifigence.analyze.run, altifigence.evolve.launch e altifigence.verify.run servem apenas para planejamento. Os subcomandos nativos da CLI têm sua própria ajuda específica além desse manifesto para clientes. A resposta do servidor determina se uma operação do serviço está autorizada e pronta.

Use a ajuda do comando específico para os argumentos nativos:

Bash
alti commands
Bash
alti xls upstream run --help
alti compute rtl-evolve --help
alti ide workspace hierarchy-plan --help
alti ide cloud search --help
alti ide service workspace replace --help

Pré-verificação de jobs offline

Prepare os arquivos-fonte e o envelope em Primeiro resultado com a CLI e depois execute:

O esquema de sucesso é altifigence.cli.engine-job-preflight.v1. submitted: false e server_authority_verified: false são obrigatórios: o hash dos arquivos-fonte e a estrutura do job foram verificados localmente, mas nenhum job foi enviado ou executado. O execution_placement solicitado por um envelope não altera isso.

Bash
alti --json job validate \
  --job "$ALTI_WORKSPACE/job.json" \
  --workspace-root "$ALTI_WORKSPACE" \
  --source rtl/top.sv

Contrato de erros JSON

Uma execução de --json job validate com falha não grava comprovante de sucesso em stdout e emite um objeto altifigence.cli.error.v1 em stderr:

Use error.code quando disponível. Outras famílias de comandos têm seus próprios esquemas de erro; não presuma que esse envelope se aplique a todos os comandos da CLI.

JSON
{
  "schema": "altifigence.cli.error.v1",
  "error": {
    "code": "ENGINE_JOB_JSON_INVALID",
    "message": "The engine job JSON is invalid.",
    "retryable": false
  }
}

Código de saída

Código

Interpretação

0

O comando selecionado foi concluído; leia o resultado para determinar se ele informa prontidão, pré-verificação, um plano ou execução

1

Falha de execução, validação, transporte ou instalação da CLI; falhas de serviços podem incluir uma resposta HTTP

2

Argumentos inválidos ou solicitação rejeitada antes do transporte/início do mecanismo; um mecanismo também pode retornar esse código

3

Rejeição de classe reservada no caminho do manifesto para clientes; um mecanismo pode usar o mesmo número de outra maneira

4

Recusa do manifesto para clientes, incluindo login/identidade de nível superior indisponível ou ausência de consentimento para enviar arquivos-fonte

126

Falha no início do mecanismo ou na autenticação da instalação

127

Executável necessário do mecanismo indisponível

Outro código diferente de zero

Pode ser o próprio código do mecanismo filho, repassado

Sempre confira o código de saída antes de interpretar stdout e mantenha stderr separado. Um arquivo de saída vazio ou parcial não é um resultado bem-sucedido. Um plano salvo não é uma transação aplicada, e a aceitação do servidor não é a conclusão do job.

Comandos de mecanismos: o que realmente é executado

Os adaptadores de XLS, compute e DDS nativo usam executáveis associados fixos do pacote. A execução instalada autentica o runner relevante em relação ao seu registro assinado da versão; adicionar outro executável ao PATH não corrige a ausência de um executável associado necessário. Alguns comandos antigos de compatibilidade mantêm seu comportamento documentado de resolução. Consulte Conjunto de comandos.

Sem --json, stdout do mecanismo é repassado para que um plano nativo opaco possa ser salvo diretamente. Com --json, uma chamada de mecanismo normalmente produz altifigence.local-engine-execution.v1; seus campos stdout e stderr contêm os fluxos do processo filho como strings. Interprete o resultado interno separadamente.

Para planos de arquivos e hierarquia, passe o resultado completo do plano nativo ao comando apply correspondente. Não passe o envelope externo da CLI nem apenas um hash do plano. O backend nativo valida os hashes atuais dos arquivos e as condições da transação.

Saída de serviços e streaming

ide service retorna altifigence.dds.service-receipt.v1 com operation, ok, httpStatus e a resposta limitada body. HTTP 409 em uma substituição continua sendo um conflito e não é repetido. Uma resposta DELETE vazia bem-sucedida é mantida vazia; não é transformada artificialmente em um objeto JSON do servidor.

A busca nativa do DDS e a busca do Cloud expõem suas próprias evidências de correspondência e conteúdo. Use a identidade fornecida pelo backend no qual você fará a escrita; um hash calculado para outro backend de busca não é automaticamente um token CAS válido.

ide cloud terminal transmite bytes do terminal em stdout e o estado da conexão em stderr. Não é um único comprovante JSON, mesmo com o --json global. Limite a duração da conexão e preserve o cursor se pretende reconectar.

--json release install e --json release uninstall emitem altifigence.cli.release-bootstrap.v1 com operation, ok e exitCode. Os diagnósticos do instalador vão para stderr. Falhas de verificação ou de privilégios podem ocorrer antes de existir um envelope de sucesso.

Capturar um resultado para automação

Selecione um diretório de saída novo para cada chamada. Salve stdout e stderr separadamente, capture imediatamente o código de saída e interprete um esquema de sucesso somente após uma saída zero. Com um envelope de mecanismo, interprete sua string stdout como o documento nativo apenas quando o contrato do comando disser que ela contém JSON.

Para um fluxo plan/apply, preserve o plano nativo bruto completo e use o mesmo projeto. Revise os arquivos afetados e os hashes atuais antes de aplicar. Um conflito exige uma nova leitura e um plano revisado; não é motivo para descartar as verificações de hash. Consulte Automação e CI para uma verificação local reproduzível.