Installation
Install the Integration CLI using the distribution channel provided by Optimus for your environment. After installation, the command should be available as optimus.
Verify the installation:
optimus --version
On Windows, the executable is optimus.exe:
.\optimus.exe --version
Show command help:
optimus --help
optimus check --help
Runtime Requirements
The CLI is built from a .NET 9 project.
Current release builds are published as self-contained, single-file applications. The .NET runtime is embedded in the published executable, so the target machine does not need a separate .NET installation for the published CLI artifact.
No installer is required. Place the executable in a folder that your automation can access and run it from there.
End users normally do not need to know the project layout, but the source project is:
api/tools/Optimus.Cli/Optimus.Cli.csproj
Operating System
Choose the package that matches the target operating system and CPU architecture.
| Package | Executable | Target |
|---|---|---|
optimus-cli-<version>-linux-x64.tar.gz | optimus | 64-bit Linux |
optimus-cli-<version>-win-x64.tar.gz | optimus.exe | 64-bit Windows |
optimus-cli-<version>-osx-x64.tar.gz | optimus | macOS on Intel |
optimus-cli-<version>-osx-arm64.tar.gz | optimus | macOS on Apple Silicon |
Each package also includes:
optimus-cli-<version>-<runtime>.sha256
manifest.json
Use the checksum file to verify the downloaded archive when your installation process requires integrity checks.
Do not use a package for a different runtime. For example, the linux-x64 package will not run on Windows, and the osx-x64 package is not the Apple Silicon package.
Network Requirements
The CLI requires outgoing HTTPS access on port 443 to the Optimus API host selected for the run.
| Environment | Host |
|---|---|
| Production | app.optimussoftware.de |
| Test | dev.app.optimussoftware.de |
If a firewall, allowlist, or proxy is used, allow the host for the environment you run against.
When --base-url or OPTIMUS_BASE_URL is set, allow the custom host instead.
The CLI uses the standard .NET HTTP stack. In typical environments, proxy behavior follows the operating system or environment proxy configuration.
Updating
When Optimus provides a newer CLI version, replace the installed binary or package and verify the version again:
optimus --version
If a command example from these docs does not work with your installed version, check the installed version first.