Skip to main content

Install the CLI and Node Manager

Actyx Node Manager and the Actyx Command Line Interface (CLI) are tools to manage your ActyxOS 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 ActyxOS 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.

Actyx CLI#

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

  • x86_64 version of Windows
  • Admin rights to run the Windows installer

To install Actyx CLI, please follow these steps:

  1. Download the Actyx CLI installer for Windows from our downloads page.

  2. Run the downloaded installer and follow the onscreen instructions. By default, the Actyx CLI installs to C:\Program Files\Actyx\Actyx CLI X.X.X\

  3. To confirm the installation, use the ax --version command 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:

C:\> ax --version
Actyx CLI 1.5.0

Congratulations, you have successfully installed Actyx CLI! ๐ŸŽ‰

Node Manager#

Before downloading and installing Actyx Node Manager, please make sure you haven't already installed it together with ActyxOS. If not, please follow these steps:

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

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

  3. Double-click on the icon and wait until the application is opened. To confirm that you have installed the correct version, please navigate to the About tab inside the Node Manager UI and check the version.