Command Line Interface

The Akuity CLI allows you to manage the Akuity Platform resources using the operating system's command line.

Installation

Mac (Apple Silicon)

1. Download the latest release with the command:

   curl -sSL -o akuity "https://dl.akuity.io/akuity-cli/$(curl -sL https://dl.akuity.io/akuity-cli/stable.txt)/darwin/arm64/akuity"
   note

   To download a specific version, replace the $(curl -sL https://dl.akuity.io/akuity-cli/stable.txt) portion of the command with the specific version.

   For example, to download version v0.2.0 on Mac, type:

   curl -sSL -o akuity "https://dl.akuity.io/akuity-cli/v0.2.0/darwin/arm64/akuity"

   Alternatively, you can download the CLI binary from the Akuity Portal UI using the CLI button in the left navigation bar.

2. Make the akuity binary executable:

   chmod +x ./akuity

3. Move the akuity binary to a file location on your system PATH.

   sudo mv ./akuity /usr/local/bin/akuity
   sudo chown root: /usr/local/bin/akuity
   note

   Make sure /usr/local/bin is in your PATH environment variable.

4. Check whether the version you've installed is the one you wanted:

   akuity version
   note

   If your system shows

   "akuity" can't be opened because Apple cannot check it for malicious software.

   you can allow running it by the following command:

   sudo xattr -d com.apple.quarantine /usr/local/bin/akuity

Mac (Intel)

1. Download the latest release with the command:

   curl -sSL -o akuity "https://dl.akuity.io/akuity-cli/$(curl -sL https://dl.akuity.io/akuity-cli/stable.txt)/darwin/amd64/akuity"
   note

   To download a specific version, replace the $(curl -sL https://dl.akuity.io/akuity-cli/stable.txt) portion of the command with the specific version.

   For example, to download version v0.2.0 on Mac, type:

   curl -sSL -o akuity "https://dl.akuity.io/akuity-cli/v0.2.0/darwin/amd64/akuity"

   Alternatively, you can download the CLI binary from the Akuity Portal UI using the CLI button in the left navigation bar.

2. Make the akuity binary executable:

   chmod +x ./akuity

3. Move the akuity binary to a file location on your system PATH.

   sudo mv ./akuity /usr/local/bin/akuity
   sudo chown root: /usr/local/bin/akuity
   note

   Make sure /usr/local/bin is in your PATH environment variable.

4. Check whether the version you've installed is the one you wanted:

   akuity version
   note

   If your system shows

   "akuity" can't be opened because Apple cannot check it for malicious software.

   you can allow running it by the following command:

   sudo xattr -d com.apple.quarantine /usr/local/bin/akuity

Linux or WSL

1. Download the latest release with the command:

   curl -sSL -o /usr/local/bin/akuity "https://dl.akuity.io/akuity-cli/$(curl -sL https://dl.akuity.io/akuity-cli/stable.txt)/linux/amd64/akuity"
   note

   To download a specific version, replace the $(curl -sL https://dl.akuity.io/akuity-cli/stable.txt) portion of the command with the specific version.

   For example, to download version v0.2.0 on Linux, type:

   curl -sSL -o /usr/local/bin/akuity "https://dl.akuity.io/akuity-cli/v0.2.0/linux/amd64/akuity"

   Alternatively, you can download the CLI binary from the Akuity Portal UI using the CLI button in the left navigation bar.

2. Make the akuity binary executable:

   chmod +x /usr/local/bin/akuity

3. Check whether the version you've installed is the one you wanted:

   akuity version

Windows

1. Download the latest release with the command:

   Invoke-WebRequest -URI https://dl.akuity.io/akuity-cli/$(Invoke-WebRequest https://dl.akuity.io/akuity-cli/stable.txt)/windows/amd64/akuity.exe -OutFile akuity.exe
   note

   To download a specific version, replace the $(Invoke-WebRequest https://dl.akuity.io/akuity-cli/stable.txt) portion of the command with the specific version.

   For example, to download version v0.2.0 on Windows, type:

   Invoke-WebRequest -URI "https://dl.akuity.io/akuity-cli/v0.2.0/windows/amd64/akuity.exe" -OutFile akuity.exe

   Alternatively, you can download the CLI binary from the Akuity Portal UI using the CLI button in the left navigation bar.

2. Append or prepend the akuity binary folder to your PATH environment variable.

3. Check whether the version you've installed is the one you wanted:

   akuity version

5. Login to Akuity Platform:

akuity login

Alternatively, you can generate an API token from the Akuity Portal UI using the API Keys tab on the organization profile page and expose the key using AKUITY_API_KEY_ID, AKUITY_API_KEY_SECRET, and optionally AKUITY_SERVER_URL environment variables:

export AKUITY_API_KEY_ID=<API_KEY_ID>
export AKUITY_API_KEY_SECRET=<API_KEY_SECRET>
akuity argocd instance list --organization-name <organization-name>