Automation Suite
2023.10
false
Banner background image
Automation Suite on EKS/AKS Installation Guide
Last updated Apr 19, 2024

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 in Linux, macOS, and Windows platforms.

Running uipathctl on Linux

To run uipathctl on Linux, take the following steps:
  1. Download the version of the uipathctl binary that you are interested in. For instructions, see Downloading the installation packages.
  2. 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)
  3. 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
    ...

Running uipathctl on Windows

To run uipathctl on Windows, take the following steps:
  1. Download the version of the uipathctl binary that you are interested in. For instructions, see Downloading the installation packages.
  2. 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.
  3. 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

To run uipathctl on MacOS, take the following steps:
  1. Download the version of the uipathctl binary that you are interested in. For instructions, see Downloading the installation packages.
  2. 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)
  3. 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.

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.