Installation

xConvert CLI is distributed as a self-contained binary via the Optellix Azure Artifacts feed. No Python installation or internet access is required after setup.

---

Windows

1. Download the installer

Download xconvert-win-x64 vX.Y.Z from the Optellix Azure Artifacts feed. You will receive a .msi file.

2. Run the installer

Double-click the .msi file. The installer requires administrator privileges to add xconvert to the system PATH.

Follow the on-screen steps — you can change the install directory or leave it at the default:

C:\Program Files\Optellix\xconvert\

3. Open a new terminal

Open a new PowerShell or Command Prompt window after installation completes. The PATH change only takes effect in new terminal sessions.

4. Verify the installation

xconvert --version
xconvert info --check-binaries

Expected output:

xconvert, version X.Y.Z

-- Native Binaries --
  OK  StepParserOCCT    C:\Program Files\Optellix\xconvert\StepParserOCCT.exe
  OK  FBX2glTF          C:\Program Files\Optellix\xconvert\FBX2glTF.exe
-- Python Libraries --
  OK  trimesh           4.x.x
  OK  DracoPy           1.7.x

5. Set up your license

New-Item -ItemType Directory -Force "$env:USERPROFILE\.xviewr"
Copy-Item "your-license.lic" "$env:USERPROFILE\.xviewr\license.lic"

6. Run your first conversion

xconvert convert "C:\Models\assembly.step" --out "C:\Models\assembly.glb"

Uninstall

Use Add or Remove Programs in Windows Settings and search for xconvert. The uninstaller removes the binary and cleans up the PATH entry automatically.

---

Linux

Download xconvert-linux-x64 vX.Y.Z from the Optellix Azure Artifacts feed.

tar -xzf xconvert-linux-x64-vX.Y.Z.tar.gz -C /opt/xconvert
ln -s /opt/xconvert/xconvert /usr/local/bin/xconvert

Verify:

xconvert --version
xconvert info --check-binaries

Expected output:

-- Native Binaries --
  OK  StepParserOCCT    /opt/xconvert/StepParserOCCT
  OK  FBX2glTF          /opt/xconvert/FBX2glTF
-- Python Libraries --
  OK  trimesh           4.x.x
  OK  DracoPy           1.7.x

---

Docker (self-hosted)

If you want to run xConvert in a container on your own infrastructure, use the Linux tar.gz as the base in your own Dockerfile:

FROM ubuntu:22.04

RUN apt-get update && apt-get install -y libgomp1 && rm -rf /var/lib/apt/lists/*

COPY xconvert-linux-x64-vX.Y.Z.tar.gz /tmp/
RUN tar -xzf /tmp/xconvert-linux-x64-vX.Y.Z.tar.gz -C /opt/xconvert \
    && ln -s /opt/xconvert/xconvert /usr/local/bin/xconvert \
    && rm /tmp/xconvert-linux-x64-vX.Y.Z.tar.gz

ENTRYPOINT ["xconvert"]

docker build -t xconvert .
docker run --rm -v /path/to/models:/data xconvert convert /data/model.step --out /data/model.glb

---

License Setup

xConvert CLI requires a valid Optellix license. Licenses are issued by Optellix and may cover CLI access, SDK access, or both depending on your purchase. Contact Optellix to obtain a license.

Once you have your .lic file, set it up once and every subsequent command works without a flag.

Windows:

New-Item -ItemType Directory -Force "$env:USERPROFILE\.xviewr"
Copy-Item "your-license.lic" "$env:USERPROFILE\.xviewr\license.lic"

Linux:

mkdir -p ~/.xviewr
cp your-license.lic ~/.xviewr/license.lic

CI / server / Docker (environment variable):

export XVIEWR_LICENSE_KEY=/run/secrets/xviewr.lic
# or pass the raw token directly:
export XVIEWR_LICENSE_KEY="XVR1.eyJ..."

The CLI checks license sources in this order:

1. --license <path> flag on the command
2. XVIEWR_LICENSE_KEY environment variable (file path or raw token)
3. ~/.xviewr/license.lic default location

The same license file works across both the xConvert CLI and the XViewr SDK if your plan includes both.