The Actyx Command Line Interface (CLI) is a unified tool to manage your ActyxOS nodes and apps. With the Actyx CLI, you can interact with your ActyxOS environment by running commands in your favourite terminal program:
- Linux or macOS: Use common shell programs such as bash, zsh or tcsh to run commands in linux shells
- Windows: On Windows, run commands with the Windows command prompt or in PowerShell
no help needed?
If you already know how to install command line tools, you can directly go to our downloads page and download the binary file for the Actyx CLI.
This section describes how to install the Actyx CLI. Just choose your operating system and follow the instructions:
- x64 version of Windows
- Admin rights to run the Windows installer
x64 version of macOS
x64, arm64, armhf or arm version of Linux
Installing the Actyx CLI
Download the Actyx CLI MSI installer for Windows on our downloads page. By default, the Actyx CLI installs to
C:\Program Files\Actyx\Actyx CLI X.X.X\
Run the downloaded MSI installer and follow the onscreen instructions
To confirm the installation, use the
ax --versioncommand in PowerShell or a command prompt (open the Start menu and search for PowerShell or cmd to start them). You should see something like this:
Download the Actyx CLI binary file from our downloads page
Run the following command to move the Actyx CLI binary file:
- Make the Actyx CLI binary file exectuable:
Additional steps if you use macOS
If you use macOS, you need to additonally allow the Actyx CLI in two steps. First, go to Settings and then to Security & Privacy. In the General tab, you should see a prompt at the bottom that asks you to allow the Actyx CLI. Second, the first time you run an
ax command, you will be prompted again to allow the Actyx CLI.
- To confirm the installation, use the
ax --versioncommand. You should see something like this:
If you have problems with installing the Actyx CLI, please check our troubleshooting section.
Uninstalling the Actyx CLI
To uninstall the Actyx CLI, open the Control Panel, go to Settings and then to Apps. Select the Entry named Actyx CLI, and then choose Uninstall to launch the uninstaller. Confirm that you want to uninstall the Actyx CLI when you're prompted.
Run the following command: