Configuration
Repeating the global options each time the scrt command is invoked can be verbose. Also, some options — like the store password — shouldn't be used on the command line on a shared computer, to avoid security issues.
To prevent this, scrt can be configured with a configuration file or using environment variables.
scrt configuration settings follow an order of precedence. Each item takes precedence over the item below it:
- command-line flags
- environment variables
- configuration file
TIP
Configuration options can be considered to be chosen from "most explicit" (flags) to "least explicit" (configuration file).
Configuration file
The scrt configuration file is a YAML file with the configuration options as keys.
Example:
storage: local
password: p4ssw0rd
local:
path: store.scrt
If the --config option is given to the command line, scrt will try to load the configuration from a file at the given path. Otherwise, it looks for any file named .scrt, .scrt.yml or .scrt.yaml in the current working directory, then recursively in the parent directory up to the root of the filesystem. If such a file is found, its values are loaded as configuration.
This can be useful in configuring the location of a store for a project. By adding a .scrt file at the root of the project repository. scrt can then be used in CI and other DevOps tools.
DANGER
Don't add the password to a configuration file in a shared git repository!
Storage type (storage) can be ignored in a configuration file. scrt will read the configuration under the key for the storage type (e.g. local:). Defining configurations for multiple storage types in a single file will result in undefined behavior.
Environment variables
Each global option has an environment variable counterpart. Environment variables use the same name as the configuration option, in uppercase letters, prefixed with SCRT_.
storage⇒SCRT_STORAGEpassword⇒SCRT_PASSWORDlocal-path⇒SCRT_LOCAL_PATH
To configure a default store on your system, add the following to your .bashrc file (if using bash):
export SCRT_STORAGE=local
export SCRT_PASSWORD=p4ssw0rd
export SCRT_LOCAL_PATH=~/.scrt/store.scrt
TIP
Refer to your shell interpreter's documentation to set environment variables if you don't use bash (zsh, dash, tcsh, etc.)