CONVERGE Horizon
Install the CLI¶
You can install the CLI on Linux, Windows, or MacOS systems.
Install the CLI on Linux¶
You can download the Linux CLI from
Download this file to your home directory and then run the following commands:
unzip horizon_linux.zip
chmod +x horizon
./horizon config:create <API key>
Replace <API key> with the API key listed in your account settings (My Account > API Key).
To run CLI commands in the format documented here, place the horizon executable in a bin directory (e.g., $HOME/bin) and add this directory to your Path environment variable:
mv horizon /path/to/bin/horizon
export PATH=$PATH:/path/to/bin
To set your Path permanently (and not just for the current shell session), add export PATH=$PATH:/path/to/bin to your shell configuration file.
If you do not modify your Path, you may need to replace horizon with ./horizon or the full path to the executable when running CONVERGE Horizon commands.
Install the CLI on Windows¶
You can download the Windows CLI from
Download this file to your home directory and then run the following commands in a PowerShell terminal:
Expand-Archive .\horizon_win.zip
cd horizon_win
.\horizon.exe config:create <API key>
Replace <API key> with the API key listed in your account settings (My Account > API Key).
To run CLI commands in the format documented here, place the horizon.exe file in a bin directory (e.g., C:\Users\<username>\bin) and add this directory to your Path environment variable. You can edit environment variables in the Control Panel.
If you do not modify your Path, you may need to replace horizon with the full path to horizon.exe when running CONVERGE Horizon commands.
Install the CLI on MacOS¶
The MacOS version of the CLI can be run only on native Apple hardware (i.e., processors based on the 64-bit ARM architecture).
Tip
The CLI is an unsigned application, so you may be blocked from running the horizon executable when you follow the steps below. To proceed, you must allow the application manually.
In MacOS Sonoma, blocked applications are listed in System Settings > Privacy & Security > Security. Look for a message that says “horizon was blocked from use…” and click Open Anyway to allow it.
You can download the MacOS CLI from
Download this file to your home directory, open a terminal, and run the following commands:
unzip horizon_macos.zip
chmod +x horizon
./horizon config:create <API key>
Replace <API key> with the API key listed in your account settings (My Account > API Key).
To run CLI commands in the format documented here, place the horizon executable in a bin directory (e.g., $HOME/bin) and add this directory to your Path environment variable:
mv horizon /path/to/bin/horizon
export PATH=$PATH:/path/to/bin
To set your Path permanently (and not just for the current shell session), add export PATH=$PATH:/path/to/bin to your shell configuration file.
If you do not modify your Path, you may need to replace horizon with ./horizon or the full path to the executable when running CONVERGE Horizon commands.