Installation

The score-humanitec CLI is an open source Score implementation CLI, that enables the translation of Score files into a Humanitec Deployment Set. The installation options provided below are applicable to other implementation CLIs, such as score-compose or score-helm, as well. If you prefer to work with Score using the native Humanitec CLI or API instead, you can learn more about it in the section on how Score and Humanitec work together.

Install the score-humanitec Implementation CLI

You can install a Score implementation (CLI) in a variety of ways.

Choose one of the following methods and a Score implementation tool to continue.

Install the Score CLI with brew

Using brew, you can install the Score implementation (CLI).

Prerequisites: You must have brew installed.

brew install score-spec/tap/score-humanitec

Install the Score CLI using Go

Using Go, you can fetch, compile, and install the Score implementation (CLI).

Prerequisites: You must have Go installed.

go install -v github.com/score-spec/score-humanitec/cmd/score-humanitec@latest

Install using Docker

This method will start and run a new Docker container based on the image provided.

Some Score Implementation CLI contain a Dockerfile for building a Docker container that runs the command line application.

To use this Dockerfile, first install Docker on your machine and run the application.

  1. Download the repository. The following example uses the GitHub CLI to download the project.
gh repo clone score-spec/score-humanitec
  1. Change directories into score-humanitec.
cd score-humanitec
  1. Build the Docker image by running the following command in the same directory as the Dockerfile.
docker build -t score-humanitec:latest .
  1. Run the Docker image by using the docker run command.
docker run -it score-humanitec:latest

If you want to run score-humanitec with the --help flag to view the available options, you would run the following command.

docker run -it score-humanitec:latest --help

This will start a new container based on the image you built, run score-humanitec with the --help flag, and then stop the container.

Install using a manual method

The following methods download a Score Implementation (CLI) from the project’s GitHub release page. See that page for available releases and platform builds.

Install the binary with curl on macOS

Step 1. Download the latest release 

curl -L0 "https://github.com/score-spec/score-humanitec/releases/download/0.10.2/score-humanitec_0.10.2_darwin_arm64.tar.gz" -o score-humanitec.tgz

Make sure you target the proper build for your platform.

Step 2. Unpack the latest release 

tar xvzf score-humanitec.tgz

The following is the output of the previous command.

x LICENSE
x README.md
x score-humanitec

Step 3. Clean up the tar file

Clean up any unwanted files.

rm score-humanitec.tgz README.md LICENSE

Step 4. Move the binary to PATH

Move the score-humanitec binary to a file location on your system PATH.

sudo mv ./score-humanitec /usr/local/bin/score-humanitec
sudo chown root: /usr/local/bin/score-humanitec

Results You’ve successfully installed the Score implementation (CLI).

Install the binary with wget on macOS and Linux

Step 1. Download the latest release

Download with the CLI wget command.

wget https://github.com/score-spec/score-humanitec/releases/download/0.10.2/score-humanitec_0.10.2_<os_system>.tar.gz
  • Replace score-humanitec with the name of the Score implementation tool.
  • Replace <os_system> with your operating system.

For example, the following wget command downloads score-humanitec version 0.10.2 for macOS.

wget https://github.com/score-spec/score-humanitec/releases/download/0.10.2/score-humanitec_0.10.2_darwin_arm64.tar.gz

Results You should see something similar to the following output.

Saving to: `score-humanitec_0.10.2_darwin_arm64.tar.gz`

score-humanitec_0.10.2 100%[===================>]   2.85M  5.28MB/s    in 0.5s

Step 2: Install into your local directory

In your terminal, enter the following to create the score-spec directory.

cd /usr/local/bin/
# create the directory if needed
mkdir -pv score-spec

Extract the compressed Tar file. Update the following example to include the path to your file.

tar -xvzf ~/<your-path>/score-humanitec_0.10.2_<os_system>.tar -C /usr/local/bin/

You may need to run the previous command with elevated permissions.

Results You should see the following output.

x LICENSE
x README.md
x score-humanitec

Step 3: Export PATH

To export PATH, run the following command.

export PATH=$PATH:/usr/local/bin/

Future terminal sessions may require you add this path to your ~/.zshrc or ~/.bashrc file, if it isn’t there already.

Step 4: Verify installation

To verify installation, run the following command.

score-humanitec --version

The command returns the following output.

score-humanitec 0.10.2

Results You’ve successfully installed the Score implementation tool.

Install the binary through the GitHub downloads page on macOS and Linux

Step 1. Download the latest release

Download with the CLI wget command.

wget https://github.com/score-spec/score-humanitec/releases/download/0.10.2/score-humanitec_0.10.2_<os_system>.tar.gz
  • Replace score-humanitec with the name of the Score implementation tool.
  • Replace <os_system> with your operating system.

For example, the following wget command downloads score-humanitec version 0.10.2 for macOS.

wget https://github.com/score-spec/score-humanitec/releases/download/0.10.2/score-humanitec_0.10.2_darwin_arm64.tar.gz

Results You should see something similar to the following output.

Saving to: `score-humanitec_0.10.2_darwin_arm64.tar.gz`

score-humanitec_0.10.2 100%[===================>]   2.85M  5.28MB/s    in 0.5s

Step 2: Install into your local directory

In your terminal, enter the following to create the score-spec directory.

cd /usr/local/bin/
# create the directory if needed
mkdir -pv score-spec

Extract the compressed Tar file. Update the following example to include the path to your file.

tar -xvzf ~/<your-path>/score-humanitec_0.10.2_<os_system>.tar -C /usr/local/bin/

You may need to run the previous command with elevated permissions.

Results You should see the following output.

x LICENSE
x README.md
x score-humanitec

Step 3: Export PATH

To export PATH, run the following command.

export PATH=$PATH:/usr/local/bin/

Future terminal sessions may require you add this path to your ~/.zshrc or ~/.bashrc file, if it isn’t there already.

Step 4: Verify installation

To verify installation, run the following command.

score-humanitec --version

The command returns the following output.

score-humanitec 0.10.2

Results You’ve successfully installed the Score implementation tool.

Install the binary on Windows

Download the latest score-humanitec version, decompress the zip file, and move the binary to your PATH.

Upgrade the Score implementation CLI

To upgrade the Score implementation (CLI), download the latest binary version and follow the installation instruction.

Command reference overview