Installation

All downloads are at ultra-gx.com. Each file is published with its SHA-256 fingerprint, in case you want to check that the download arrived intact.

Requirements

You do not need to install Python, Node or .NET: the engine and the application come compiled.

To read a KB live (without exporting it first) you need Windows with GeneXus X Evolution 1 to 18 installed on the same machine. For any other case an XPZ/XML export or a text export is enough, and then the operating system does not matter.

Disk space: a 700-object KB produces about 100 MB of documentation; a 5,000-object one, around 1 GB.

Windows

With the installer (recommended)

1. Download UltraGX-<version>-win-x64-setup.exe.
2. Run it. If Windows shows "Windows protected your PC" (SmartScreen), click More info and then Run anyway. The warning appears because the installer is still new to SmartScreen, not because there is a problem with the file.
3. Language: choose English, Español or Português. That language is used for the wizard, for the licence agreement shown and as the initial language of the application and of the documents it generates. Both can be changed later.
4. Licence agreement: read it and accept it to continue.
5. Destination folder: by default C:\Users\<user>\AppData\Local\Programs\UltraGX. The installation is per user and does not ask for administrator rights.
6. Additional tasks (both optional):
   • Create a desktop shortcut.
   • Open GeneXus exports (.xpz) with UltraGX: with this option, double-clicking an .xpz opens UltraGX on the Run pipeline tab, ready to document it.
7. Install. If the computer lacks WebView2, the installer downloads and installs it in this step (an internet connection is required).
8. When it finishes, leave Launch UltraGX ticked to open it and continue with First start and licence.

On Windows the installer also includes the GeneXus connector, which lets you read a KB live. If GeneXus is not installed on the machine, the connector stays inactive and does no harm.

Linux

Choose the format that matches your distribution:

# Debian / Ubuntu
sudo apt install ./ultragx_<version>_amd64.deb

# Fedora / RHEL
sudo dnf install ./ultragx-<version>-1.x86_64.rpm

The packages install the application in /opt/ultragx, the ultragx command and the entry in the applications menu, and they declare the WebKitGTK dependencies, so the package manager installs them for you.

AppImage (no installation): make it executable and open it. In this case the dependencies must already be present on the system:

sudo apt install libwebkit2gtk-4.1-0     # Debian / Ubuntu
chmod +x UltraGX-<version>-x86_64.AppImage
./UltraGX-<version>-x86_64.AppImage

On Linux the "live KB" source is not available (the connector needs GeneXus, which runs on Windows): export the KB to XPZ or to text on the machine where GeneXus is and document it here.

macOS

1. Download the .dmg that matches your Mac: osx-arm64 for Apple Silicon (M1 onwards), osx-x64 for Intel.
2. Open it and drag UltraGX to Applications.
3. The macOS build is not signed with an Apple Developer ID, so macOS blocks it the first time. Double-click Allow UltraGX.command in the disk image (or run xattr -cr /Applications/UltraGX.app in Terminal), then open UltraGX. If macOS still objects, go to System Settings → Privacy & Security and click Open Anyway next to the UltraGX message.

As on Linux, on macOS you work with XPZ or text exports.

Updating

Download the new version and install it over the previous one (on Windows, the installer replaces the files in the same folder). Settings, narrative connections, the licence and the generated outputs are kept.

Outputs generated with an earlier version can still be opened. To benefit from the improvements of the new engine, run the pipeline again on the same KB: user notes and the narrative already generated are kept.

Uninstalling

• Windows: Settings → Apps → Installed apps → UltraGX → Uninstall.
• Linux: sudo apt remove ultragx or sudo dnf remove ultragx; for the AppImage, just delete the file.
• macOS: drag UltraGX from Applications to the Bin.

Uninstalling does not delete your data:

If you want to remove everything, also delete the settings folder and your output folder. Remember that the settings store your API keys.