Linha de comando

Tudo o que o aplicativo faz é executado pelo motor, ultragx-engine, que também pode ser usado diretamente em um terminal: para automatizar a documentação de várias KBs, agendá-la em um servidor ou integrá-la a um processo de integração contínua. Ele usa a mesma licença do aplicativo.

Onde está o motor

Nos exemplos é usado ultragx-engine; substitua pelo caminho correspondente ou adicione a pasta ao PATH.

Comandos

version e machine-id

ultragx-engine version       # versão do motor
ultragx-engine machine-id    # id da máquina, para pedir uma licença vinculada a ela

license

ultragx-engine license                                   # status da licença, em JSON
ultragx-engine license activate --code ULGX-XXXX-XXXX    # ativa uma licença com um código

A demo também pode ser pedida sem o aplicativo, em duas etapas:

ultragx-engine license register --first-name Ana --last-name Souza --company "Minha Empresa Ltda." \
    --email ana.souza@minhaempresa.com.br --gx-version 18 --kb-size 3000 --lang pt-BR
ultragx-engine license confirm --email ana.souza@minhaempresa.com.br --code 123456

pipeline

Documenta uma KB a partir de um export.

ultragx-engine pipeline --source xpz --input C:/exports/MinhaKB.xpz --out D:/ultragx/MinhaKB --lang pt-BR
ultragx-engine pipeline --source gxtext --input D:/exports/MinhaKB_texto --out D:/ultragx/MinhaKB --lang pt-BR --no-ref

O progresso é escrito na saída de erro e, ao terminar, o resumo da execução sai em JSON na saída padrão.

export

Abre uma KB com o GeneXus instalado (somente Windows, com o conector), a exporta para texto e executa o pipeline.

ultragx-engine export --kb-path "C:/Models/MinhaKB" --kb MinhaKB --out D:/ultragx/MinhaKB --lang pt-BR

viewer

Regenera o visualizador de um projeto sem analisar a KB de novo.

ultragx-engine viewer --out D:/ultragx/MinhaKB --lang pt-BR

narrative

Executa a narrativa com IA sobre um projeto já documentado. Na linha de comando, as credenciais são obtidas de variáveis de ambiente: ANTHROPIC_API_KEY para a Anthropic, OPENAI_API_KEY (e OPENAI_BASE_URL para outro servidor) para os provedores compatíveis com OpenAI, incluindo Gemini, OpenRouter e os modelos locais.

export OPENAI_API_KEY=...        # no PowerShell: $env:OPENAI_API_KEY = "..."
ultragx-engine narrative run --out D:/ultragx/MinhaKB --provider openai \
    --base-url https://generativelanguage.googleapis.com/v1beta/openai/ --model gemini-3.8-flash \
    --lang pt-BR --concurrency 8

notes

Adiciona ou exclui notas do usuário sem o aplicativo.

ultragx-engine notes add    --out D:/ultragx/MinhaKB --json nota.json
ultragx-engine notes delete --out D:/ultragx/MinhaKB --stem Procedure.CalcularDescuento --id n171234567890000
ultragx-engine notes apply  --out D:/ultragx/MinhaKB

nota.json tem o formato {"stems": ["Procedure.CalcularDescuento"], "text": "…", "author": "Ana"}. apply reincorpora todas as notas aos documentos.

Códigos de saída

Exemplo: documentar todas as KBs de uma pasta

$engine = "$env:LOCALAPPDATA\Programs\UltraGX\ultragx-engine.exe"
Get-ChildItem D:\exports\*.xpz | ForEach-Object {
    & $engine pipeline --source xpz --input $_.FullName --out "D:\ultragx\$($_.BaseName)" --lang pt-BR
    if ($LASTEXITCODE -ne 0) { Write-Warning "$($_.Name) terminou com código $LASTEXITCODE" }
}