--format

Last updated: April 30, 2026

Sets the format of the check output. Valid values: TXT, JSON. Default: TXT.

Syntax

You can set this parameter in the following ways:

Option

Syntax

Command CLI parameter

--format=<TXT|JSON>

Liquibase properties file (defaults file)

liquibase.command.checks.<subcommand>.format: <string>

Command flow file argument (example)

cmdArgs: { format: "<TXT|JSON>" }

JVM system property (JAVA_OPTS environment variable)

JAVA_OPTS=-Dliquibase.command.checks.<subcommand>.format=<string>

Liquibase environment variable

LIQUIBASE_COMMAND_CHECKS_<SUBCOMMAND>_FORMAT=<string>

checks-format - Liquibase