score-compose

Get started with the score-compose reference implementation

Overview

The score-compose CLI serves as a reference implementation for the Score specification, providing a standard for the creation of custom Score CLIs. Score-compose can be utilized both as a reference point for implementation and for practical use in local development with Docker Compose. Below you’ll find an overview of:

For additional details and opportunities to contribute to the project, visit the score-compose GitHub repository.

Installation

You can install the score-compose CLI in a variety of ways:

Homebrew

Prerequisites: You must have brew installed.

brew install score-spec/tap/score-compose

Go

Prerequisites: You must have Go installed.

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

Docker

Prerequisites: You must have Docker installed.

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

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

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

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

Manual download

The following methods download the score-compose CLI from its GitHub release page:

1. Download the latest release from the GitHub release page:

curl -L -o score-compose.tgz https://github.com/score-spec/score-compose/releases/download/<x.y.z>/score-compose_<x.y.z>_<os_system>.tar.gz

2. Unpack the latest release

tar xvzf score-compose.tgz

The following is the output of the previous command:

x LICENSE
x README.md
x score-compose

3. Clean up the tar file

rm score-compose.tgz README.md LICENSE

4. Move the binary to PATH

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

You’ve successfully installed the score-compose CLI!

1. Download the latest release from the GitHub release page:

wget https://github.com/score-spec/score-compose/releases/download/<x.y.z>/score-compose_<x.y.z>_<os_system>.tar.gz

You should see something similar to the following output:

Saving to: score-compose_<x.y.z>_<os_system>.tar.gz

score-compose_<x.y.z> 100%[===================>]   2.85M  5.28MB/s    in 0.5s

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 (You may need to run this command with elevated permissions):

tar -xvzf ~/<your-path>/score-compose_<x.y.z>_<os_system>.tar.gz

You should see the following output:

x LICENSE
x README.md
x score-compose

3: Export PATH

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

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

4: Verify installation

score-compose --version

The command returns the following output:

score-compose <x.y.z>

You’ve successfully installed the score-compose CLI!

1. Download the latest compressed Tar file for your operating system from the GitHub release page. By default, the tarball will be saved to your ~/Downloads directory. If you choose to use a different location, you’ll need to change that in the following steps.

score-compose_x.y.z_osx-amd64.tar.gz

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 (You may need to run the previous command with elevated permissions).

tar -xvzf ~/Downloads/score-compose_<x.y.z>_darwin_arm64.tar.gz -C /usr/local/bin/

You should see the following output:

x LICENSE
x README.md
x score-compose

3. Export PATH

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

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

4. Verify installation

score-compose --version

The command returns the following output:

score-compose x.y.z

You’ve successfully installed the score-compose CLI!

1. Download the latest release from the GitHub release page.

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

You’ve successfully installed the score-compose CLI!

CLI Reference

The score-compose CLI provides a set of commands and flags to enable the generation of Docker Compose files from Score specifications.

Commands

init

The init command creates a basic score.yaml file in the current directory and initializes a .score-compose/ working directory if it doesn’t already exist. The .score-compose/ directory is used to store local state and should be excluded from version control systems such as Git by adding it to your .gitignore file.

score-compose init [flags]

Flags

The init command can be combined with the following flags:

--file | -f

Specifies a Score file to initialize. By default this is ./score.yaml.

score-compose init --file custom_file_name.yaml

--no-sample

Disables the generation of the sample Score file if you already have a Score file in place.

score-compose init --no-sample

--project | -p

Sets the name of the Docker Compose project. By default, the project name is the same as the current directory name.

score-compose init --project custom_project_name.yaml

--help | -h

Displays help information for init, providing a short description of the command along with examples and compatible flags.

score-compose init --help

generate

The generate command converts the Score file(s) in the current Score Compose project into a combined Docker Compose manifest. All resources and links between Workloads will be resolved and provisioned as required. Please be aware that score-compose init must be run first. An error will be thrown if the project directory is not present.

score-compose generate [flags]

Flags

The generate command can be combined with the following flags:

--build

Specifies an optional build context to use for the given container. The format is either --build=container=./dir or --build=container={'"context":"./dir"}.

score-compose generate --build container=./dir

--env-file

Specifies the location to store a skeleton .env file for Docker Compose. This will override existing content if present.

score-compose generate --env-file /path/to/env-file

--image

Specifies an optional container image to use for any container with image == '.'.

score-compose generate --image your_container_image

--output | -o

Specifies the output file to write the composed Docker Compose file to. By default, the output file is named compose.yaml.

score-compose generate --output your_output_file.yaml

--override-property

Specifies an optional set of path=key overrides to set or remove.

score-compose generate --override-property path1=value1

--overrides-file

Specifies an optional file of Score overrides to merge in.

score-compose generate score.yaml --overrides-file=./overrides.score.yaml

--help | -h

Displays help information for generate, providing a short description of the command along with examples and compatible flags.

score-compose generate --help

completion

The completion command generates an autocompletion script for score-compose in the specified shell.

score-compose completion [command]

The completion command can be combined with the following subcommands:

  • bash: Generate the autocompletion script for bash
  • fish: Generate the autocompletion script for fish
  • powershell: Generate the autocompletion script for powershell
  • zsh: Generate the autocompletion script for zsh

Flags

The completion command can be combined with the following flags:

--help | -h

Displays details on how to use the generated script.

score-compose completion [command] --help

run (deprecated)

The run command translates the Score file into a Docker Compose file. Please note that this command is deprecated as it does not support resource provisioning out of the box. Please use the generate command instead.

score-compose run --file ./score.yaml \
  --output ./compose.yaml \
  --env-file ./backend.env

Flags

The run command can be combined with the following flags:

--build

Replaces the image name with the specified string.

score-compose run -f ./score.yaml -o ./compose.yaml --build web

--env-file

Specifies the location to store sample .env file.

score-compose run -f ./score.yaml -o ./compose.yaml --env-file ./backend.env

--file | f

Specifies the path to the Score file. Uses ./score.yaml as a default value if the flag isn’t specified.

score-compose run -f ./another-score.yaml

--output | -o

The output location of the Compose file. Uses ./compose.yaml as a default value if the flag isn’t specified.

score-compose run -f ./score.yaml -o ./another-compose.yaml

--property | -p

Overrides selected property value.

--help | -h

Displays help output for the run command.

score-compose run -h

help

The help command provides information on all commands.

score-compose help [command] [flags]

Global flags

--help | -h

Displays help information for score-compose, includig available commands and flags.

score-compose --help

--quiet

Mutes any logging output.

score-compose --quiet

--verbose count | -v

Increases log verbosity and detail by specifying this flag one or more times.

score-compose --verbose count

--version

Displays the version of score-compose.

score-compose --version

Examples

Explore a variety of examples for score-compose, ranging from simple “hello world” setups to more complex configurations, including resource provisioning and multiple workloads. You can find these examples in our examples library.

If you encounter any issues or have questions, feel free to reach out to us in the Score community Slack.