Automation Suite on EKS/AKS installation guide

Last updated Feb 25, 2025

uipathctl

uipathctl is a UiPath® command-line tool that allows you to run commands against Automation Suite Kubernetes hosted on Azure Kubernetes Service (AKS) and Amazon Elastic Kubernetes Service (EKS).

You can use uipathctl to check prerequisites in your environment, install Automation Suite, configure and manage it from a single unified CLI. For more information, including a complete list of uipathctl operations, see the uipathctl reference documentation.

You can install uipathctl on the Linux, macOS, and Windows platforms.

Note:

Currently, uipathctl is only compatible with the x86 architecture. You cannot run uipathctl on machines based on the ARM architecture, such as Macs with Apple Silicon (M series) CPUs.

Running uipathctl on Linux

To run uipathctl on Linux, take the following steps:

Download the version of the uipathctl binary that you are interested in. For instructions, see Downloading the installation packages.
Uncompress uipathctl and add it to your PATH:
```
tar xzvf uipathctl-linux-amd64.tar.gz
chmod +x uipathctl
export PATH=$PATH:$(pwd)tar xzvf uipathctl-linux-amd64.tar.gz
chmod +x uipathctl
export PATH=$PATH:$(pwd)
```
Verify if uipathctl works:
```
uipathctl versionuipathctl version
```
The command prints some version information, as shown in the following example:
```
Version:       2023.10.1
...Version:       2023.10.1
...
```

Running uipathctl on Windows

Important:

uipathctl binaries on Windows version are currently not signed with the uipath.com certificate. You may get a warning when you try to download or run uipathctl on Windows.

To run uipathctl on Windows, take the following steps:

Download the version of the uipathctl binary that you are interested in. For instructions, see Downloading the installation packages.
Uncompress uipathctl and add it to your PATH:
```
tar xzvf uipathctl-windows-amd64.tar.gztar xzvf uipathctl-windows-amd64.tar.gz
```
Append or prepend the uipathctl binary folder to your PATH environment variable.
Verify it is working:
```
uipathctl versionuipathctl version
```
The command prints some version information, as shown in the following example:
```
Version:       2023.4.1
...Version:       2023.4.1
...
```

Running uipathctl on MacOS

Important:

When running uipathctl on MacOS, you may get the following error: uipathctl cannot be opened because the developer cannot be verified. To overcome this issue, you must allow uipathctl application to run under the Security section of your device's System Settings.

To run uipathctl on MacOS, take the following steps:

Download the version of the uipathctl binary that you are interested in. For instructions, see Downloading the installation packages.

Uncompress uipathctl and add it to your PATH:

tar xzvf uipathctl-darwin-amd64.tar.gz
chmod +x uipathctl
export PATH=$PATH:$(pwd)tar xzvf uipathctl-darwin-amd64.tar.gz
chmod +x uipathctl
export PATH=$PATH:$(pwd)

Verify if uipathctl works:
```
uipathctl versionuipathctl version
```
The command prints some version information, as shown in the following example:
```
Version:       2023.4.1
...Version:       2023.4.1
...
```

Telemetry

By default, telemetry is sent from uipathctl to UiPath® at each command execution. This helps us improve our products and user experience.

To opt out of telemetry, set the UIPATHCTL_TELEMETRY_OPTOUT environment variable to 1.

On this page

Running uipathctl on Linux
Running uipathctl on Windows
Running uipathctl on MacOS
Telemetry

Was this page helpful?

PREVIOUSDownloading the installation packages

NEXTAccessing Automation Suite