CLI

humctl is the CLI to interact with the Humanitec Platform Orchestrator.

This article contains the installation instructions for different operating systems. To see how to use the CLI, follow the CLI reference.

Install humctl on Linux

  1. Download the latest release with the command

    curl -fLO https://github.com/humanitec/cli/releases/download/v0.21.0/cli_0.21.0_linux_amd64.tar.gz
    tar xvzf cli_0.21.0_linux_amd64.tar.gz
    rm cli_0.21.0_linux_amd64.tar.gz README.md
    

    curl -fLO https://github.com/humanitec/cli/releases/download/v0.21.0/cli_0.21.0_linux_arm64.tar.gz
    tar xvzf cli_0.21.0_linux_arm64.tar.gz
    rm cli_0.21.0_linux_arm64.tar.gz README.md
    
  2. Install humctl

    sudo install -o root -g root -m 0755 humctl /usr/local/bin/humctl
    

Install humctl on macOS

Homebrew

If you are on macOS and using the Homebrew package manager, you can install humctl with Homebrew.

  1. Run the installation command:

    brew install humanitec/tap/cli
    

Manually

  1. Download the latest release with the command

    curl -fLO https://github.com/humanitec/cli/releases/download/v0.21.0/cli_0.21.0_darwin_amd64.tar.gz
    tar xvzf cli_0.21.0_darwin_amd64.tar.gz
    rm cli_0.21.0_darwin_amd64.tar.gz README.md
    

    curl -fLO https://github.com/humanitec/cli/releases/download/v0.21.0/cli_0.21.0_darwin_arm64.tar.gz
    tar xvzf cli_0.21.0_darwin_arm64.tar.gz
    rm cli_0.21.0_darwin_arm64.tar.gz README.md
    
  2. Install humctl

    chmod +x ./humctl
    sudo mv ./humctl /usr/local/bin/humctl
    sudo chown root: /usr/local/bin/humctl
    

Install humctl on Windows

Scoop

If you are on Windows and using the Scoop package manager, you can install humctl with Scoop.

  1. Run the installation command:

    scoop bucket add humanitec https://github.com/humanitec/scoop-bucket
    scoop install humanitec/cli
    

Manually

  1. Download the latest release.

  2. Decompress the zip file, and move the binary to your PATH.

Available as Docker Image

  1. humctl is also published as Docker Image, which can be used like docker run --rm -it ghcr.io/humanitec/cli:0.21.0.

Available for GitHub Actions

  1. Inside Github Actions, you can use the humanitec/setup-cli-action to easily install humctl.

Validate your installation

  1. Run humctl version to ensure humctl is in your path. Expected output, matching your installed version:
    humctl version XX.YY.ZZ

  2. Retrieve a HUMANITEC_TOKEN for your Organization by following Authentication.

  3. Run humctl get orgs --token ${HUMANITEC_TOKEN}. Expected output, matching your Organization name:

    id     | name
    my-org | My-Org
    

Next steps

To see how to use the CLI, follow the CLI reference.

Top