Note: This is a Liquibase Pro command, so you need a Liquibase Pro License Key to use it.

The customize subcommand allows you to customize dynamic checks specified in your check configurations: --checks-settings-file.


Using the customize subcommand, you can provide your values or change the default values of checks that have customization options.

Examples include lists of data types, Change Types, strings, or regular expressions that should be reported, and others.

Liquibase does not allow you to customize static checks.

Note: To view a list of available checks, run liquibase checks show.


The command is interactive, and you need to follow the CLI output messages to run it:

  1. Run the command specifying your values:
  2. liquibase checks customize --check-name=TableColumnLimit

    Note: If you have a checks settings file customized for a specific environment or project, you need to pass that using the --checks-settings-file parameter. If you do not include this parameter, Liquibase uses the default settings file: liquibase.checks-settings.conf. See Use the Checks Settings Configuration File.

  3. Enter the value you want to change.

The command updates the value of a check in the checks settings file. To run the check, use the run command.

Command arguments

The following table identifies parameters that are accepted or required by the customize subcommand. If the Default column states "Required," it is required to run the command successfully. If it states "Null," it is an optional command argument. Each command argument helps you narrow down the liquibase checks customize command to ensure that only very specific content is affected by the command.

Tip: For best results, specify all commands and parameters in the --kebab-case format in the CLI. If your preference is camelCase, it also works in the CLI.

Name Default Syntax Description
check-name Required

CLI: --check-name

Property: liquibase.command.checks.customize.checkName


Use this to specify the short name of the check you want to target with one of the following subcommands:

  • bulk-set
  • copy
  • customize
  • delete
  • disable
  • enable
  • reset
  • run
  • show
checks-settings-file Null

CLI: --checks-settings-file

Property: liquibase.command.checks.customize.checksSettingsFile


Specifies the checks settings file to use with subcommands. Write the relative path of the settings file that you want to read from or modify. For more information, see Use the Checks Settings Configuration File.

auto-update Null

CLI: --auto-update=[on|off]

Property: liquibase.command.checks.customize.autoUpdate: [on|off]


Allows automatic backup and updating of the liquibase.checks-settings.conf file when new quality checks are available.

Default: off

Related links