Install the CLI and Node Manager

Actyx Node Manager and the Actyx Command Line Interface (CLI) are tools to manage your Actyx nodes and apps. While the Node Manager is an application that allows you to interact with the nodes in an easy-to-use user interface, with the CLI you can interact with your Actyx environment by running commands in your favorite terminal program:

• Unix based operating systems: 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

Please choose your development platform in the tabs below and follow the instructions.

Windows

Actyx CLI

To run Actyx CLI on Windows you need to have the following prerequisites:

• Windows 10 or Windows Server 2019
• x64 processor architecture

To install Actyx CLI, please follow these steps:

1. Download the Actyx CLI binary for Windows from our releases page.
2. Save the ax binary in some location on your machine. We recommend C:\Program Files\Actyx\.
3. In the Windows Search, look for and then select System (Control Panel)
4. Click the Advanced system settings link.
5. Click Environment Variables and in the section System Variables find the PATH environment variable and select it. Click Edit.

6. In the Edit System Variable window, add the path to the ax binary (e.g. C:\Program Files\Actyx\) to the PATH environment variable. Click OK. Close all remaining windows by clicking OK.
7. Restart your command line.
8. To confirm the installation, use the ax --version command. You should see something similar to this:

ax --version
Actyx CLI 2.0.0

Congratulations, you have successfully installed Actyx CLI! 🎉

Node Manager

To install Actyx Node Manager, please follow these steps:

1. Download the Actyx Node Manager MSI installer for Windows from our releases page.

2. Run the downloaded installer and follow the onscreen instructions.

3. Double-click on the icon and wait until the application is opened.

Linux

Actyx CLI

To run Actyx CLI on Linux you need to have the following prerequisites:

• amd64, arm64, armhf or arm processor architectures

To install Actyx CLI, please follow these steps:

1. Download the Actyx CLI binary file from our downloads page

2. Run the following command to move the Actyx CLI binary file:

mv ~/Downloads/ax /usr/local/bin

3. Make the Actyx CLI binary file executable:

sudo chmod +x /usr/local/bin/ax

4. To confirm the installation, use the ax --version command. You should see something similar to this:

ax --version
Actyx CLI 2.0.0

Congratulations, you have successfully installed Actyx CLI! 🎉

Actyx Node Manager

To install Actyx Node Manager, please follow these few steps:

1. Download the right binary (e.g. actyx-node-manager_amd64.deb) from our downloads page

2. With your command line, navigate to the directory where you saved the binary.

3. Execute sudo apt install ./actyx-node-manager_amd64.deb

4. When asked for, type the required password and hit enter.

Congratulations, you have successfully installed Actyx Node Manager! 🎉

macOS

Actyx CLI

To run Actyx CLI on macOS you need to have the following prerequisites:

• macOS Big Sur (earlier versions may work as well, are not officially supported though)

To install Actyx CLI, please follow these steps:

1. Download the Actyx CLI binary file from our downloads page

2. Run the following command to move the Actyx CLI binary file:

mv ~/Downloads/ax /usr/local/bin

3. Make the Actyx CLI binary file executable:

chmod +x /usr/local/bin/ax
xattr -d com.apple.quarantine /usr/local/bin/ax

Possible errors

If you forget the second command, your Mac may tell you that the program is damaged and cannot be executed.

If you do not get asked for your password at this point, you have to explicitly allow Actyx:

4. 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 Actyx CLI.
5. When running the first ax command, you will be prompted again to allow the Actyx CLI.
6. To confirm the installation, use the ax --version command. You should see something similar to this:

ax --version
Actyx CLI 2.0.0

Congratulations, you have successfully installed Actyx CLI! 🎉

On Apple Silicon: "ax" is damaged and can't be opened.

If you see this error, run the following command in the folder where the ax binary is located: xattr -d com.apple.quarantine ax.

Actyx Node Manager

Since Actyx is not yet listed as an App developer, you need to make a few changes in your security settings when installing Node Manager.

1. Download the Node Manager .dmg file from our releases page and double-click it.

2. Move the Node Manager icon into your Applications folder

3. Click OK on the initial prompt after opening Node Manager for the first time.

4. Navigate to the system preferences, then to Security & Privacy and click on Open Anyway.

5. Finally, open the app again and click Open when prompted with yet another dialogue.

Congratulations, you have successfully installed Actyx Node Manager! 🎉