Target Platform command reference overview

Overview and description for the Score implementation (CLI).

The Score implementation (CLI) is a command-line tool used to interact with a Score Specification. Use a Score implementation (CLI) to transform your score.yaml file into multiple configuration files for the platform of your choice.

The Score implementation (CLI)

Construct your Score implementation (CLI) commands such that the command options precede its path and arguments when provided.

score-[platform] [command] [flag]

Available reference implementations include:

Command reference

The Score implementation (CLI) has two distinct parts.

  • Commands: The commands are tasks you want Score to do. Supply Score with commands and subcommands to execute specific tasks.
  • Flags: Flags, also called parameters, are options that modify the result of the command by providing additional configurations. Flags are specific to the command, and each command can have independent flags.

Global modifiers

The following is a list of global modifiers.

--help

Provides additional information from the CLI.

Alias: -h

--version

Provides version information for the CLI.

Alias: -v


score-compose run

Translates the Score file into a Docker Compose file.

score-helm run

Translates the Score file into a Helm values file.

score-humanitec delta

Translates the Score file into a deployment delta for Humanitec.

score-humanitec run

Translates the Score file into a deployment delta for Humanitec.

CLI error reference

Overview and description of common errors in the Score reference implementation CLI’s (score-compose, score-helm)

Enable autocomplete for shell

Enables autocomplete for the Score implementation (CLI).