Skip to main content

Config

The config sub-command allows to get and set various configuration values, used by other Scala CLI sub-commands.

Examples of use:

scala-cli config user.name "Alex Me"
scala-cli config user.name
Alex Me

The --dump option allows to print all config entries in JSON format:

scala-cli config --dump | jq .
{
"github": {
"token": "value:qWeRtYuIoP"
},
"pgp": {
"public-key": "value:-----BEGIN PGP PUBLIC KEY BLOCK-----\nVersion: BCPG v1.68\n\n…\n-----END PGP PUBLIC KEY BLOCK-----\n",
"secret-key": "value:…",
"secret-key-password": "value:1234"
},
"user": {
"email": "[email protected]",
"name": "Alex Me",
"url": "https://alex.me"
}
}

Use --password to get the value of a password entry:

export MY_GITHUB_TOKEN=1234
scala-cli config github.token "env:MY_GITHUB_TOKEN"
scala-cli config github.token
env:MY_GITHUB_TOKEN
export MY_GITHUB_TOKEN=1234
scala-cli config --password github.token
1234

Use --create-key to create a PGP key pair, protected by a randomly-generated password, to be used by the publish setup sub-command:

scala-cli config --create-key

Configuration values are stored in a directory under your home directory, with restricted permissions:

  • on macOS: ~/Library/Application Support/ScalaCli/secrets/config.json
  • on Linux: ~/.config/scala-cli/secrets/config.json
  • on Windows: %LOCALAPPDATA%\ScalaCli\secrets\config.json (typically C:\Users\username\AppData\Local\ScalaCli\secrets\config.json)