Theme Kit configuration reference

This reference lists the configuration variables available for Theme Kit and their accepted values.

Anchor to How it worksHow it works

You can configure Theme Kit using a config file, environment variables, and command line flags. Each configuration method has an order of precedence:

• Environment variables can override config file values.
• Command line flags can override config file and environment values.

Anchor to Global parametersGlobal parameters

The following table lists the parameters that you can configure for all Theme Kit actions:

Anchor to Config fileConfig file

The configuration file can be set up per environment.

In the following example, the config.yml file specifies configurations for three different environments: development, production, and test.

Anchor to Environment variablesEnvironment variables

To avoid storing your private secrets in your repository, you can use environment variables. You can interpolate variables in your config.yml file or use environment variables for global parameters.

Anchor to Interpolate variablesInterpolate variables

You can interpolate variables into your config.yml file using the ${} notation:

To help you interpolate variables, there are special files that can be used to automatically load environment variables for Theme Kit. The following table lists the file paths for each operating system:

Anchor to Variables fileVariables file

The variables file has the same format as most .env type files. The following example shows what the variables file looks like for the previous config file example.

Setting up a variables file allows you to commit your config.yml to your repository, but keeps your private secrets out of the repository.

Anchor to Environment variables for global parametersEnvironment variables for global parameters

Most of the global parameters have a corresponding environment variable. All of the environment variables are prefixed with THEMEKIT_.

The following table shows the environment variables associated with each parameter. THEMEKIT_IGNORE_FILES must use : as a pattern separator and THEMEKIT_IGNORES must use : as a file path separator.

Anchor to Command line flagsCommand line flags

You can enforce any setting manually using a command line flag. This is useful for debugging settings or scripting calls to Theme Kit from job schedulers, like cron.

The following table lists the global parameters and their associated command line flags:

Anchor to Ignore patternsIgnore patterns

Theme Kit has a couple of ways to ignore files from your commands. You can provide a list of ignore patterns to your ignore_files value. You can also provide a list of file paths to your ignores value.

Anchor to Ignore pattern rulesIgnore pattern rules

The following tables shows the rules associated with specifying ignore patterns and some examples:

Anchor to Example ignore values in ,[object Object]Example ignore values in config.yml

The following example shows a config.yml file that specifies a list of ignore patterns in the ignore_files value, and a single themekit_ignores file in the ignores value:

Anchor to Example ignore fileExample ignore file

Ignore files must adhere to specific formatting rules to be valid.

The following example shows a valid ignore file. One pattern is specified per line, and lines for comments are prefixed with a # value:

Anchor to Next stepsNext steps

• Learn about the different commands that you can use in Theme Kit to execute key operations.
• Learn how to identify and resolve common issues in Theme Kit.