UltraGX Manual de UltraGX Descargar PDF

Línea de comandos

Todo lo que hace la aplicación lo ejecuta el motor, ultragx-engine, que también se puede usar directamente desde una terminal: para automatizar la documentación de varias KB, programarla en un servidor o integrarla en un proceso de integración continua. Usa la misma licencia que la aplicación.

Dónde está el motor

SistemaRuta
Windows (instalador)%LOCALAPPDATA%\Programs\UltraGX\ultragx-engine.exe
Linux (deb / rpm)/opt/ultragx/ultragx-engine
Linux (AppImage)./UltraGX-<versión>-x86_64.AppImage engine <comando> …
macOS/Applications/UltraGX.app/Contents/MacOS/ultragx-engine

En los ejemplos se usa ultragx-engine; reemplazalo por la ruta correspondiente o agregá la carpeta al PATH.

Comandos

version y machine-id

ultragx-engine version       # versión del motor
ultragx-engine machine-id    # id de la máquina, para pedir una licencia atada a ella

license

ultragx-engine license                                   # estado de la licencia, en JSON
ultragx-engine license activate --code ULGX-XXXX-XXXX    # activa una licencia con un código

La demo también se puede pedir sin la aplicación, en dos pasos:

ultragx-engine license register --first-name Ana --last-name Pérez --company "Mi Empresa" \
    --email ana.perez@miempresa.com --gx-version 18 --kb-size 3000 --lang es
ultragx-engine license confirm --email ana.perez@miempresa.com --code 123456

pipeline

Documenta una KB desde un export.

ultragx-engine pipeline --source xpz --input C:/exports/MiKB.xpz --out D:/ultragx/MiKB --lang es
ultragx-engine pipeline --source gxtext --input D:/exports/MiKB_texto --out D:/ultragx/MiKB --lang es --no-ref
OpciónDescripción
--sourcexpz (archivo .xpz o .xml) o gxtext (carpeta con src/ y ref/)
--inputarchivo o carpeta de entrada
--outcarpeta del proyecto (se crea si no existe)
--langidioma de los documentos: en, es o pt-BR
--no-refcon gxtext, omite los objetos de módulos referenciados
--no-viewerno genera el visor (más rápido; se puede generar después)

El progreso se escribe en la salida de error y, al terminar, el resumen de la ejecución sale en JSON por la salida estándar.

export

Abre una KB con el GeneXus instalado (solo Windows, con el conector), la exporta a texto y ejecuta el pipeline.

ultragx-engine export --kb-path "C:/Models/MiKB" --kb MiKB --out D:/ultragx/MiKB --lang es
OpciónDescripción
--kb-pathcarpeta de la KB (la que contiene el .gxw)
--kbnombre corto de la KB
--outcarpeta del proyecto
--gx-versionfuerza una instalación de GeneXus (18, 17, XEv3…); por defecto se deduce de la KB
--namesexporta solo algunos objetos: nombres o selectores como type:Transaction
--no-referenceomite los módulos referenciados
--skip-pipelinesolo exporta, sin documentar
--timeouttiempo máximo de la exportación en segundos (3600 por defecto)
--lang, --no-viewerigual que en pipeline

viewer

Regenera el visor de un proyecto sin volver a analizar la KB.

ultragx-engine viewer --out D:/ultragx/MiKB --lang es

narrative

Ejecuta la narrativa con IA sobre un proyecto ya documentado. Por línea de comandos, las credenciales se toman de variables de entorno: ANTHROPIC_API_KEY para Anthropic, OPENAI_API_KEY (y OPENAI_BASE_URL para otro servidor) para los proveedores compatibles con OpenAI, incluidos Gemini, OpenRouter y los modelos locales.

export OPENAI_API_KEY=...        # en PowerShell: $env:OPENAI_API_KEY = "..."
ultragx-engine narrative run --out D:/ultragx/MiKB --provider openai \
    --base-url https://generativelanguage.googleapis.com/v1beta/openai/ --model gemini-3.8-flash \
    --lang es --concurrency 8
OpciónDescripción
--provideranthropic, openai (cualquier servidor compatible) o mock
--model, --base-urlmodelo y URL del servidor
--langidioma de la prosa
--concurrencyobjetos en paralelo (4 por defecto)
--typessolo estos tipos, separados por coma
--all-typesincluye también las declaraciones (atributos, dominios, SDTs…)
--onlysolo estos objetos, por <Tipo>.<Nombre> separados por coma
--limitcantidad máxima de objetos
--no-resumevuelve a procesar objetos ya narrados
--max-doc-charscaracteres del documento que se envían (60.000 por defecto; 16.000 con un servidor local si no se indica)
--no-sourceno envía el código GeneXus original al modelo
--timeoutsegundos de espera por respuesta (300 por defecto)
--viewer-everysegundos entre regeneraciones del visor durante la ejecución (600 por defecto; 0 = solo al final)

notes

Agrega o borra notas del usuario sin la aplicación.

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

nota.json tiene la forma {"stems": ["Procedure.CalcularDescuento"], "text": "…", "author": "Ana"}. apply vuelve a incorporar todas las notas a los documentos.

Códigos de salida

CódigoSignificado
0terminó bien
1la narrativa terminó con objetos en error
2uso incorrecto (comando u opciones inválidos) o, en export, no se pudo abrir la KB
3licencia faltante, inválida, vencida o revocada

Ejemplo: documentar todas las KB de una carpeta

$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 es
    if ($LASTEXITCODE -ne 0) { Write-Warning "$($_.Name) terminó con código $LASTEXITCODE" }
}